Package org.apache.fop.afp.modca
Class MapPageSegment
java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.MapPageSegment
- All Implemented Interfaces:
Streamable
The Map Page Segment structured field identifies page segments that are required to present
a page on a physical medium.
-
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.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPageSegment
(String name) Add a page segment to to the map page segment object.boolean
isFull()
Indicates whether this object already contains the maximum number of page segments.void
DataStream objects must implement the writeToStream() method to write its data to the given OutputStreamMethods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, copySF, truncate, writeChunksToStream, writeObjects
-
Constructor Details
-
MapPageSegment
public MapPageSegment()Constructor for the Map Page Overlay
-
-
Method Details
-
addPageSegment
Add a page segment to to the map page segment object.- Parameters:
name
- the name of the page segment.- Throws:
MaximumSizeExceededException
- if the maximum size is reached
-
isFull
public boolean isFull()Indicates whether this object already contains the maximum number of page segments.- Returns:
- true if the object is full
-
writeToStream
DataStream objects must implement the writeToStream() method to write its data to the given OutputStream- Parameters:
os
- the outputsteam stream- Throws:
IOException
- an I/O exception of some sort has occurred.
-