Package org.apache.fop.afp.modca
Class AbstractNamedAFPObject
java.lang.Object
org.apache.fop.afp.modca.AbstractAFPObject
org.apache.fop.afp.modca.AbstractStructuredObject
org.apache.fop.afp.modca.AbstractTripletStructuredObject
org.apache.fop.afp.modca.AbstractNamedAFPObject
- All Implemented Interfaces:
Streamable
- Direct Known Subclasses:
AbstractDataObject,AbstractEnvironmentGroup,AbstractGraphicsDrawingOrderContainer,AbstractPageObject,ImageSegment,IMImageObject,IncludedResourceObject,IncludeObject,IncludePageOverlay,IncludePageSegment,InvokeMediumMap,ObjectEnvironmentGroup,PageSegment,PresentationTextObject,ResourceGroup,ResourceObject
This is the base class for all named data stream objects.
A named data stream object has an 8 byte EBCIDIC name.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.fop.afp.modca.AbstractAFPObject
AbstractAFPObject.Category, AbstractAFPObject.Type -
Field Summary
FieldsFields 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
ConstructorsModifierConstructorDescriptionprotectedDefault constructorprotectedAbstractNamedAFPObject(String name) Constructor for the ActiveEnvironmentGroup, this takes a name parameter which should be 8 characters long. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcopySF(byte[] data, byte type, byte category) Copies the template structured field data array to the given byte arraygetName()Returns the name of this objectbyte[]Returns the name as a byte array in EBCIDIC encodingprotected intReturns the name lengthvoidSets the name of this objecttoString()Methods 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
writeContent, writeEnd, writeStart, writeToStreamMethods inherited from class org.apache.fop.afp.modca.AbstractAFPObject
copySF, truncate, writeChunksToStream, writeObjects
-
Field Details
-
name
The actual name of the object
-
-
Constructor Details
-
AbstractNamedAFPObject
protected AbstractNamedAFPObject()Default constructor -
AbstractNamedAFPObject
Constructor for the ActiveEnvironmentGroup, this takes a name parameter which should be 8 characters long.- Parameters:
name- the object name
-
-
Method Details
-
getNameLength
protected int getNameLength()Returns the name length- Returns:
- the name length
-
getNameBytes
public byte[] getNameBytes()Returns the name as a byte array in EBCIDIC encoding- Returns:
- the name as a byte array in EBCIDIC encoding
-
copySF
protected void copySF(byte[] data, byte type, byte category) Description copied from class:AbstractAFPObjectCopies the template structured field data array to the given byte array- Overrides:
copySFin classAbstractAFPObject- Parameters:
data- the structured field data byte arraytype- the type codecategory- the category code
-
getName
Returns the name of this object- Returns:
- the name of this object
-
setName
Sets the name of this object- Parameters:
name- the object name
-
toString
-