fop 2.2

org.apache.fop.area.inline
Class InlineParent

java.lang.Object
  extended by org.apache.fop.area.AreaTreeObject
      extended by org.apache.fop.area.Area
          extended by org.apache.fop.area.inline.InlineArea
              extended by org.apache.fop.area.inline.InlineParent
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
AbstractTextArea, BasicLinkArea, FilledArea

public class InlineParent
extends InlineArea

Inline parent area. This is an inline area that can have other inlines as children.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.fop.area.inline.InlineArea
InlineArea.InlineAdjustingInfo
 
Field Summary
protected  boolean autoSize
          Controls whether the IPD is automatically adjusted based on the area's children.
protected  java.util.List<InlineArea> inlines
          The list of inline areas added to this inline parent.
protected  int minChildOffset
          The offset of the beforest child area of this area.
 
Fields inherited from class org.apache.fop.area.inline.InlineArea
adjustingInfo, blockProgressionOffset
 
Fields inherited from class org.apache.fop.area.Area
bidiLevel, bpd, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, effectiveIPD, ipd, log, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, traits
 
Fields inherited from class org.apache.fop.area.AreaTreeObject
extensionAttachments, foreignAttributes
 
Constructor Summary
InlineParent()
           
 
Method Summary
 void addChildArea(Area c)
          Set the parent for the child area.
 boolean applyVariationFactor(double variationFactor, int lineStretch, int lineShrink)
          recursively apply the variation factor to all descendant areas
 java.util.List collectInlineRuns(java.util.List runs)
          Collection bidi inline runs.
 java.util.List<InlineArea> getChildAreas()
          Get the child areas for this inline parent.
 void resetChildrenLevel()
          Reset bidirectionality level of all children to default (-1), signalling that they will inherit the level of their parent text area.
 
Methods inherited from class org.apache.fop.area.inline.InlineArea
getAdjustingInfo, getBlockProgressionOffset, getParentArea, handleIPDVariation, hasLineThrough, hasOverline, hasUnderline, increaseIPD, isAncestor, isAncestorOrSelf, isBlinking, notifyIPDVariation, setAdjustingInfo, setAdjustingInfo, setAdjustment, setBlockProgressionOffset, setParentArea
 
Methods inherited from class org.apache.fop.area.Area
activateEffectiveIPD, addTrait, clone, getAllocBPD, getAllocIPD, getAreaClass, getBidiLevel, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getEffectiveAllocIPD, getEffectiveIPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsBoolean, getTraitAsInteger, getTraits, hasTrait, hasTraits, resetBidiLevel, setAreaClass, setBidiLevel, setBPD, setIPD, setTraits, setWritingModeTraits, toString
 
Methods inherited from class org.apache.fop.area.AreaTreeObject
addExtensionAttachment, getExtensionAttachments, getForeignAttributes, getForeignAttributeValue, hasExtensionAttachments, setExtensionAttachments, setForeignAttribute, setForeignAttributes
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

inlines

protected java.util.List<InlineArea> inlines
The list of inline areas added to this inline parent.


autoSize

protected transient boolean autoSize
Controls whether the IPD is automatically adjusted based on the area's children.


minChildOffset

protected int minChildOffset
The offset of the beforest child area of this area.

Constructor Detail

InlineParent

public InlineParent()
Method Detail

addChildArea

public void addChildArea(Area c)
Description copied from class: InlineArea
Set the parent for the child area. Add a child to this area. The default is to do nothing. Subclasses must override to do something if they can have child areas.

Overrides:
addChildArea in class InlineArea
Parameters:
c - the child area to add

getChildAreas

public java.util.List<InlineArea> getChildAreas()
Get the child areas for this inline parent.

Returns:
the list of child areas

applyVariationFactor

public boolean applyVariationFactor(double variationFactor,
                                    int lineStretch,
                                    int lineShrink)
recursively apply the variation factor to all descendant areas

Overrides:
applyVariationFactor in class InlineArea
Parameters:
variationFactor - the variation factor that must be applied to adjustments
lineStretch - the total stretch of the line
lineShrink - the total shrink of the line
Returns:
true if there is an UnresolvedArea descendant

collectInlineRuns

public java.util.List collectInlineRuns(java.util.List runs)
Description copied from class: InlineArea
Collection bidi inline runs.

Overrides:
collectInlineRuns in class InlineArea
Parameters:
runs - current list of inline runs
Returns:
modified list of inline runs, having appended new run

resetChildrenLevel

public void resetChildrenLevel()
Reset bidirectionality level of all children to default (-1), signalling that they will inherit the level of their parent text area.


fop 2.2

Copyright 1999-2017 The Apache Software Foundation. All Rights Reserved.