|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.AbstractStructuredObject
org.apache.fop.afp.modca.AbstractTripletStructuredObject
org.apache.fop.afp.modca.AbstractNamedAFPObject
org.apache.fop.afp.modca.IncludeObject
public class IncludeObject
An Include Object structured field references an object on a page or overlay. It optionally contains parameters that identify the object and that specify presentation parameters such as object position, size, orientation, mapping, and default color.
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject |
---|
AbstractAFPObject.Category, AbstractAFPObject.Type |
Field Summary | |
---|---|
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 |
Fields inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject |
---|
name |
Fields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject |
---|
triplets |
Fields inherited from class org.apache.fop.afp.modca.AbstractAFPObject |
---|
log, SF_CLASS, SF_HEADER |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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 |
Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject |
---|
copySF, getName, getNameBytes, getNameLength, setName |
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject |
---|
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setObjectClassification, writeTriplets |
Methods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject |
---|
writeContent, writeEnd, writeStart |
Methods inherited from class org.apache.fop.afp.modca.AbstractAFPObject |
---|
copyChunks, copySF, truncate, writeChunksToStream, writeObjects |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public 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
Constructor Detail |
---|
public IncludeObject(java.lang.String name)
name
- the name of this include objectMethod Detail |
---|
public 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 Streamable
writeToStream
in class AbstractStructuredObject
os
- the outputsteam stream
java.io.IOException
- an I/O exception of some sort has occurred.public java.lang.String toString()
toString
in class AbstractNamedAFPObject
public 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-axis
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |