fop 0.95

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
Direct Known Subclasses:
AbstractTextArea, 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 inlines
          The list of inline areas added to this inline parent.
 
Fields inherited from class org.apache.fop.area.inline.InlineArea
adjustingInfo, offset
 
Fields inherited from class org.apache.fop.area.Area
bpd, BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, ipd, log, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, props, RL, TB
 
Fields inherited from class org.apache.fop.area.AreaTreeObject
foreignAttributes
 
Constructor Summary
InlineParent()
          Create a new inline parent to add areas to.
 
Method Summary
 void addChildArea(Area childArea)
          Override generic Area method.
 boolean applyVariationFactor(double variationFactor, int lineStretch, int lineShrink)
          recursively apply the variation factor to all descendant areas
 java.util.List getChildAreas()
          Get the child areas for this inline parent.
 
Methods inherited from class org.apache.fop.area.inline.InlineArea
getAdjustingInfo, getOffset, getParentArea, handleIPDVariation, hasLineThrough, hasOverline, hasUnderline, increaseIPD, isBlinking, notifyIPDVariation, setAdjustingInfo, setAdjustment, setOffset, setParentArea
 
Methods inherited from class org.apache.fop.area.Area
addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString
 
Methods inherited from class org.apache.fop.area.AreaTreeObject
getForeignAttributes, getForeignAttributeValue, setForeignAttribute, setForeignAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

inlines

protected java.util.List 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.

Constructor Detail

InlineParent

public InlineParent()
Create a new inline parent to add areas to.

Method Detail

addChildArea

public void addChildArea(Area childArea)
Override generic Area method.

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

getChildAreas

public java.util.List 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

fop 0.95

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