Package org.apache.fop.fo.flow

Class RetrieveMarker

  • All Implemented Interfaces:
    java.lang.Cloneable, Constants
    public class RetrieveMarker
extends AbstractRetrieveMarker
    Class modelling the fo:retrieve-marker formatting object. This will create a layout manager that will retrieve a marker based on the information.

    • Constructor Detail

      • RetrieveMarker

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

    • Method Detail

      • processNode

        public void processNode​(java.lang.String elementName,
                        org.xml.sax.Locator locator,
                        org.xml.sax.Attributes attlist,
                        PropertyList pList)
                 throws FOPException
        Initialize the node with its name, location information, and attributes The attributes must be used immediately as the sax attributes will be altered for the next element. NOTE: An fo:retrieve-marker is only permitted as a descendant of an fo:static-content.
        Overrides:
        processNode in class FObj
        Parameters:
        elementName - element name (e.g., "fo:block")
        locator - Locator object (ignored by default)
        attlist - Collection of attributes passed to us from the parser.
        pList - the property list of the parent node
        Throws:
        FOPException - for errors or inconsistencies in the attributes

      • 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 AbstractRetrieveMarker
        Parameters:
        pList - the PropertyList where the properties can be found.
        Throws:
        FOPException - if there is a problem binding the values

      • startOfNode

        public void startOfNode()
                 throws FOPException
        Description copied from class: FObj
        Called after processNode() is called. Subclasses can do additional processing.
        Overrides:
        startOfNode in class FObj
        Throws:
        FOPException - FOP Exception

      • endOfNode

        public void endOfNode()
               throws FOPException
        Description copied from class: FObjMixed
        Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO has been reached. The default implementation simply calls FONode.finalizeNode(), without sending any event to the FOEventHandler.

        Note: the recommended way to override this method in subclasses is

        super.endOfNode(); // invoke finalizeNode()

        getFOEventHandler().endXXX(); // send endOfNode() notification

        Overrides:
        endOfNode in class FObjMixed
        Throws:
        FOPException - FOP Exception

      • getLocalName

        public java.lang.String getLocalName()
        Returns the local name (i.e. without namespace prefix) of the node
        Specified by:
        getLocalName in class AbstractRetrieveMarker
        Returns:
        the local name of this node