org.apache.fop.area.inline

Class FilledArea

java.lang.Object

org.apache.fop.area.AreaTreeObject

org.apache.fop.area.Area

org.apache.fop.area.inline.InlineArea

org.apache.fop.area.inline.InlineParent

org.apache.fop.area.inline.FilledArea

All Implemented Interfaces:

java.io.Serializable

public class FilledArea
extends InlineParent

Filled area. This inline area contains some inline areas. When the renderer gets the child areas to render the inline areas are repeated to fill the ipd of this inline parent. This extends InlineParent so that the renderer will render this as a normal inline parent.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.fop.area.inline.InlineArea

InlineArea.InlineAdjustingInfo

Field Summary

Fields inherited from class org.apache.fop.area.inline.InlineParent

autoSize, inlines

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

Constructors

Constructor and Description
FilledArea() Create a new filled area.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applyVariationFactor(double variationFactor, int lineStretch, int lineShrink) recursively apply the variation factor to all descendant areas
int	getBPD() Get the block progression dimension of the content rectangle for this area.
java.util.List	getChildAreas() Get the child areas for this filled area.
int	getUnitWidth() Return the unit width for the areas to fill the full width.
void	setUnitWidth(int w) Set the unit width for the areas to fill the full width.

Methods inherited from class org.apache.fop.area.inline.InlineParent

addChildArea

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, 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

Constructor Detail

FilledArea

public FilledArea()

Create a new filled area.

Method Detail

setUnitWidth

public void setUnitWidth(int w)

Set the unit width for the areas to fill the full width.

Parameters:

w - the unit width

getUnitWidth

public int getUnitWidth()

Return the unit width for the areas to fill the full width.

Returns:

the unit width

getBPD

public int getBPD()

Get the block progression dimension of the content rectangle for this area.

Overrides:

getBPD in class Area

Returns:

the block progression dimension

See Also:

bpd

getChildAreas

public java.util.List getChildAreas()

Get the child areas for this filled area. This copies the references of the inline areas so that it fills the total width of the area a whole number of times for the unit width.

Overrides:

getChildAreas in class InlineParent

Returns:

the list of child areas copied to fill the width

applyVariationFactor

public boolean applyVariationFactor(double variationFactor,
                           int lineStretch,
                           int lineShrink)

recursively apply the variation factor to all descendant areas

Overrides:

applyVariationFactor in class InlineParent

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