Package org.apache.fop.afp.modca

Class AbstractResourceEnvironmentGroupContainer

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.AbstractPageObject
org.apache.fop.afp.modca.AbstractResourceGroupContainer
org.apache.fop.afp.modca.AbstractResourceEnvironmentGroupContainer
All Implemented Interfaces:
Completable, Streamable
Direct Known Subclasses:
Document, PageGroup
public abstract class AbstractResourceEnvironmentGroupContainer extends AbstractResourceGroupContainer
An abstract class which encapsulates the common features of Document and PageGroup resource containers

  • Field Details

    • resourceEnvironmentGroup

      protected ResourceEnvironmentGroup resourceEnvironmentGroup
      The resource environment group used to store complex resources

  • Constructor Details

    • AbstractResourceEnvironmentGroupContainer

      public AbstractResourceEnvironmentGroupContainer(Factory factory, String name)
      Main constructor
      Parameters:
      factory - the object factory
      name - the name of this resource container

  • Method Details

    • addPage

      public void addPage(PageObject page)
      Adds a page to the resource container.
      Parameters:
      page - - the Page object

    • addPageGroup

      public void addPageGroup(PageGroup pageGroup)
      Adds a PageGroup to the resource container.
      Parameters:
      pageGroup - the PageGroup object

    • createInvokeMediumMap

      public void createInvokeMediumMap(String name)
      Creates an InvokeMediaMap on the page.
      Overrides:
      createInvokeMediumMap in class AbstractPageObject
      Parameters:
      name - the name of the media map

    • writeContent

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

    • getResourceEnvironmentGroup

      protected ResourceEnvironmentGroup getResourceEnvironmentGroup()
      Returns the resource environment group
      Returns:
      the resource environment group