org.apache.fop.area.inline

Class InlineArea

Implemented Interfaces:
Serializable
Known Direct Subclasses:
Anchor, InlineBlockParent, InlineParent, Leader, Space, SpaceArea, Viewport, WordArea

public class InlineArea
extends Area

Inline Area This area is for all inline areas that can be placed in a line area.

Nested Class Summary

protected class
InlineArea.InlineAdjustingInfo
this class stores information about potential adjustments that can be used in order to re-compute adjustments when a page-number or a page-number-citation is resolved

Field Summary

protected InlineArea.InlineAdjustingInfo
adjustingInfo
The adjustment information object
protected int
offset
offset position from before edge of parent area

Fields inherited from class org.apache.fop.area.Area

BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, RL, TB, bpd, ipd, log, props

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Method Summary

void
addChildArea(Area childArea)
Set the parent for the child area.
boolean
applyVariationFactor(double variationFactor, int lineStretch, int lineShrink)
recursively apply the variation factor to all descendant areas
InlineArea.InlineAdjustingInfo
getAdjustingInfo()
int
getOffset()
Get the offset of this inline area.
Area
getParentArea()
void
handleIPDVariation(int ipdVariation)
boolean
hasLineThrough()
boolean
hasOverline()
boolean
hasUnderline()
void
increaseIPD(int ipd)
Increase the inline progression dimensions of this area.
boolean
isBlinking()
protected void
notifyIPDVariation(int ipdVariation)
notify the parent area about the ipd variation of this area or of a descendant area
void
setAdjustingInfo(int stretch, int shrink, int adjustment)
Create a new adjustment information object
void
setAdjustment(int adjustment)
Modify the adjustment value in the adjustment information object
void
setOffset(int offset)
Set the offset of this inline area.
void
setParentArea(Area parentArea)

Methods inherited from class org.apache.fop.area.Area

addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBPD, 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

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Field Details

adjustingInfo

protected InlineArea.InlineAdjustingInfo adjustingInfo
The adjustment information object

offset

protected int offset
offset position from before edge of parent area

Method Details

addChildArea

public void addChildArea(Area childArea)
Set the parent for the child area.
Overrides:
addChildArea in interface Area

applyVariationFactor

public boolean applyVariationFactor(double variationFactor,
                                    int lineStretch,
                                    int lineShrink)
recursively apply the variation factor to all descendant areas
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

getAdjustingInfo

public InlineArea.InlineAdjustingInfo getAdjustingInfo()
Returns:
the adjustment information object

getOffset

public int getOffset()
Get the offset of this inline area. This returns the offset of the inline area which is relative to the before edge of the parent area.
Returns:
the offset

getParentArea

public Area getParentArea()
Returns:
Returns the parentArea.

handleIPDVariation

public void handleIPDVariation(int ipdVariation)

hasLineThrough

public boolean hasLineThrough()
Returns:
true if the inline area has a line through.

hasOverline

public boolean hasOverline()
Returns:
true if the inline area is overlined.

hasUnderline

public boolean hasUnderline()
Returns:
true if the inline area is underlined.

increaseIPD

public void increaseIPD(int ipd)
Increase the inline progression dimensions of this area. This is used for inline parent areas that contain mulitple child areas.
Parameters:
ipd - the inline progression to increase by

isBlinking

public boolean isBlinking()
Returns:
true if the inline area is blinking.

notifyIPDVariation

protected void notifyIPDVariation(int ipdVariation)
notify the parent area about the ipd variation of this area or of a descendant area
Parameters:
ipdVariation - the difference between new and old ipd

setAdjustingInfo

public void setAdjustingInfo(int stretch,
                             int shrink,
                             int adjustment)
Create a new adjustment information object
Parameters:
stretch - the available space for stretching
shrink - the available space for shrinking
adjustment - space adjustment type

setAdjustment

public void setAdjustment(int adjustment)
Modify the adjustment value in the adjustment information object
Parameters:
adjustment - the new adjustment value

setOffset

public void setOffset(int offset)
Set the offset of this inline area. This is used to set the offset of the inline area which is relative to the before edge of the parent area.
Parameters:
offset - the offset

setParentArea

public void setParentArea(Area parentArea)
Parameters:
parentArea - The parentArea to set.

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