Package org.apache.fop.fo.flow

Class Leader

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.FObjMixed
org.apache.fop.fo.flow.InlineLevel
org.apache.fop.fo.flow.Leader
All Implemented Interfaces:
Cloneable, Constants, CommonAccessibilityHolder
public class Leader extends InlineLevel
Class modelling the fo:leader object. The main property of fo:leader is leader-pattern. The following patterns are treated: rule, space, dots and use-content.

  • Constructor Details

    • Leader

      public Leader(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 InlineLevel
      Parameters:
      pList - the PropertyList where the properties can be found.
      Throws:
      FOPException - if there is a problem binding the values

    • 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: (#PCDATA|%inline;)*
      Additionally: "The content must not contain an fo:leader, fo:inline-container, fo:block-container, fo:float, fo:footnote, or fo:marker either as a direct child or as a descendant."
      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

    • getRuleStyle

      public int getRuleStyle()
      Returns:
      the "rule-style" property

    • getRuleThickness

      public Length getRuleThickness()
      Returns:
      the "rule-thickness" property

    • getLeaderAlignment

      public int getLeaderAlignment()
      Returns:
      the "leader-alignment" property

    • getLeaderLength

      public LengthRangeProperty getLeaderLength()
      Returns:
      the "leader-length" property

    • getLeaderPattern

      public int getLeaderPattern()
      Returns:
      the "leader-pattern" property

    • getLeaderPatternWidth

      public Length getLeaderPatternWidth()
      Returns:
      the "leader-pattern-width" property

    • 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

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

    • startOfNode

      public void startOfNode() throws FOPException
      Description copied from class: FObj
      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
      Description copied from class: FObjMixed
      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 FObjMixed
      Throws:
      FOPException - FOP Exception

    • 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