Package org.apache.fop.area.inline
Class InlineArea
java.lang.Object
org.apache.fop.area.AreaTreeObject
org.apache.fop.area.Area
org.apache.fop.area.inline.InlineArea
- All Implemented Interfaces:
Serializable,Cloneable
- Direct Known Subclasses:
Anchor,InlineBlockParent,InlineParent,InlineViewport,Leader,Space,SpaceArea,WordArea
Inline Area
This area is for all inline areas that can be placed
in a line area.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classthis 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
FieldsModifier and TypeFieldDescriptionprotected InlineArea.InlineAdjustingInfoThe adjustment information objectprotected intoffset position from before edge of parent areaFields 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, traitsFields inherited from class org.apache.fop.area.AreaTreeObject
extensionAttachments, foreignAttributes -
Constructor Summary
ConstructorsModifierConstructorDescriptionDefault constructor for inline area.protectedInlineArea(int blockProgressionOffset, int bidiLevel) Instantiate inline area. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddChildArea(Area childArea) Set the parent for the child area.booleanapplyVariationFactor(double variationFactor, int lineStretch, int lineShrink) recursively apply the variation factor to all descendant areascollectInlineRuns(List runs) Collection bidi inline runs.intGet the block progression offset of this inline area.voidhandleIPDVariation(int ipdVariation) Apply IPD variation.booleanbooleanbooleanvoidincreaseIPD(int ipd) Increase the inline progression dimensions of this area.booleanisAncestor(InlineArea ia) Determine if inline area IA is an ancestor inline area of this area.booleanDetermine if inline area IA is an ancestor inline area or same as this area.booleanprotected voidnotifyIPDVariation(int ipdVariation) notify the parent area about the ipd variation of this area or of a descendant areavoidsetAdjustingInfo(int stretch, int shrink, int adjustment) Create a new adjustment information objectvoidsetAdjustingInfo(InlineArea.InlineAdjustingInfo adjustingInfo) Sets the adjustment information from an existing objectvoidsetAdjustment(int adjustment) Modify the adjustment value in the adjustment information objectvoidsetBlockProgressionOffset(int blockProgressionOffset) Set the block progression offset of this inline area.voidsetParentArea(Area parentArea) Methods inherited from class org.apache.fop.area.Area
activateEffectiveIPD, addTrait, clone, getAllocBPD, getAllocIPD, getAreaClass, getBidiLevel, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getChangeBarList, getEffectiveAllocIPD, getEffectiveIPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsBoolean, getTraitAsInteger, getTraits, hasTrait, hasTraits, isFromFootnote, resetBidiLevel, setAreaClass, setBidiLevel, setBPD, setChangeBarList, setFromFootnote, setIPD, setTraits, setWritingModeTraits, toStringMethods inherited from class org.apache.fop.area.AreaTreeObject
addExtensionAttachment, getExtensionAttachments, getForeignAttributes, getForeignAttributeValue, hasExtensionAttachments, setExtensionAttachments, setForeignAttribute, setForeignAttributes
-
Field Details
-
blockProgressionOffset
protected int blockProgressionOffsetoffset position from before edge of parent area -
adjustingInfo
The adjustment information object
-
-
Constructor Details
-
InlineArea
public InlineArea()Default constructor for inline area. -
InlineArea
protected InlineArea(int blockProgressionOffset, int bidiLevel) Instantiate inline area.- Parameters:
blockProgressionOffset- a block progression offset or zerobidiLevel- a resolved bidi level or -1
-
-
Method Details
-
getAdjustingInfo
- Returns:
- the adjustment information object
-
setAdjustingInfo
public void setAdjustingInfo(int stretch, int shrink, int adjustment) Create a new adjustment information object- Parameters:
stretch- the available space for stretchingshrink- the available space for shrinkingadjustment- space adjustment type
-
setAdjustingInfo
Sets the adjustment information from an existing object- Parameters:
adjustingInfo- the existing adjustment object
-
setAdjustment
public void setAdjustment(int adjustment) Modify the adjustment value in the adjustment information object- Parameters:
adjustment- the new adjustment value
-
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
-
setBlockProgressionOffset
public void setBlockProgressionOffset(int blockProgressionOffset) Set the block progression 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:
blockProgressionOffset- the offset
-
getBlockProgressionOffset
public int getBlockProgressionOffset()Get the block progression offset of this inline area. This returns the offset of the inline area relative to the before edge of the parent area.- Returns:
- the blockProgressionOffset
-
setParentArea
- Parameters:
parentArea- The parentArea to set.
-
getParentArea
- Returns:
- Returns the parentArea.
-
addChildArea
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:
addChildAreain classArea- Parameters:
childArea- the child area to add
-
hasUnderline
public boolean hasUnderline()- Returns:
- true if the inline area is underlined.
-
hasOverline
public boolean hasOverline()- Returns:
- true if the inline area is overlined.
-
hasLineThrough
public boolean hasLineThrough()- Returns:
- true if the inline area has a line through.
-
isBlinking
public boolean isBlinking()- Returns:
- true if the inline area is blinking.
-
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 adjustmentslineStretch- the total stretch of the linelineShrink- the total shrink of the line- Returns:
- true if there is an UnresolvedArea descendant
-
handleIPDVariation
public void handleIPDVariation(int ipdVariation) Apply IPD variation.- Parameters:
ipdVariation- the variation
-
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
-
collectInlineRuns
Collection bidi inline runs.- Parameters:
runs- current list of inline runs- Returns:
- modified list of inline runs, having appended new run
-
isAncestorOrSelf
Determine if inline area IA is an ancestor inline area or same as this area.- Parameters:
ia- inline area to test- Returns:
- true if specified inline area is an ancestor or same as this area
-
isAncestor
Determine if inline area IA is an ancestor inline area of this area.- Parameters:
ia- inline area to test- Returns:
- true if specified inline area is an ancestor of this area
-