Class AbstractRetrieveMarker

    • Field Detail

      • retrieveClassName

        private java.lang.String retrieveClassName
      • position

        private int position
      • positionLabel

        private java.lang.String positionLabel
      • boundary

        private int boundary
      • boundaryLabel

        private java.lang.String boundaryLabel
    • Constructor Detail

      • AbstractRetrieveMarker

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

      • validateChildNode

        protected void validateChildNode​(org.xml.sax.Locator loc,
                                         java.lang.String nsURI,
                                         java.lang.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.
      • cloneSubtree

        private void cloneSubtree​(java.util.Iterator parentIter,
                                  FONode newParent,
                                  Marker marker,
                                  PropertyList parentPropertyList)
                           throws FOPException
        Clone the FO nodes in the parent iterator, attach the new nodes to the new parent, and map the new nodes to the existing property lists. FOText nodes are also in the new map, with a null value. Clone the subtree by a recursive call to this method.
        Parameters:
        parentIter - the iterator over the children of the old parent
        newParent - the new parent for the cloned nodes
        marker - the marker that contains the old property list mapping
        parentPropertyList - the parent PropertyList
        Throws:
        FOPException - in case there was an error
      • 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 java.lang.String getRetrieveClassName()
        Return the value for the retrieve-class-name property
        Returns:
        the value for retrieve-class-name
      • setBoundaryLabel

        protected void setBoundaryLabel​(java.lang.String label)
      • setPositionLabel

        protected void setPositionLabel​(java.lang.String label)
      • getBoundaryLabel

        public java.lang.String getBoundaryLabel()
      • getPositionLabel

        public java.lang.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 java.lang.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
      • changePositionTo

        public void changePositionTo​(int position)