public class IncludeObject extends AbstractNamedAFPObject
Where the presentation parameters conflict with parameters specified in the object's environment group (OEG), the parameters in the Include Object structured field override. If the referenced object is a page segment, the IOB parameters override the corresponding environment group parameters on all data objects in the page segment.
AbstractAFPObject.Category, AbstractAFPObject.Type| Modifier and Type | Field and Description |
|---|---|
static byte |
TYPE_BARCODE
the object referenced is of type barcode
|
static byte |
TYPE_GRAPHIC
the object referenced is of type graphic
|
static byte |
TYPE_IMAGE
the object referenced is of type image
|
static byte |
TYPE_OTHER
the object referenced is of type other
|
static byte |
TYPE_PAGE_SEGMENT
the object referenced is of type page segment
|
nametripletsLOG, SF_CLASS, SF_HEADER_LENGTH| Constructor and Description |
|---|
IncludeObject(java.lang.String name)
Constructor for the include object with the specified name, the name must
be a fixed length of eight characters and is the name of the referenced
object.
|
| Modifier and Type | Method and Description |
|---|---|
void |
setContentAreaOffset(int x,
int y)
Sets the x and y offset of the content area to the object area
used in conjunction with the
MappingOptionTriplet.POSITION and
MappingOptionTriplet.POSITION_AND_TRIM. |
void |
setMappingOption(byte optionValue)
Sets the mapping option
|
void |
setMeasurementUnits(int xRes,
int yRes)
Sets the measurement units used to specify the units of measure
|
void |
setObjectAreaOffset(int x,
int y)
Sets the x and y offset to the origin in the object area
|
void |
setObjectAreaOrientation(int orientation)
Sets the orientation to use for the Include Object.
|
void |
setObjectAreaSize(int x,
int y)
Sets the extent of an object area in the X and Y directions
|
void |
setObjectType(byte type)
Sets the data object type
|
java.lang.String |
toString() |
void |
writeToStream(java.io.OutputStream os)
DataStream objects must implement the writeToStream()
method to write its data to the given OutputStream
|
copySF, getName, getNameBytes, getNameLength, setNameaddTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTripletswriteContent, writeEnd, writeStartcopySF, truncate, writeChunksToStream, writeObjectspublic static final byte TYPE_PAGE_SEGMENT
public static final byte TYPE_OTHER
public static final byte TYPE_GRAPHIC
public static final byte TYPE_BARCODE
public static final byte TYPE_IMAGE
public IncludeObject(java.lang.String name)
name - the name of this include objectpublic void setObjectAreaOrientation(int orientation)
orientation - The orientation (0,90, 180, 270)public void setObjectAreaOffset(int x,
int y)
x - the X-axis origin of the object areay - the Y-axis origin of the object areapublic void setContentAreaOffset(int x,
int y)
MappingOptionTriplet.POSITION and
MappingOptionTriplet.POSITION_AND_TRIM.x - the X-axis origin defined in the objecty - the Y-axis origin defined in the objectpublic void setObjectType(byte type)
type - the data object typepublic void writeToStream(java.io.OutputStream os)
throws java.io.IOException
writeToStream in interface StreamablewriteToStream in class AbstractStructuredObjectos - the outputsteam streamjava.io.IOException - an I/O exception of some sort has occurred.public java.lang.String toString()
toString in class AbstractNamedAFPObjectpublic void setMappingOption(byte optionValue)
optionValue - the mapping option valuepublic void setObjectAreaSize(int x,
int y)
x - the x direction extenty - the y direction extentpublic void setMeasurementUnits(int xRes,
int yRes)
xRes - units per base on the x-axisyRes - units per base on the y-axisCopyright 1999-2022 The Apache Software Foundation. All Rights Reserved.