Package org.apache.fop.fo.flow

Class InlineContainer

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.flow.InlineContainer
All Implemented Interfaces:
Cloneable, Constants
public class InlineContainer extends FObj

  • Constructor Details

    • InlineContainer

      public InlineContainer(FONode parent)
      Creates a new instance.
      Parameters:
      parent - the parent of this inline-container

  • Method Details

    • bind

      public void bind(PropertyList pList) throws FOPException
      Description copied from class: FObj
      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

    • 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: marker* (%block;)+
      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

    • endOfNode

      public void endOfNode() throws FOPException
      Description copied from class: FObj
      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

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

    • getInlineProgressionDimension

      public LengthRangeProperty getInlineProgressionDimension()

    • getBlockProgressionDimension

      public LengthRangeProperty getBlockProgressionDimension()

    • getOverflow

      public int getOverflow()

    • getCommonBorderPaddingBackground

      public CommonBorderPaddingBackground getCommonBorderPaddingBackground()

    • getCommonMarginInline

      public CommonMarginInline getCommonMarginInline()

    • getReferenceOrientation

      public int getReferenceOrientation()

    • getDisplayAlign

      public int getDisplayAlign()

    • getKeepWithPrevious

      public KeepProperty getKeepWithPrevious()

    • getKeepTogether

      public KeepProperty getKeepTogether()

    • getKeepWithNext

      public KeepProperty getKeepWithNext()

    • getLineHeight

      public SpaceProperty getLineHeight()

    • getAlignmentAdjust

      public Length getAlignmentAdjust()

    • getAlignmentBaseline

      public int getAlignmentBaseline()

    • getBaselineShift

      public Length getBaselineShift()

    • getDominantBaseline

      public int getDominantBaseline()

    • getWritingMode

      public WritingMode getWritingMode()

    • getExplicitWritingMode

      public boolean getExplicitWritingMode()
      Obtain writing mode explicit indicator.
      Returns:
      the writing mode explicit indicator

    • getInlineProgressionDirection

      public Direction getInlineProgressionDirection()

    • getBlockProgressionDirection

      public Direction getBlockProgressionDirection()

    • getColumnProgressionDirection

      public Direction getColumnProgressionDirection()

    • getRowProgressionDirection

      public Direction getRowProgressionDirection()

    • getShiftDirection

      public Direction getShiftDirection()

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

    • generatesReferenceAreas

      public boolean generatesReferenceAreas()
      Description copied from class: FObj
      Check if this formatting object generates reference areas.
      Overrides:
      generatesReferenceAreas in class FObj
      Returns:
      true if generates reference areas TODO see if needed

    • isBidiBoundary

      protected boolean isBidiBoundary(boolean propagate)
      Overrides:
      isBidiBoundary in class FObj