Package org.apache.fop.afp.modca
Class IncludePageOverlay
- All Implemented Interfaces:
Streamable
The Include Page Overlay structured field references an overlay resource
definition that is to be positioned on the page. A page overlay can be
referenced at any time during the page state, but not during an object state.
The overlay contains its own active environment group definition.
Note: There is no need for the triplets, so I have ignored them.
A real example of where this will be used is for static overlays, such as an
address on the page.
-
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
ConstructorDescriptionIncludePageOverlay
(String overlayName, int x, int y, int orientation) Constructor for the Include Page Overlay -
Method Summary
Modifier and TypeMethodDescriptionvoid
setOrientation
(int orientation) Sets the orientation to use for the overlay.void
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
-
IncludePageOverlay
Constructor for the Include Page Overlay- Parameters:
overlayName
- Name of the page segmentx
- The x positiony
- The y positionorientation
- The orientation
-
-
Method Details
-
setOrientation
public void setOrientation(int orientation) Sets the orientation to use for the overlay.- Parameters:
orientation
- The orientation (0,90, 180, 270)
-
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.
-