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
public abstract class AbstractNamedAFPObject extends AbstractTripletStructuredObject
This is the base class for all named data stream objects. A named data stream object has an 8 byte EBCIDIC name.

  • Field Details

    • name

      protected String name
      The actual name of the object

  • Constructor Details

    • AbstractNamedAFPObject

      protected AbstractNamedAFPObject()
      Default constructor

    • AbstractNamedAFPObject

      protected AbstractNamedAFPObject(String name)
      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: AbstractAFPObject
      Copies the template structured field data array to the given byte array
      Overrides:
      copySF in class AbstractAFPObject
      Parameters:
      data - the structured field data byte array
      type - the type code
      category - the category code

    • getName

      public String getName()
      Returns the name of this object
      Returns:
      the name of this object

    • setName

      public void setName(String name)
      Sets the name of this object
      Parameters:
      name - the object name

    • toString

      public String toString()
      Overrides:
      toString in class Object