|
com.aspose.pdf.elements
Class ImageInfo
java.lang.Object
com.aspose.pdf.elements.PdfElementBase
com.aspose.pdf.elements.ImageInfo
- All Implemented Interfaces:
- java.lang.Cloneable
public class ImageInfo - extends PdfElementBase
Encapsulates info for an Image paragraph.
- See Also:
Image
|
Method Summary |
AlignmentType |
getAlignment()
Gets an AlignmentType object that indicates the image alignment type. |
boolean |
getBlackWhite()
Gets a bool value that indicates whether the image is forced to be black-and-white. |
float |
getCcittImageHeight()
Gets a float value that indicates the CCITT image height. |
float |
getCcittImageWidth()
Gets a float value that indicates the CCITT image width. |
java.lang.String |
getFile()
Gets a string that indicates the image file name and its path. |
float |
getFixHeight()
Gets a float value that indicates the fixed height of the image.
If this property is set, the image will be scaled to the fixed height. |
float |
getFixWidth()
Gets a float value that indicates the fixed width of the image.
If this property is set, the image will be scaled to the fixed width. |
BorderInfo |
getImageBorder()
Gets a BorderInfo object that indicates the border information of the image. |
ImageFileType |
getImageFileType()
Gets a ImageFileType object that indicates the image type. |
byte[] |
getMemoryData()
Gets a byte array that indicates the image data in memory. |
java.lang.String |
getOpenType()
Gets a ImageOpenType that indicates the image open type. |
float |
getRotationAngle()
Gets a float value that indicates the rotation angle of the coordinate system
when transforming a coordinate system. |
boolean |
getTextWrap()
Gets a float value that indicates the image would be wrapped by text. |
java.lang.String |
getTitle()
Gets a string value that indicates the title of the image. |
TextInfo |
getTitleTextInfo()
Gets a TextInfo object that indicates the text info of the image Title. |
boolean |
getUnderlying()
Gets a boolean value that indicates the image would be underlying the text. |
ImageInfo |
setAlignment(AlignmentType alignment)
Sets a AlignmentType object that indicates the image alignment type. |
ImageInfo |
setBlackWhite(boolean blackWhite)
Sets a bool value that indicates whether the image is forced to be black-and-white. |
void |
setCcittImageHeight(float imageHeight)
Sets a float value that indicates the CCITT image height. |
void |
setCcittImageWidth(float imageWidth)
Sets a float value that indicates the CCITT image width. |
ImageInfo |
setFile(java.lang.String file)
Sets a string that indicates the image file name and its path. |
void |
setFixHeight(float height)
Gets a float value that indicates the fixed height of the image.
If this property is set, the image will be scaled to the fixed height. |
ImageInfo |
setFixWidth(float width)
Sets a float value that indicates the fixed width of the image.
If this property is set, the image will be scaled to the fixed width. |
ImageInfo |
setImageBorder(BorderInfo borderInfo)
Sets a BorderInfo object that indicates the border information of the image. |
ImageInfo |
setImageFileType(ImageFileType fileType)
Sets a ImageFileType object that indicates the image type. |
ImageInfo |
setMemoryData(byte[] data)
Sets a byte array that indicates the image data in memory. |
ImageInfo |
setOpenType(java.lang.String type)
Sets a ImageOpenType that indicates the image open type. |
ImageInfo |
setRotationAngle(float rotationAngle)
Sets a float value that indicates the rotation angle of the coordinate system
when transforming a coordinate system. |
ImageInfo |
setTextWrap(boolean textWrap)
Sets a boolean value that indicates the image would be wrapped by text. |
ImageInfo |
setTitle(java.lang.String title)
Sets a string value that indicates the title of the image. |
ImageInfo |
setTitleTextInfo(TextInfo textInfo)
Sets a TextInfo object that indicates the text info of the image Title. |
ImageInfo |
setUnderlying(boolean underlying)
Sets a boolean value that indicates the image would be underlying the text. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ImageInfo
public ImageInfo(ElementFactory elementFactory)
- Initializes a new instance of the ImageInfo class.
getAlignment
public AlignmentType getAlignment()
- Gets an AlignmentType object that indicates the image alignment type.
- Returns:
- Returns the alignment.
- See Also:
AlignmentType
setAlignment
public ImageInfo setAlignment(AlignmentType alignment)
- Sets a AlignmentType object that indicates the image alignment type.
- Parameters:
alignment - The alignment to set.- See Also:
AlignmentType
getFile
public java.lang.String getFile()
- Gets a string that indicates the image file name and its path.
- Returns:
- Returns the file.
setFile
public ImageInfo setFile(java.lang.String file)
- Sets a string that indicates the image file name and its path.
- Parameters:
file - The file to set.
getFixWidth
public float getFixWidth()
- Gets a float value that indicates the fixed width of the image.
If this property is set, the image will be scaled to the fixed width.
- Returns:
- Returns the FixWidth.
setFixWidth
public ImageInfo setFixWidth(float width)
- Sets a float value that indicates the fixed width of the image.
If this property is set, the image will be scaled to the fixed width.
- Parameters:
width - The FixWidth to set.
getFixHeight
public float getFixHeight()
- Gets a float value that indicates the fixed height of the image.
If this property is set, the image will be scaled to the fixed height.
setFixHeight
public void setFixHeight(float height)
- Gets a float value that indicates the fixed height of the image.
If this property is set, the image will be scaled to the fixed height.
getImageFileType
public ImageFileType getImageFileType()
- Gets a ImageFileType object that indicates the image type.
- Returns:
- Returns the ImageFileType.
setImageFileType
public ImageInfo setImageFileType(ImageFileType fileType)
- Sets a ImageFileType object that indicates the image type.
- Parameters:
fileType - The ImageFileType to set.
getMemoryData
public byte[] getMemoryData()
- Gets a byte array that indicates the image data in memory.
- Returns:
- Returns the MemoryData.
setMemoryData
public ImageInfo setMemoryData(byte[] data)
- Sets a byte array that indicates the image data in memory.
- Parameters:
data - The MemoryData to set.
getOpenType
public java.lang.String getOpenType()
- Gets a ImageOpenType that indicates the image open type.
NOTE: This property is now obsolete.
URL is supported in Image.getImageInfo().setFile(). Memory image can is supported by getImageInfo().setMemoryData().
You need not set OpenType any more. It will be removed 12 months later since release 2.4.0.0 in October 2008.
Aspose apologizes for any inconvenience you may have experienced.
- Returns:
- Returns the ImageOpenType.
- See Also:
ImageOpenType
setOpenType
public ImageInfo setOpenType(java.lang.String type)
- Sets a ImageOpenType that indicates the image open type.
NOTE: This property is now obsolete.
URL is supported in Image.getImageInfo().setFile(). Memory image can is supported by getImageInfo().setMemoryData().
You need not set OpenType any more. It will be removed 12 months later since release 2.4.0.0 in October 2008.
Aspose apologizes for any inconvenience you may have experienced.
- Parameters:
type - The ImageOpenType to set.- See Also:
ImageOpenType
getTitle
public java.lang.String getTitle()
- Gets a string value that indicates the title of the image.
- Returns:
- Returns the Title.
setTitle
public ImageInfo setTitle(java.lang.String title)
- Sets a string value that indicates the title of the image.
- Parameters:
title - The Title to set.
getTitleTextInfo
public TextInfo getTitleTextInfo()
- Gets a TextInfo object that indicates the text info of the image Title.
- Returns:
- Returns the TitleTextInfo.
- See Also:
TextInfo
setTitleTextInfo
public ImageInfo setTitleTextInfo(TextInfo textInfo)
- Sets a TextInfo object that indicates the text info of the image Title.
- Parameters:
textInfo - The TitleTextInfo to set.- See Also:
TextInfo
getImageBorder
public BorderInfo getImageBorder()
- Gets a BorderInfo object that indicates the border information of the image.
- Returns:
- Returns the BorderInfo.
- See Also:
BorderInfo
setImageBorder
public ImageInfo setImageBorder(BorderInfo borderInfo)
- Sets a BorderInfo object that indicates the border information of the image.
- Parameters:
borderInfo - The image BorderInfo to set.- See Also:
BorderInfo
setRotationAngle
public ImageInfo setRotationAngle(float rotationAngle)
- Sets a float value that indicates the rotation angle of the coordinate system
when transforming a coordinate system.
getRotationAngle
public float getRotationAngle()
- Gets a float value that indicates the rotation angle of the coordinate system
when transforming a coordinate system.
setTextWrap
public ImageInfo setTextWrap(boolean textWrap)
- Sets a boolean value that indicates the image would be wrapped by text.
When the image's alignment is middle, this property doesn't make effect.
The default value is false.
getTextWrap
public boolean getTextWrap()
- Gets a float value that indicates the image would be wrapped by text.
When the image's alignment is middle, this property doesn't make effect.
The default value is false.
setUnderlying
public ImageInfo setUnderlying(boolean underlying)
- Sets a boolean value that indicates the image would be underlying the text.
The default value is false.
getUnderlying
public boolean getUnderlying()
- Gets a boolean value that indicates the image would be underlying the text.
The default value is false.
setBlackWhite
public ImageInfo setBlackWhite(boolean blackWhite)
- Sets a bool value that indicates whether the image is forced to be black-and-white. If TIFF
image of CCITT subformat is used, this property must be set to true.
getBlackWhite
public boolean getBlackWhite()
- Gets a bool value that indicates whether the image is forced to be black-and-white. If TIFF
image of CCITT subformat is used, this property must be set to true.
getCcittImageHeight
public float getCcittImageHeight()
- Gets a float value that indicates the CCITT image height. CCITT image does not contain size
information so the width and height must be set by user.
setCcittImageHeight
public void setCcittImageHeight(float imageHeight)
- Sets a float value that indicates the CCITT image height. CCITT image does not contain size
information so the width and height must be set by user.
getCcittImageWidth
public float getCcittImageWidth()
- Gets a float value that indicates the CCITT image width. CCITT image does not contain size
information so the width and height must be set by user.
setCcittImageWidth
public void setCcittImageWidth(float imageWidth)
- Sets a float value that indicates the CCITT image width. CCITT image does not contain size
information so the width and height must be set by user.
|