com.spire.doc.fields
Class DocPicture

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.fields.ParagraphBase
                      com.spire.doc.fields.shape.ShapeBase
                          com.spire.doc.fields.ShapeObject
                              com.spire.doc.fields.DocPicture

All Implemented Interfaces:

IRunAttrSource, ICompositeObject, IDocumentObject, IParagraphBase, IPicture

public class DocPicture
extends ShapeObject
implements IPicture

Constructor Summary

DocPicture(IDocument doc)
Initializes a new instance of the DocPicture class.

Method Summary

IParagraph	addCaption(java.lang.String name, CaptionNumberingFormat format, CaptionPosition captionPosition) Add Caption for current Picture.
java.lang.String	getAlternativeText() Gets the alternative text.
boolean	getBiLevel() Gets whether an image will be displayed in black and white.
float	getBrightness() Gets picture brightness.
CharacterFormat	getCharacterFormat() Gets shape object's character format.
PictureColor	getColor() Get picture color.
float	getContrast() Get picture contrast.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
boolean	getGrayScale() Gets whether a picture will display in grayscale mode.
float	getHeight() Returns picture height.
float	getHeightScale() Returns picture height scale factor in percent.
ShapeHorizontalAlignment	getHorizontalAlignment() Returns picture horizontal alignment.
HorizontalOrigin	getHorizontalOrigin() Gets horizontal origin of the picture.
float	getHorizontalPosition() Gets absolute horizontal position of the picture.
java.awt.image.BufferedImage	getImage() Gets internal Image object.
byte[]	getImageBytes() Gets image byte array.
boolean	getLayoutInCell() Gets the boolean value that represents whether a picture in a table is displayed inside or outside the table.
float	getRotationEx() Gets the rotation of DocPicture.Specifies the rotation of the graphic frame.
TextWrappingStyle	getTextWrappingStyle() Gets text wrapping style of the picture.
TextWrappingType	getTextWrappingType() Gets text wrapping type of the picture.
java.lang.String	getTitle() Gets the picture title.
java.awt.Color	getTransparentColor() Gets transparent color
ShapeVerticalAlignment	getVerticalAlignment() Returns picture vertical alignment.
VerticalOrigin	getVerticalOrigin() Gets absolute horizontal position of the picture.
float	getVerticalPosition() Gets absolute vertical position of the picture.
float	getWidth() Returns picture width.
float	getWidthScale() Returns picture width scale factor in percent.
boolean	isCrop() Gets whether the picture object is cropped.
boolean	isUnderText() Gets whether picture is below image.
void	isUnderText(boolean value) Sets whether picture is below image.
void	loadImage(byte[] imageBytes) Loads image as bytes array.
void	loadImage(java.io.InputStream inputStream) Loads image.
void	loadImage(java.lang.String filePath) Loads image.
void	replaceImage(byte[] imageBytes, boolean bIsKeepRation) Replaces the image.
void	setAlternativeText(java.lang.String value) Sets the alternative text.
void	setBiLevel(boolean value) Sets whether an image will be displayed in black and white.
void	setBrightness(float value) Sets picture brightness.
void	setColor(PictureColor value) set picture color.
void	setContrast(float value) Set picture contrast.
void	setGrayScale(boolean value) Sets whether a picture will display in grayscale mode.
void	setHeight(float value) Sets picture height.
void	setHeightScale(float value) Sets picture height scale factor in percent.
void	setHorizontalAlignment(ShapeHorizontalAlignment value) Sets picture horizontal alignment.
void	setHorizontalOrigin(HorizontalOrigin value) Sets horizontal origin of the picture.
void	setHorizontalPosition(float value) Sets absolute horizontal position of the picture.
void	setLayoutInCell(boolean value) Sets the boolean value that represents whether a picture in a table is displayed inside or outside the table.
void	setRotationEx(float value) Sets the rotation of DocPicture.Specifies the rotation of the graphic frame.
void	setTextWrappingStyle(TextWrappingStyle value) Sets text wrapping style of the picture.
void	setTextWrappingType(TextWrappingType value) Sets text wrapping type of the picture.
void	setTitle(java.lang.String value) Sets the picture title.
void	setTransparentColor(java.awt.Color value) Sets transparent color
void	setVerticalAlignment(ShapeVerticalAlignment value) Sets picture vertical alignment.
void	setVerticalOrigin(VerticalOrigin value) Sets absolute horizontal position of the picture.
void	setVerticalPosition(float value) Sets absolute vertical position of the picture.
void	setWidth(float value) Sets picture width.
void	setWidthScale(float value) Sets picture width scale factor in percent.

Methods inherited from class com.spire.doc.fields.ShapeObject

getChildObjects, getFillColor, getLineStyle, getStrokeColor, getStrokeWeight, getWordArt, hasImage, setFillColor, setLineStyle, setStrokeColor, setStrokeWeight

Methods inherited from class com.spire.doc.fields.shape.ShapeBase

getAllowOverlap, getBehindText, getBottom, getDistanceBottom, getDistanceLeft, getDistanceRight, getDistanceTop, getParentParagraph, getRight, getRotation, getShapeType, getZOrder, hasKey, isImage, localToParent, removeShapeAttribute, setAllowOverlap, setBehindText, setDistanceBottom, setDistanceLeft, setDistanceRight, setDistanceTop, setRotation, setShapeAttr, setShapeAttribute, setShapeType, setZOrder

Methods inherited from class com.spire.doc.fields.ParagraphBase

applyCharacterFormat, applyStyle, getAncestor, getOwnerParagraph, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.IParagraphBase

applyStyle, getOwnerParagraph, getStyleName

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Methods inherited from interface com.spire.doc.documents.IRunAttrSource

clearRunAttrs, fetchInheritedRunAttr, getDirectRunAttr, getDirectRunAttrByIndex, getDirectRunAttrsCount, setRunAttr

Constructor Detail

DocPicture

public DocPicture(IDocument doc)

Initializes a new instance of the DocPicture class.

Parameters:

doc - the doc.

Method Detail

getRotationEx

public float getRotationEx()

Gets the rotation of DocPicture.Specifies the rotation of the graphic frame.

Returns:

float

setRotationEx

public void setRotationEx(float value)

Sets the rotation of DocPicture.Specifies the rotation of the graphic frame.

Parameters:

value - float

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class ShapeObject

Returns:

the type of the document object.

getHeight

public float getHeight()

Returns picture height.

Specified by:

getHeight in interface IPicture

Overrides:

getHeight in class ShapeBase

Returns:

float

setHeight

public void setHeight(float value)

Sets picture height.

Specified by:

setHeight in interface IPicture

Overrides:

setHeight in class ShapeBase

Parameters:

value - the value is measured in points.

getWidth

public float getWidth()

Returns picture width.

Specified by:

getWidth in interface IPicture

Overrides:

getWidth in class ShapeBase

Returns:

float

setWidth

public void setWidth(float value)

Sets picture width.

Specified by:

setWidth in interface IPicture

Overrides:

setWidth in class ShapeBase

Parameters:

value - the value is measured in points.

getHeightScale

public float getHeightScale()

Returns picture height scale factor in percent.

Specified by:

getHeightScale in interface IPicture

Returns:

float

setHeightScale

public void setHeightScale(float value)

Sets picture height scale factor in percent.

Specified by:

setHeightScale in interface IPicture

Parameters:

value - float

getWidthScale

public float getWidthScale()

Returns picture width scale factor in percent.

Specified by:

getWidthScale in interface IPicture

Returns:

float

setWidthScale

public void setWidthScale(float value)

Sets picture width scale factor in percent.

Specified by:

setWidthScale in interface IPicture

Parameters:

value - float

getImage

public java.awt.image.BufferedImage getImage()

Gets internal Image object.

Specified by:

getImage in interface IPicture

Returns:

BufferedImage

getImageBytes

public byte[] getImageBytes()

Gets image byte array.

Specified by:

getImageBytes in interface IPicture

Returns:

byte[]

getGrayScale

public boolean getGrayScale()

Gets whether a picture will display in grayscale mode.

Returns:

the default value is false.

setGrayScale

public void setGrayScale(boolean value)

Sets whether a picture will display in grayscale mode.

Parameters:

value - boolean

getBiLevel

public boolean getBiLevel()

Gets whether an image will be displayed in black and white.

Returns:

the default value is false.

setBiLevel

public void setBiLevel(boolean value)

Sets whether an image will be displayed in black and white.

Parameters:

value - boolean

getBrightness

public float getBrightness()

Gets picture brightness.

Returns:

float

setBrightness

public void setBrightness(float value)

Sets picture brightness.

Parameters:

value - float

getContrast

public float getContrast()

Get picture contrast.

Returns:

float

setContrast

public void setContrast(float value)

Set picture contrast.

Parameters:

value - float

getColor

public PictureColor getColor()

Get picture color.

Returns:

PictureColor

setColor

public void setColor(PictureColor value)

set picture color.

Parameters:

value - PictureColor

getTransparentColor

public java.awt.Color getTransparentColor()

Gets transparent color

Returns:

Color

setTransparentColor

public void setTransparentColor(java.awt.Color value)

Sets transparent color

Parameters:

value - Color

isCrop

public boolean isCrop()

Gets whether the picture object is cropped.

Returns:

boolean

getHorizontalOrigin

public HorizontalOrigin getHorizontalOrigin()

Gets horizontal origin of the picture.

Specified by:

getHorizontalOrigin in interface IPicture

Overrides:

getHorizontalOrigin in class ShapeBase

Returns:

HorizontalOrigin

setHorizontalOrigin

public void setHorizontalOrigin(HorizontalOrigin value)

Sets horizontal origin of the picture.

Specified by:

setHorizontalOrigin in interface IPicture

Overrides:

setHorizontalOrigin in class ShapeBase

Parameters:

value - HorizontalOrigin

getVerticalOrigin

public VerticalOrigin getVerticalOrigin()

Gets absolute horizontal position of the picture.

Specified by:

getVerticalOrigin in interface IPicture

Overrides:

getVerticalOrigin in class ShapeBase

Returns:

VerticalOrigin

setVerticalOrigin

public void setVerticalOrigin(VerticalOrigin value)

Sets absolute horizontal position of the picture.

Specified by:

setVerticalOrigin in interface IPicture

Overrides:

setVerticalOrigin in class ShapeBase

Parameters:

value - VerticalOrigin

getHorizontalPosition

public float getHorizontalPosition()

Gets absolute horizontal position of the picture.

Specified by:

getHorizontalPosition in interface IPicture

Overrides:

getHorizontalPosition in class ShapeBase

Returns:

float

setHorizontalPosition

public void setHorizontalPosition(float value)

Sets absolute horizontal position of the picture.

Specified by:

setHorizontalPosition in interface IPicture

Overrides:

setHorizontalPosition in class ShapeBase

Parameters:

value - the value is measured in points and the position is relative to HorizontalOrigin.

getVerticalPosition

public float getVerticalPosition()

Gets absolute vertical position of the picture.

Specified by:

getVerticalPosition in interface IPicture

Overrides:

getVerticalPosition in class ShapeBase

Returns:

float

setVerticalPosition

public void setVerticalPosition(float value)

Sets absolute vertical position of the picture.

Specified by:

setVerticalPosition in interface IPicture

Overrides:

setVerticalPosition in class ShapeBase

Parameters:

value - the value is measured in points and the position is relative to VerticalOrigin.

getTextWrappingStyle

public TextWrappingStyle getTextWrappingStyle()

Gets text wrapping style of the picture.

Specified by:

getTextWrappingStyle in interface IPicture

Overrides:

getTextWrappingStyle in class ShapeBase

Returns:

TextWrappingStyle

setTextWrappingStyle

public void setTextWrappingStyle(TextWrappingStyle value)

Sets text wrapping style of the picture.

Specified by:

setTextWrappingStyle in interface IPicture

Overrides:

setTextWrappingStyle in class ShapeBase

Parameters:

value - TextWrappingStyle

getTextWrappingType

public TextWrappingType getTextWrappingType()

Gets text wrapping type of the picture.

Specified by:

getTextWrappingType in interface IPicture

Overrides:

getTextWrappingType in class ShapeBase

Returns:

TextWrappingType

setTextWrappingType

public void setTextWrappingType(TextWrappingType value)

Sets text wrapping type of the picture.

Specified by:

setTextWrappingType in interface IPicture

Overrides:

setTextWrappingType in class ShapeBase

Parameters:

value - TextWrappingType

getHorizontalAlignment

public ShapeHorizontalAlignment getHorizontalAlignment()

Returns picture horizontal alignment.

If it is set as None, then the picture is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to HorizontalOrigin.

Specified by:

getHorizontalAlignment in interface IPicture

Overrides:

getHorizontalAlignment in class ShapeBase

Returns:

ShapeHorizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(ShapeHorizontalAlignment value)

Sets picture horizontal alignment.

Specified by:

setHorizontalAlignment in interface IPicture

Overrides:

setHorizontalAlignment in class ShapeBase

Parameters:

value - if it is set as None, then the picture is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to HorizontalOrigin.

getVerticalAlignment

public ShapeVerticalAlignment getVerticalAlignment()

Returns picture vertical alignment.

Specified by:

getVerticalAlignment in interface IPicture

Overrides:

getVerticalAlignment in class ShapeBase

Returns:

ShapeVerticalAlignment

setVerticalAlignment

public void setVerticalAlignment(ShapeVerticalAlignment value)

Sets picture vertical alignment.

Specified by:

setVerticalAlignment in interface IPicture

Overrides:

setVerticalAlignment in class ShapeBase

Parameters:

value - If it is set as None, then the picture is explicitly positioned using position properties. Otherwise it is positioned according to the alignment specified. The position of the object is relative to VerticalOrigin.

isUnderText

public boolean isUnderText()

Gets whether picture is below image.

Specified by:

isUnderText in interface IPicture

Returns:

boolean

isUnderText

public void isUnderText(boolean value)

Sets whether picture is below image.

Specified by:

isUnderText in interface IPicture

Parameters:

value - boolean

getCharacterFormat

public CharacterFormat getCharacterFormat()

Gets shape object's character format.

Overrides:

getCharacterFormat in class ShapeObject

Returns:

CharacterFormat

getAlternativeText

public java.lang.String getAlternativeText()

Gets the alternative text.

Specified by:

getAlternativeText in interface IPicture

Overrides:

getAlternativeText in class ShapeBase

Returns:

the alternative text.

setAlternativeText

public void setAlternativeText(java.lang.String value)

Sets the alternative text.

Specified by:

setAlternativeText in interface IPicture

Overrides:

setAlternativeText in class ShapeBase

Parameters:

value - the alternative text.

getTitle

public java.lang.String getTitle()

Gets the picture title.

Specified by:

getTitle in interface IPicture

Returns:

the title.

setTitle

public void setTitle(java.lang.String value)

Sets the picture title.

Specified by:

setTitle in interface IPicture

Parameters:

value - the title text

getLayoutInCell

public boolean getLayoutInCell()

Gets the boolean value that represents whether a picture in a table is displayed inside or outside the table.

Returns:

boolean

setLayoutInCell

public void setLayoutInCell(boolean value)

Sets the boolean value that represents whether a picture in a table is displayed inside or outside the table.

Parameters:

value - boolean

loadImage

public void loadImage(java.io.InputStream inputStream)

Loads image.

Specified by:

loadImage in interface IPicture

Parameters:

inputStream - the image input stream

loadImage

public void loadImage(java.lang.String filePath)

Loads image.

Specified by:

loadImage in interface IPicture

Parameters:

filePath - the image file path

loadImage

public void loadImage(byte[] imageBytes)

Loads image as bytes array.

Specified by:

loadImage in interface IPicture

Parameters:

imageBytes - byte[]

replaceImage

public void replaceImage(byte[] imageBytes,
                         boolean bIsKeepRation)

Replaces the image.

Parameters:

imageBytes - the image bytes.

bIsKeepRation - boolean

addCaption

public IParagraph addCaption(java.lang.String name,
                             CaptionNumberingFormat format,
                             CaptionPosition captionPosition)

Add Caption for current Picture.

Specified by:

addCaption in interface IPicture

Parameters:

name - name

format - format

captionPosition - captionPosition

Returns:

IParagraph