Package org.apache.fop.afp
Class AFPDataObjectInfo
- java.lang.Object
-
- org.apache.fop.afp.AFPDataObjectInfo
-
- Direct Known Subclasses:
AFPGraphicsObjectInfo
,AFPImageObjectInfo
public class AFPDataObjectInfo extends java.lang.Object
A list of parameters associated with an AFP data objects
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
createPageSegment
controls whether to create a page segment or a simple objectprivate byte[]
data
the object data in a byte arrayprivate int
dataHeight
the data object heightprivate int
dataHeightRes
the object data height resolutionprivate int
dataWidth
the data object widthprivate int
dataWidthRes
the object data width resolutionstatic byte
DEFAULT_MAPPING_OPTION
private byte
mappingOption
controls the mapping of the image data into the image areaprivate java.lang.String
mimeType
the object registry mimetypeprivate AFPObjectAreaInfo
objectAreaInfo
the object area infoprivate AFPResourceInfo
resourceInfo
resource info
-
Constructor Summary
Constructors Constructor Description AFPDataObjectInfo()
Default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
getData()
Returns the object dataint
getDataHeight()
Returns the image data heightint
getDataHeightRes()
Returns the data height resolutionint
getDataWidth()
Returns the image data widthint
getDataWidthRes()
Returns the data width resolutionbyte
getMappingOption()
Returns the way an image is mapped into its target area.java.lang.String
getMimeType()
Returns the mime type of this data objectAFPObjectAreaInfo
getObjectAreaInfo()
Returns the object area infoRegistry.ObjectType
getObjectType()
Convenience method to return the object typeAFPResourceInfo
getResourceInfo()
Returns the resource level at which this data object should residejava.lang.String
getUri()
Returns the uri of this data objectboolean
isCreatePageSegment()
Indicates whether a page segment or a normal object shall be created.void
setCreatePageSegment(boolean value)
Controls whether to create a page segment or a normal object.void
setData(byte[] data)
Sets the object datavoid
setDataHeight(int imageDataHeight)
Sets the image data heightvoid
setDataHeightRes(int dataHeightRes)
Sets the data height resolutionvoid
setDataWidth(int imageDataWidth)
Sets the image data widthvoid
setDataWidthRes(int dataWidthRes)
Sets the data width resolutionvoid
setMappingOption(byte mappingOption)
Sets the way an image is mapped into its target area.void
setMimeType(java.lang.String mimeType)
Sets the image mime typevoid
setObjectAreaInfo(AFPObjectAreaInfo objectAreaInfo)
Sets the object area infovoid
setResourceInfo(AFPResourceInfo resourceInfo)
Sets the resource level at which this object should residevoid
setUri(java.lang.String uri)
Sets the data object urijava.lang.String
toString()
-
-
-
Field Detail
-
objectAreaInfo
private AFPObjectAreaInfo objectAreaInfo
the object area info
-
resourceInfo
private AFPResourceInfo resourceInfo
resource info
-
dataWidth
private int dataWidth
the data object width
-
dataHeight
private int dataHeight
the data object height
-
mimeType
private java.lang.String mimeType
the object registry mimetype
-
data
private byte[] data
the object data in a byte array
-
dataHeightRes
private int dataHeightRes
the object data height resolution
-
dataWidthRes
private int dataWidthRes
the object data width resolution
-
createPageSegment
private boolean createPageSegment
controls whether to create a page segment or a simple object
-
mappingOption
private byte mappingOption
controls the mapping of the image data into the image area
-
DEFAULT_MAPPING_OPTION
public static final byte DEFAULT_MAPPING_OPTION
- See Also:
- Constant Field Values
-
-
Method Detail
-
setMimeType
public void setMimeType(java.lang.String mimeType)
Sets the image mime type- Parameters:
mimeType
- the image mime type
-
getMimeType
public java.lang.String getMimeType()
Returns the mime type of this data object- Returns:
- the mime type of this data object
-
getObjectType
public Registry.ObjectType getObjectType()
Convenience method to return the object type- Returns:
- the object type
-
getResourceInfo
public AFPResourceInfo getResourceInfo()
Returns the resource level at which this data object should reside- Returns:
- the resource level at which this data object should reside
-
setResourceInfo
public void setResourceInfo(AFPResourceInfo resourceInfo)
Sets the resource level at which this object should reside- Parameters:
resourceInfo
- the resource level at which this data object should reside
-
setObjectAreaInfo
public void setObjectAreaInfo(AFPObjectAreaInfo objectAreaInfo)
Sets the object area info- Parameters:
objectAreaInfo
- the object area info
-
getObjectAreaInfo
public AFPObjectAreaInfo getObjectAreaInfo()
Returns the object area info- Returns:
- the object area info
-
getUri
public java.lang.String getUri()
Returns the uri of this data object- Returns:
- the uri of this data object
-
setUri
public void setUri(java.lang.String uri)
Sets the data object uri- Parameters:
uri
- the data object uri
-
getDataWidth
public int getDataWidth()
Returns the image data width- Returns:
- the image data width
-
setDataWidth
public void setDataWidth(int imageDataWidth)
Sets the image data width- Parameters:
imageDataWidth
- the image data width
-
getDataHeight
public int getDataHeight()
Returns the image data height- Returns:
- the image data height
-
setDataHeight
public void setDataHeight(int imageDataHeight)
Sets the image data height- Parameters:
imageDataHeight
- the image data height
-
getDataHeightRes
public int getDataHeightRes()
Returns the data height resolution- Returns:
- the data height resolution
-
setDataHeightRes
public void setDataHeightRes(int dataHeightRes)
Sets the data height resolution- Parameters:
dataHeightRes
- the data height resolution
-
getDataWidthRes
public int getDataWidthRes()
Returns the data width resolution- Returns:
- the data width resolution
-
setDataWidthRes
public void setDataWidthRes(int dataWidthRes)
Sets the data width resolution- Parameters:
dataWidthRes
- the data width resolution
-
setData
public void setData(byte[] data)
Sets the object data- Parameters:
data
- the object data
-
getData
public byte[] getData()
Returns the object data- Returns:
- the object data
-
setCreatePageSegment
public void setCreatePageSegment(boolean value)
Controls whether to create a page segment or a normal object.- Parameters:
value
- true for page segments, false for objects
-
isCreatePageSegment
public boolean isCreatePageSegment()
Indicates whether a page segment or a normal object shall be created.- Returns:
- true for page segments, false for objects
-
setMappingOption
public void setMappingOption(byte mappingOption)
Sets the way an image is mapped into its target area.- Parameters:
mappingOption
- the mapping option (Valid values: see Mapping Option Triplet)
-
getMappingOption
public byte getMappingOption()
Returns the way an image is mapped into its target area. By default, this is "scale to fill" behavior.- Returns:
- the mapping option value from the Mapping Option Triplet
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-