Package org.apache.fop.afp.modca

Class ResourceEnvironmentGroup

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
org.apache.fop.afp.modca.AbstractEnvironmentGroup
org.apache.fop.afp.modca.ResourceEnvironmentGroup
All Implemented Interfaces:
Completable, Streamable
public class ResourceEnvironmentGroup extends AbstractEnvironmentGroup implements Completable
A Resource Environment Group contains a set of resources for a document or for a group of pages in a document.

  • Constructor Details

    • ResourceEnvironmentGroup

      public ResourceEnvironmentGroup()
      Default constructor

    • ResourceEnvironmentGroup

      public ResourceEnvironmentGroup(String name)
      Constructor for the ResourceEnvironmentGroup, this takes a name parameter which must be 8 characters long.
      Parameters:
      name - the resource environment group name

  • Method Details

    • writeStart

      protected void writeStart(OutputStream os) throws IOException
      Helper method to write the start of the Object.
      Overrides:
      writeStart in class AbstractStructuredObject
      Parameters:
      os - The stream to write to
      Throws:
      IOException - throws an I/O exception if one occurred

    • writeEnd

      protected void writeEnd(OutputStream os) throws IOException
      Helper method to write the end of the Object.
      Overrides:
      writeEnd in class AbstractStructuredObject
      Parameters:
      os - The stream to write to
      Throws:
      IOException - an I/O exception if one occurred

    • writeContent

      protected void writeContent(OutputStream os) throws IOException
      Helper method to write the contents of the Object.
      Overrides:
      writeContent in class AbstractEnvironmentGroup
      Parameters:
      os - The stream to write to
      Throws:
      IOException - throws an I/O exception if one occurred

    • setComplete

      public void setComplete(boolean complete)
      Sets whether or not this object is complete or not
      Specified by:
      setComplete in interface Completable
      Parameters:
      complete - true if this object is complete

    • isComplete

      public boolean isComplete()
      Returns true if this object is complete
      Specified by:
      isComplete in interface Completable
      Returns:
      true if this object is complete