Class Footnote

Method Details

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

  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

• startOfNode

  public void startOfNode() throws FOPException

  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

  Make sure content model satisfied, if so then tell the FOEventHandler that we are at the end of the footnote. 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 FObj

  Throws:

  FOPException - FOP Exception

• 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: (inline,footnote-body) TODO implement additional constraint: A fo:footnote is not permitted to have a fo:float, fo:footnote, or fo:marker as a descendant. TODO implement additional constraint: A fo:footnote is not permitted to have as a descendant a fo:block-container that generates an absolutely positioned area.

  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

• addChildNode

  public void addChildNode(FONode child)

  Adds a node as a child of this node. The default implementation of this method just ignores any child node being added.

  Overrides:

  addChildNode in class FObj

  Parameters:

  child - child node to be added to the childNodes of this node

• getCommonAccessibility

  public CommonAccessibility getCommonAccessibility()

  Returns the accessibility properties.

  Specified by:

  getCommonAccessibility in interface CommonAccessibilityHolder

  Returns:

  the accessibility properties

• getFootnoteCitation

  public Inline getFootnoteCitation()

  Public accessor for inline FO

  Returns:

  the Inline child

• getFootnoteBody

  public FootnoteBody getFootnoteBody()

  Public accessor for footnote-body FO

  Returns:

  the FootnoteBody child

• getLocalName

  public String getLocalName()

  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 int getNameId()

  Returns the Constants class integer value of this node

  Overrides:

  getNameId in class FONode

  Returns:

  Constants.FO_FOOTNOTE