Package org.apache.fop.afp.modca
Class AbstractDataObject
- All Implemented Interfaces:
Completable,Startable,Streamable
- Direct Known Subclasses:
GraphicsObject,ImageObject,ObjectContainer
public abstract class AbstractDataObject
extends AbstractNamedAFPObject
implements Startable, Completable
Abstract base class used by the ImageObject and GraphicsObject which both
have define an ObjectEnvironmentGroup
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Factorythe object factoryprotected ObjectEnvironmentGroupthe object environment groupFields 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 TypeMethodDescriptionGets the ObjectEnvironmentGroupbooleanReturns true if this object is completebooleanReturns true if this object has startedvoidsetComplete(boolean complete) Sets whether or not this object is complete or notvoidsetStarted(boolean started) Sets whether or not this object has started or notvoidsetViewport(AFPDataObjectInfo dataObjectInfo) Sets the object view port (area position and size).protected voidHelper method to write the contents 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, setName, toStringMethods 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
writeEnd, writeToStreamMethods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream, writeObjects
-
Field Details
-
objectEnvironmentGroup
the object environment group -
factory
the object factory
-
-
Constructor Details
-
AbstractDataObject
Named constructor- Parameters:
factory- the object factoryname- data object name
-
-
Method Details
-
setViewport
Sets the object view port (area position and size).- Parameters:
dataObjectInfo- the object area info
-
getObjectEnvironmentGroup
Gets the ObjectEnvironmentGroup- Returns:
- the object environment group
-
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
-
setStarted
public void setStarted(boolean started) Sets whether or not this object has started or not- Specified by:
setStartedin interfaceStartable- Parameters:
started- true if this object has started
-
isStarted
public boolean isStarted()Returns true if this object has started -
setComplete
public void setComplete(boolean complete) Sets whether or not this object is complete or not- Specified by:
setCompletein interfaceCompletable- Parameters:
complete- true if this object is complete
-
isComplete
public boolean isComplete()Returns true if this object is complete- Specified by:
isCompletein interfaceCompletable- Returns:
- true if this object is complete
-