Package org.apache.fop.afp.modca
Class PageSegment
- All Implemented Interfaces:
Streamable
A page segment is a MO:DCA-P resource object. It may be stored in an
external resource library or it may be carried in a resource group.
Page segments contain any combination of IOCA image objects and
GOCA graphics objects.
-
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
nameFields inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
tripletsFields inherited from class org.apache.fop.afp.modca.AbstractAFPObject
LOG, SF_CLASS, SF_HEADER_LENGTH -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddObject(AbstractAFPObject object) Adds a resource object (image/graphic) to this page segmentReturns a list of objects contained withing this page segmenttoString()protected voidHelper method to write the contents of the Object.protected voidwriteEnd(OutputStream os) Helper method to write the end of the Object.protected voidHelper method to write the start of the Object.Methods inherited from class org.apache.fop.afp.modca.AbstractNamedAFPObject
copySF, getName, getNameBytes, getNameLength, setNameMethods inherited from class org.apache.fop.afp.modca.AbstractTripletStructuredObject
addTriplet, addTriplets, getFullyQualifiedName, getTripletDataLength, getTriplets, hasTriplet, hasTriplets, setComment, setFullyQualifiedName, setFullyQualifiedName, setObjectClassification, writeTripletsMethods inherited from class org.apache.fop.afp.modca.AbstractStructuredObject
writeToStreamMethods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream, writeObjects
-
Constructor Details
-
PageSegment
Main constructor- Parameters:
name- the name of this object
-
-
Method Details
-
getObjects
Returns a list of objects contained withing this page segment- Returns:
- a list of objects contained within this page segment
-
addObject
Adds a resource object (image/graphic) to this page segment- Parameters:
object- the resource objec to add to this page segment
-
writeStart
Helper method to write the start of the Object.- Overrides:
writeStartin classAbstractStructuredObject- Parameters:
os- The stream to write to- Throws:
IOException- throws an I/O exception if one occurred
-
writeContent
Helper method to write the contents of the Object.- Overrides:
writeContentin classAbstractStructuredObject- Parameters:
os- The stream to write to- Throws:
IOException- throws an I/O exception if one occurred
-
writeEnd
Helper method to write the end of the Object.- Overrides:
writeEndin classAbstractStructuredObject- Parameters:
os- The stream to write to- Throws:
IOException- an I/O exception if one occurred
-
toString
- Overrides:
toStringin classAbstractNamedAFPObject
-