com.aspose.pdf.elements
Class ImageInfo

java.lang.Object
  extended bycom.aspose.pdf.elements.PdfElementBase
      extended bycom.aspose.pdf.elements.ImageInfo
All Implemented Interfaces:
java.lang.Cloneable

public class ImageInfo
extends PdfElementBase

Encapsulates info for an Image paragraph.

See Also:
Image

Constructor Summary
ImageInfo(ElementFactory elementFactory)
          Initializes a new instance of the ImageInfo class.
 
Method Summary
 int getAlignment()
          Gets an AlignmentType object that indicates the image alignment type.
 java.lang.String getDefaultFile()
          Gets a string that indicates the default image file name.
 java.lang.String getFile()
          Gets a string that indicates the image file name and its path.
 float getFixWidth()
          Gets a float value that indicates the fixed width of the image.
 java.lang.String 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.
 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.
 ImageInfo setAlignment(int alignment)
          Sets a AlignmentType object that indicates the image alignment type.
 ImageInfo setDefaultFile(java.lang.String file)
          Sets a string that indicates the default image file name.
 ImageInfo setFile(java.lang.String file)
          Sets a string that indicates the image file name and its path.
 ImageInfo setFixWidth(float width)
          Sets a float value that indicates the fixed width of the image.
 ImageInfo setImageFileType(java.lang.String 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 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.
 
Methods inherited from class com.aspose.pdf.elements.PdfElementBase
clone, getDOMElement, getElementFactory, getID, getNameIndex, setID
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageInfo

public ImageInfo(ElementFactory elementFactory)
Initializes a new instance of the ImageInfo class.

Method Detail

getAlignment

public int getAlignment()
Gets an AlignmentType object that indicates the image alignment type.

Returns:
Returns the alignment.
See Also:
AlignmentType

setAlignment

public ImageInfo setAlignment(int alignment)
Sets a AlignmentType object that indicates the image alignment type.

Parameters:
alignment - The alignment to set.
See Also:
AlignmentType

getDefaultFile

public java.lang.String getDefaultFile()
Gets a string that indicates the default image file name.
If this name is not null, Aspose.Pdf will use this image file when the
image specified in File is not found.

Returns:
Returns the defaultFile.

setDefaultFile

public ImageInfo setDefaultFile(java.lang.String file)
Sets a string that indicates the default image file name.
If this name is not null, Aspose.Pdf will use this image file when the
image specified in File is not found.

Parameters:
file - The defaultFile to set.

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.

getImageFileType

public java.lang.String getImageFileType()
Gets a ImageFileType object that indicates the image type.

Returns:
Returns the ImageFileType.

setImageFileType

public ImageInfo setImageFileType(java.lang.String 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.

Returns:
Returns the ImageOpenType.
See Also:
ImageOpenType

setOpenType

public ImageInfo setOpenType(java.lang.String type)
Sets a ImageOpenType that indicates the image open type.

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.


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