Package org.apache.fop.fo.flow

Class AbstractPageNumberCitation

    • Constructor Detail

      • AbstractPageNumberCitation

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

    • Method Detail

      • 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​(java.lang.String elementName,
                        org.xml.sax.Locator locator,
                        org.xml.sax.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​(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

      • getColor

        public java.awt.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.

      • 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

      • getLineHeight

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

      • getRefId

        public java.lang.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 java.util.Stack<DelimitedTextRange> collectDelimitedTextRanges​(java.util.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