|
fop 2.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.fop.layoutmgr.AbstractBaseLayoutManager
org.apache.fop.layoutmgr.AbstractLayoutManager
org.apache.fop.layoutmgr.BlockStackingLayoutManager
org.apache.fop.layoutmgr.SpacedBorderedPaddedBlockLayoutManager
org.apache.fop.layoutmgr.list.ListItemLayoutManager
public class ListItemLayoutManager
LayoutManager for a list-item FO. The list item contains a list item label and a list item body.
| Nested Class Summary | |
|---|---|
class |
ListItemLayoutManager.ListItemPosition
|
| Nested classes/interfaces inherited from class org.apache.fop.layoutmgr.BlockStackingLayoutManager |
|---|
BlockStackingLayoutManager.MappingPosition |
| Field Summary |
|---|
| Fields inherited from class org.apache.fop.layoutmgr.SpacedBorderedPaddedBlockLayoutManager |
|---|
discardBorderAfter, discardBorderBefore, discardPaddingAfter, discardPaddingBefore, effSpaceAfter, effSpaceBefore |
| Fields inherited from class org.apache.fop.layoutmgr.BlockStackingLayoutManager |
|---|
adjustedSpaceAfter, adjustedSpaceBefore, bpUnit, breakBeforeServed, endIndent, firstVisibleMarkServed, foSpaceAfter, foSpaceBefore, parentArea, referenceIPD, startIndent, storedList |
| Fields inherited from class org.apache.fop.layoutmgr.AbstractLayoutManager |
|---|
childLMiter, childLMs, curChildLM, fobjIter, parentLayoutManager |
| Fields inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
|---|
fobj, generatesBlockArea, generatesReferenceArea |
| Constructor Summary | |
|---|---|
ListItemLayoutManager(ListItem node)
Create a new list item layout manager. |
|
| Method Summary | |
|---|---|
void |
addAreas(PositionIterator parentIter,
LayoutContext layoutContext)
Add the areas for the break points. |
void |
addChildArea(Area childArea)
Add the child. |
protected void |
addFirstVisibleMarks(java.util.List<ListElement> elements,
LayoutContext context,
int alignment)
Overridden to unconditionally add elements for space-before. |
int |
getBaselineOffset()
Returns the position of the dominant-baseline of this FO's first descendant line-area. |
int |
getBreakBefore()
Returns the highest priority break-before value on this layout manager or its relevant descendants. |
java.util.List |
getChangedKnuthElements(java.util.List oldList,
int alignment)
Get a sequence of KnuthElements representing the content of the node assigned to the LM, after changes have been applied In the context of line breaking, this method is called after hyphenation has been performed, in order to receive the sequence of elements representing the text together with all possible hyphenation points. |
protected CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
Returns the CommonBorderPaddingBackground instance from the FO handled by this layout manager. |
KeepProperty |
getKeepTogetherProperty()
Returns the keep-together property specified on the FObj. |
KeepProperty |
getKeepWithNextProperty()
Returns the keep-with-next property specified on the FObj. |
KeepProperty |
getKeepWithPreviousProperty()
Returns the keep-with-previous property specified on the FObj. |
protected ListItem |
getListItemFO()
Convenience method. |
java.util.List |
getNextKnuthElements(LayoutContext context,
int alignment,
java.util.Stack lmStack,
Position restartPosition,
LayoutManager restartAtLM)
Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected. |
Area |
getParentArea(Area childArea)
Return an Area which can contain the passed childArea. |
boolean |
hasLineAreaDescendant()
Whether the FO handled by this layout manager has a descendant (including itself) that will generate a line-area. |
void |
initialize()
initialize the layout manager. |
boolean |
isRestartable()
Returns true if this layout manager is able to re-generate its
Knuth elements after an IPD change. |
void |
reset()
Re-initializes this layout manager in order to re-generate its Knuth elements according to a new IPD value. |
void |
setBody(ListItemBody node)
Create a LM for the fo:list-item-body object |
void |
setLabel(ListItemLabel node)
Create a LM for the fo:list-item-label object |
| Methods inherited from class org.apache.fop.layoutmgr.SpacedBorderedPaddedBlockLayoutManager |
|---|
notifyBorder, notifyPadding, notifySpace |
| Methods inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
|---|
getAncestorBlockAreaBPD, getAncestorBlockAreaIPD, getBaseLength, getFObj, getGeneratesBlockArea, getGeneratesLineArea, getGeneratesReferenceArea, getParentAreaBPD, getParentAreaIPD, getReferenceAreaBPD, getReferenceAreaIPD, setGeneratesBlockArea, setGeneratesReferenceArea |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.apache.fop.layoutmgr.LayoutManager |
|---|
addChildLM, addChildLMs, createNextChildLMs, getChildLMs, getFObj, getGeneratesBlockArea, getGeneratesLineArea, getGeneratesReferenceArea, getParent, getPSLM, isFinished, notifyPos, setFinished, setParent |
| Methods inherited from interface org.apache.fop.datatypes.PercentBaseContext |
|---|
getBaseLength |
| Constructor Detail |
|---|
public ListItemLayoutManager(ListItem node)
node - list-item to create the layout manager for| Method Detail |
|---|
protected CommonBorderPaddingBackground getCommonBorderPaddingBackground()
SpacedBorderedPaddedBlockLayoutManagerCommonBorderPaddingBackground instance from the FO handled by this layout manager.
getCommonBorderPaddingBackground in class SpacedBorderedPaddedBlockLayoutManagerprotected ListItem getListItemFO()
public void setLabel(ListItemLabel node)
node - the fo:list-item-label FOpublic void setBody(ListItemBody node)
node - the fo:list-item-body FOpublic void initialize()
initialize in interface LayoutManagerinitialize in class AbstractLayoutManager
public java.util.List getNextKnuthElements(LayoutContext context,
int alignment,
java.util.Stack lmStack,
Position restartPosition,
LayoutManager restartAtLM)
getNextKnuthElements in interface LayoutManagergetNextKnuthElements in class BlockStackingLayoutManagercontext - the layout contextalignment - the alignmentlmStack - the stack of LMs that are active at the IPD changerestartPosition - the position corresponding to the element
finishing the page before the IPD changerestartAtLM - if not null, the layout manager from which to restart.
That is, the IPD change occurs between two block elements and not inside
a paragraph
protected void addFirstVisibleMarks(java.util.List<ListElement> elements,
LayoutContext context,
int alignment)
addFirstVisibleMarks in class BlockStackingLayoutManagerelements - the element listcontext - the layout contextalignment - the vertical alignment
public java.util.List getChangedKnuthElements(java.util.List oldList,
int alignment)
getChangedKnuthElements in interface LayoutManagergetChangedKnuthElements in class BlockStackingLayoutManageroldList - the elements to replacealignment - the desired text alignment
public boolean hasLineAreaDescendant()
LayoutManager
hasLineAreaDescendant in interface LayoutManagerhasLineAreaDescendant in class AbstractLayoutManagertrue if a descendant line-area will be generated, false otherwisepublic int getBaselineOffset()
LayoutManagerThe behavior of this method is undefined if this FO has no descendant
line-area, and an exception may be thrown. See LayoutManager.hasLineAreaDescendant()
getBaselineOffset in interface LayoutManagergetBaselineOffset in class SpacedBorderedPaddedBlockLayoutManagerLayoutManager.hasLineAreaDescendant()
public void addAreas(PositionIterator parentIter,
LayoutContext layoutContext)
addAreas in interface LayoutManageraddAreas in class AbstractLayoutManagerparentIter - the position iteratorlayoutContext - the layout context for adding areaspublic Area getParentArea(Area childArea)
getParentArea in interface LayoutManagergetParentArea in class AbstractLayoutManagerchildArea - the child area
public void addChildArea(Area childArea)
addChildArea in interface LayoutManageraddChildArea in class BlockStackingLayoutManagerchildArea - the child areapublic KeepProperty getKeepTogetherProperty()
IllegalStateException.
Must be implemented by the subclass, if applicable.
getKeepTogetherProperty in interface BlockLevelLayoutManagergetKeepTogetherProperty in class BlockStackingLayoutManagerpublic KeepProperty getKeepWithPreviousProperty()
IllegalStateException.
Must be implemented by the subclass, if applicable.
getKeepWithPreviousProperty in interface BlockLevelLayoutManagergetKeepWithPreviousProperty in class BlockStackingLayoutManagerpublic KeepProperty getKeepWithNextProperty()
IllegalStateException.
Must be implemented by the subclass, if applicable.
getKeepWithNextProperty in interface BlockLevelLayoutManagergetKeepWithNextProperty in class BlockStackingLayoutManagerpublic void reset()
reset in interface LayoutManagerreset in class BlockStackingLayoutManagerpublic int getBreakBefore()
BlockStackingLayoutManager
getBreakBefore in interface BreakOpportunitygetBreakBefore in class BlockStackingLayoutManagerBreakOpportunity.getBreakBefore()public boolean isRestartable()
true if this layout manager is able to re-generate its
Knuth elements after an IPD change.
isRestartable in interface LayoutManagerisRestartable in class AbstractBaseLayoutManagertrue if this layout manager can be restarted after an IPD
change
|
fop 2.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||