Class AbstractPSExtensionElement

    • Constructor Detail

      • AbstractPSExtensionElement

        public AbstractPSExtensionElement​(FONode parent)
        Default constructor
        Parameters:
        parent - parent of this node
        See Also:
        FONode(FONode)
    • Method Detail

      • characters

        protected void characters​(char[] data,
                                  int start,
                                  int length,
                                  PropertyList pList,
                                  org.xml.sax.Locator locator)
        Adds characters. Does nothing by default. To be overridden in subclasses that allow #PCDATA content.
        Overrides:
        characters in class FONode
        Parameters:
        data - array of characters containing text to be added
        start - starting array element to add
        length - number of elements to add
        pList - currently applicable PropertyList
        locator - location in the XSL-FO source file.
      • getNamespaceURI

        public java.lang.String getNamespaceURI()
        Description copied from class: FONode
        Returns the namespace URI for this node
        Overrides:
        getNamespaceURI in class FONode
        Returns:
        a String representation of this object
        See Also:
        FONode.getNamespaceURI()
      • endOfNode

        public void endOfNode()
                       throws FOPException
        Description copied from class: FONode
        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 FONode
        Throws:
        FOPException - if there's a problem during processing
        See Also:
        FONode.endOfNode()
      • getExtensionAttachment

        public ExtensionAttachment getExtensionAttachment()
        Description copied from class: FONode
        This method is overridden by extension elements and allows the extension element to return a pass-through attachment which the parent formatting objects should simply carry with them but otherwise ignore. This mechanism is used to pass non-standard information from the FO tree through to the layout engine and the renderers.
        Overrides:
        getExtensionAttachment in class FONode
        Returns:
        the extension attachment if one is created by the extension element, null otherwise.
        See Also:
        FONode.getExtensionAttachment()
      • instantiateExtensionAttachment

        protected abstract ExtensionAttachment instantiateExtensionAttachment()
        Instantiates extension attachment object
        Returns:
        extension attachment