Package org.apache.fop.fo.flow

Class AbstractPageNumberCitation

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.flow.AbstractPageNumberCitation
All Implemented Interfaces:
Cloneable, Constants, CommonAccessibilityHolder, StructureTreeElementHolder
Direct Known Subclasses:
PageNumberCitation, PageNumberCitationLast
public abstract class AbstractPageNumberCitation extends FObj implements StructureTreeElementHolder, CommonAccessibilityHolder
Common base class for the fo:page-number-citation and fo:page-number-citation-last objects.

  • Constructor Details

    • AbstractPageNumberCitation

      public AbstractPageNumberCitation(FONode parent)
      Base constructor
      Parameters:
      parent - FONode that is the parent of this object

  • 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

    • processNode

      public void processNode(String elementName, Locator locator, 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.
      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

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

    • getCommonAccessibility

      public CommonAccessibility getCommonAccessibility()
      Returns the accessibility properties.
      Specified by:
      getCommonAccessibility in interface CommonAccessibilityHolder
      Returns:
      the accessibility properties

    • getCommonFont

      public CommonFont getCommonFont()
      Returns:
      the CommonFont

    • getColor

      public Color getColor()
      Returns:
      the "color" property.

    • getTextDecoration

      public CommonTextDecoration getTextDecoration()
      Returns:
      the "text-decoration" property.

    • setStructureTreeElement

      public void setStructureTreeElement(StructureTreeElement structureTreeElement)
      Description copied from class: FONode
      Sets the structure tree element.
      Overrides:
      setStructureTreeElement in class FONode
      Parameters:
      structureTreeElement - set.

    • getStructureTreeElement

      public StructureTreeElement getStructureTreeElement()
      Description copied from class: FONode
      Returns the structure tree element associated to this object.
      Specified by:
      getStructureTreeElement in interface StructureTreeElementHolder
      Overrides:
      getStructureTreeElement in class FONode
      Returns:
      the structure tree element

    • getAlignmentAdjust

      public Length getAlignmentAdjust()
      Returns:
      the "alignment-adjust" property

    • getAlignmentBaseline

      public int getAlignmentBaseline()
      Returns:
      the "alignment-baseline" property

    • getBaselineShift

      public Length getBaselineShift()
      Returns:
      the "baseline-shift" property

    • getDominantBaseline

      public int getDominantBaseline()
      Returns:
      the "dominant-baseline" property

    • getCommonBorderPaddingBackground

      public CommonBorderPaddingBackground getCommonBorderPaddingBackground()
      Returns:
      the CommonBorderPaddingBackground

    • getLineHeight

      public SpaceProperty getLineHeight()
      Returns:
      the "line-height" property

    • getRefId

      public String getRefId()
      Returns:
      the "ref-id" property.

    • isDelimitedTextRangeBoundary

      public boolean isDelimitedTextRangeBoundary(int boundary)
      Description copied from class: FONode
      Determine if node has a delimited text range boundary. N.B. that we report this to be true by default, while specific subclasses override this method to report false.
      Overrides:
      isDelimitedTextRangeBoundary in class FONode
      Parameters:
      boundary - one of {EN_BEFORE, EN_AFTER, or EN_BOTH} enumeration constants
      Returns:
      true if indicated boundary (or boundaries) constitute a delimited text range boundary.

    • collectDelimitedTextRanges

      protected Stack<DelimitedTextRange> collectDelimitedTextRanges(Stack<DelimitedTextRange> ranges, DelimitedTextRange currentRange)
      Description copied from class: FONode
      Collect the sequence of delimited text ranges, where each new range is pushed onto RANGES, where default implementation collects ranges of child nodes.
      Overrides:
      collectDelimitedTextRanges in class FONode
      Parameters:
      ranges - a stack of delimited text ranges
      currentRange - the current range or null (if none)
      Returns:
      the (possibly) updated stack of delimited text ranges