fop 1.0

org.apache.fop.afp
Class AFPDataObjectInfo

java.lang.Object
  extended by 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


Constructor Summary
AFPDataObjectInfo()
          Default constructor
 
Method Summary
 byte[] getData()
          Returns the object data
 int getDataHeight()
          Returns the image data height
 int getDataHeightRes()
          Returns the data height resolution
 int getDataWidth()
          Returns the image data width
 int getDataWidthRes()
          Returns the data width resolution
 byte getMappingOption()
          Returns the way an image is mapped into its target area.
 java.lang.String getMimeType()
          Returns the mime type of this data object
 AFPObjectAreaInfo getObjectAreaInfo()
          Returns the object area info
 Registry.ObjectType getObjectType()
          Convenience method to return the object type
 AFPResourceInfo getResourceInfo()
          Returns the resource level at which this data object should reside
 java.lang.String getUri()
          Returns the uri of this data object
 boolean 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 data
 void setDataHeight(int imageDataHeight)
          Sets the image data height
 void setDataHeightRes(int dataHeightRes)
          Sets the data width resolution
 void setDataWidth(int imageDataWidth)
          Sets the image data width
 void setDataWidthRes(int dataWidthRes)
          Sets the data width resolution
 void setMappingOption(byte mappingOption)
          Sets the way an image is mapped into its target area.
 void setMimeType(java.lang.String mimeType)
          Sets the image mime type
 void setObjectAreaInfo(AFPObjectAreaInfo objectAreaInfo)
          Sets the object area info
 void setResourceInfo(AFPResourceInfo resourceInfo)
          Sets the resource level at which this object should reside
 void setUri(java.lang.String uri)
          Sets the data object uri
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AFPDataObjectInfo

public AFPDataObjectInfo()
Default constructor

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 width resolution

Parameters:
dataWidthRes - the data width 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 class java.lang.Object

fop 1.0

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.