Package org.apache.fop.afp.modca
Class IncludePageSegment
- All Implemented Interfaces:
Streamable
The Include Page Segment structured field references a page segment resource
object that is to be presented on the page or overlay presentation space. The IPS
specifies a reference point on the including page or overlay coordinate system that
may be used to position objects contained in the page segment. A page segment
can be referenced at any time during page or overlay state, but not during an
object state. The page segment inherits the active environment group definition of
the including page or overlay.
Note : No use for Triplets.
A 'real' example for where this will be used is for
the dynamic placing of overlay objects, such as signatures
that may have to be placed at different positions on a document.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type
-
Field Summary
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_LENGTH
-
Constructor Summary
ConstructorDescriptionIncludePageSegment
(String name, int x, int y) Constructor for the Include Page Segment -
Method Summary
Modifier and TypeMethodDescriptionvoid
DataStream objects must implement the writeToStream() method to write its data to the given OutputStreamMethods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setName, toString
Methods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, 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
copySF, truncate, writeChunksToStream, writeObjects
-
Constructor Details
-
IncludePageSegment
Constructor for the Include Page Segment- Parameters:
name
- Name of the page segmentx
- The x positiony
- The y position
-
-
Method Details
-
writeToStream
DataStream objects must implement the writeToStream() method to write its data to the given OutputStream- Specified by:
writeToStream
in interfaceStreamable
- Overrides:
writeToStream
in classAbstractStructuredObject
- Parameters:
os
- the outputsteam stream- Throws:
IOException
- an I/O exception of some sort has occurred.
-