Package org.apache.fop.fo.flow

Class AbstractGraphics

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.flow.AbstractGraphics
All Implemented Interfaces:
Cloneable, Constants, GraphicsProperties, CommonAccessibilityHolder, StructureTreeElementHolder
Direct Known Subclasses:
ExternalGraphic, InstreamForeignObject
public abstract class AbstractGraphics extends FObj implements GraphicsProperties, StructureTreeElementHolder, CommonAccessibilityHolder
Common base class for the fo:instream-foreign-object and fo:external-graphic flow formatting objects.

  • Constructor Details

    • AbstractGraphics

      public AbstractGraphics(FONode parent)
      constructs an instream-foreign-object object (called by Maker).
      Parameters:
      parent - the parent formatting 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

    • getCommonAccessibility

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

    • getCommonBorderPaddingBackground

      public CommonBorderPaddingBackground getCommonBorderPaddingBackground()
      Returns:
      the CommonBorderPaddingBackground

    • getLineHeight

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

    • getInlineProgressionDimension

      public LengthRangeProperty getInlineProgressionDimension()
      Specified by:
      getInlineProgressionDimension in interface GraphicsProperties
      Returns:
      the "inline-progression-dimension" property

    • getBlockProgressionDimension

      public LengthRangeProperty getBlockProgressionDimension()
      Specified by:
      getBlockProgressionDimension in interface GraphicsProperties
      Returns:
      the "block-progression-dimension" property

    • getHeight

      public Length getHeight()
      Specified by:
      getHeight in interface GraphicsProperties
      Returns:
      the "height" property

    • getWidth

      public Length getWidth()
      Specified by:
      getWidth in interface GraphicsProperties
      Returns:
      the "width" property

    • getContentHeight

      public Length getContentHeight()
      Specified by:
      getContentHeight in interface GraphicsProperties
      Returns:
      the "content-height" property

    • getContentWidth

      public Length getContentWidth()
      Specified by:
      getContentWidth in interface GraphicsProperties
      Returns:
      the "content-width" property

    • getScaling

      public int getScaling()
      Specified by:
      getScaling in interface GraphicsProperties
      Returns:
      the "scaling" property

    • getOverflow

      public int getOverflow()
      Specified by:
      getOverflow in interface GraphicsProperties
      Returns:
      the "overflow" property

    • getDisplayAlign

      public int getDisplayAlign()
      Specified by:
      getDisplayAlign in interface GraphicsProperties
      Returns:
      the "display-align" property.

    • getTextAlign

      public int getTextAlign()
      Specified by:
      getTextAlign in interface GraphicsProperties
      Returns:
      the "text-align" 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

    • getKeepWithNext

      public KeepProperty getKeepWithNext()
      Returns:
      the "keep-with-next" property

    • getKeepWithPrevious

      public KeepProperty getKeepWithPrevious()
      Returns:
      the "keep-with-previous" 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

    • getAltText

      public String getAltText()
      Returns:
      the alternative text property.

    • getIntrinsicWidth

      public abstract int getIntrinsicWidth()
      Returns:
      the graphic's intrinsic width in millipoints

    • getIntrinsicHeight

      public abstract int getIntrinsicHeight()
      Returns:
      the graphic's intrinsic height in millipoints

    • getIntrinsicAlignmentAdjust

      public abstract Length getIntrinsicAlignmentAdjust()
      Returns:
      the graphic's intrinsic alignment-adjust

    • 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