Package org.apache.fop.fo.flow

Class AbstractRetrieveMarker

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.FObjMixed
org.apache.fop.fo.flow.AbstractRetrieveMarker
All Implemented Interfaces:
Cloneable, Constants
Direct Known Subclasses:
RetrieveMarker, RetrieveTableMarker
public abstract class AbstractRetrieveMarker extends FObjMixed
Abstract base class for the fo:retrieve-marker and fo:retrieve-table-marker formatting objects.

  • Constructor Details

    • AbstractRetrieveMarker

      public AbstractRetrieveMarker(FONode parent)
      Create a new AbstractRetrieveMarker instance that is a child of the given FONode
      Parameters:
      parent - the parent FONode

  • Method Details

    • validateChildNode

      protected void validateChildNode(Locator loc, String nsURI, String localName) throws ValidationException
      Checks to make sure, during SAX processing of input document, that the incoming node is valid for this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called from FOTreeBuilder.startElement(String, String, String, Attributes) before constructing the child FObj.

      XSL Content Model: empty

      Overrides:
      validateChildNode in class FONode
      Parameters:
      loc - location in the FO source file
      nsURI - namespace of incoming node
      localName - name of the incoming node (without namespace prefix)
      Throws:
      ValidationException - if incoming node not valid for parent

    • bind

      public void bind(PropertyList pList) throws FOPException
      Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it. Store a reference to the parent PropertyList to be used when the retrieve-marker is resolved.
      Overrides:
      bind in class FObj
      Parameters:
      pList - the PropertyList where the properties can be found.
      Throws:
      FOPException - if there is a problem binding the values

    • setStructureTreeElement

      public void setStructureTreeElement(StructureTreeElement structureTreeElement)
      Description copied from class: FONode
      Sets the structure tree element.
      Overrides:
      setStructureTreeElement in class FONode
      Parameters:
      structureTreeElement - set.

    • getStructureTreeElement

      public StructureTreeElement getStructureTreeElement()
      Description copied from class: FONode
      Returns the structure tree element associated to this object.
      Overrides:
      getStructureTreeElement in class FONode
      Returns:
      the structure tree element

    • bindMarker

      public void bindMarker(Marker marker)
      Clone the subtree of the given marker
      Parameters:
      marker - the marker that is to be cloned

    • restoreFOEventHandlerState

      protected abstract void restoreFOEventHandlerState()

    • getRetrieveClassName

      public String getRetrieveClassName()
      Return the value for the retrieve-class-name property
      Returns:
      the value for retrieve-class-name

    • setBoundaryLabel

      protected void setBoundaryLabel(String label)

    • setPositionLabel

      protected void setPositionLabel(String label)

    • getBoundaryLabel

      public String getBoundaryLabel()

    • getPositionLabel

      public String getPositionLabel()

    • setPosition

      protected void setPosition(int position)

    • setBoundary

      protected void setBoundary(int boundary)

    • getPosition

      public int getPosition()

    • getBoundary

      public int getBoundary()

    • getLocalName

      public abstract String getLocalName()
      Description copied from class: FONode
      Returns the local name (i.e. without namespace prefix) of the node
      Specified by:
      getLocalName in class FONode
      Returns:
      the local name of this node

    • getNameId

      public abstract int getNameId()
      Description copied from class: FONode
      Returns the Constants class integer value of this node
      Overrides:
      getNameId in class FONode
      Returns:
      the integer enumeration of this FO (e.g. Constants.FO_ROOT) if a formatting object, Constants.FO_UNKNOWN_NODE otherwise

    • changePositionTo

      public void changePositionTo(int position)