Package org.apache.fop.render.ps.extensions

Class AbstractPSExtensionElement

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.render.ps.extensions.AbstractPSExtensionElement
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
AbstractPSCommentElement, PSSetPageDeviceElement
public abstract class AbstractPSExtensionElement extends FONode
Base class for the PostScript-specific extension elements.

  • Field Details

  • Constructor Details

    • AbstractPSExtensionElement

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

  • Method Details

    • validateChildNode

      protected void validateChildNode(Locator loc, String nsURI, String localName) throws ValidationException
      Blocks XSL FO's from having non-FO parents.
      Overrides:
      validateChildNode in class FONode
      Parameters:
      loc - location in the FO source file
      nsURI - namespace of incoming node
      localName - (e.g. "table" for "fo:table")
      Throws:
      ValidationException - if incoming node not valid for parent
      See Also:

    • characters

      protected void characters(char[] data, int start, int length, PropertyList pList, 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 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:

    • getNormalNamespacePrefix

      public String getNormalNamespacePrefix()
      Description copied from class: FONode
      Returns the normally used namespace prefix for this node
      Specified by:
      getNormalNamespacePrefix in class FONode
      Returns:
      a String representation of this object
      See Also:

    • 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:

    • 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:

    • instantiateExtensionAttachment

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