|
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.BlockContainerLayoutManager
public class BlockContainerLayoutManager
LayoutManager for a block-container FO.
| Nested Class Summary |
|---|
| 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 | |
|---|---|
BlockContainerLayoutManager(BlockContainer node)
Create a new block container layout manager. |
|
| Method Summary | |
|---|---|
void |
addAreas(PositionIterator parentIter,
LayoutContext layoutContext)
Tell the layout manager to add all the child areas implied by Position objects which will be returned by the Iterator. |
void |
addChildArea(Area childArea)
Add the child to the block container. |
void |
discardSpace(KnuthGlue spaceGlue)
Discard space. |
protected void |
flush()
Force current area to be added to parent area. |
protected BlockContainer |
getBlockContainerFO()
|
protected CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
Returns the CommonBorderPaddingBackground instance from the FO handled by this layout manager. |
int |
getContentAreaBPD()
Returns the BPD of the content area |
boolean |
getGeneratesBlockArea()
Returns an indication if the layout manager generates a block area. |
boolean |
getGeneratesReferenceArea()
Returns an indication if the layout manager generates a reference area. |
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. |
java.util.List |
getNextKnuthElements(LayoutContext context,
int alignment)
Get a sequence of KnuthElements representing the content of the node assigned to the LM. |
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)
Get the parent area for children of this block container. |
protected int |
getRotatedIPD()
|
boolean |
handleOverflow(int milliPoints)
Whether this LM can handle horizontal overflow error messages (only a BlockContainerLayoutManager can). |
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. |
protected LayoutContext |
makeChildLayoutContext(LayoutContext context)
Overridden to handle writing-mode, and different stack limit setup. |
int |
negotiateBPDAdjustment(int adj,
KnuthElement lastElement)
Negotiate BPD adjustment. |
| Methods inherited from class org.apache.fop.layoutmgr.SpacedBorderedPaddedBlockLayoutManager |
|---|
getBaselineOffset, notifyBorder, notifyPadding, notifySpace |
| Methods inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
|---|
getAncestorBlockAreaBPD, getAncestorBlockAreaIPD, getBaseLength, getFObj, getGeneratesLineArea, 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.BreakOpportunity |
|---|
getBreakBefore |
| Methods inherited from interface org.apache.fop.layoutmgr.LayoutManager |
|---|
addChildLM, addChildLMs, createNextChildLMs, getChildLMs, getFObj, getGeneratesLineArea, getParent, getPSLM, hasLineAreaDescendant, isFinished, notifyPos, setFinished, setParent |
| Methods inherited from interface org.apache.fop.datatypes.PercentBaseContext |
|---|
getBaseLength |
| Constructor Detail |
|---|
public BlockContainerLayoutManager(BlockContainer node)
node - block-container node to create the layout manager for.| Method Detail |
|---|
public void initialize()
initialize in interface LayoutManagerinitialize in class AbstractLayoutManagerprotected CommonBorderPaddingBackground getCommonBorderPaddingBackground()
SpacedBorderedPaddedBlockLayoutManagerCommonBorderPaddingBackground instance from the FO handled by this layout manager.
getCommonBorderPaddingBackground in class SpacedBorderedPaddedBlockLayoutManagerprotected int getRotatedIPD()
public int getContentAreaBPD()
getContentAreaBPD in interface LayoutManagergetContentAreaBPD in class BlockStackingLayoutManager
public java.util.List getNextKnuthElements(LayoutContext context,
int alignment)
getNextKnuthElements in interface LayoutManagergetNextKnuthElements in class BlockStackingLayoutManagercontext - the LayoutContext used to store layout informationalignment - the desired text alignment
protected LayoutContext makeChildLayoutContext(LayoutContext context)
LayoutContext to pass to the child LM
makeChildLayoutContext in class BlockStackingLayoutManagercontext - the parent LayoutContext
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
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
public void addAreas(PositionIterator parentIter,
LayoutContext layoutContext)
addAreas in interface LayoutManageraddAreas in class AbstractLayoutManagerparentIter - the position iteratorlayoutContext - the contextpublic Area getParentArea(Area childArea)
getParentArea in interface LayoutManagergetParentArea in class AbstractLayoutManagerchildArea - the child area for which the parent area is wanted
public void addChildArea(Area childArea)
addChildArea in interface LayoutManageraddChildArea in class BlockStackingLayoutManagerchildArea - the area to add: will be some block-stacked Area.protected void flush()
flush in class BlockStackingLayoutManager
public int negotiateBPDAdjustment(int adj,
KnuthElement lastElement)
negotiateBPDAdjustment in interface BlockLevelLayoutManagernegotiateBPDAdjustment in class BlockStackingLayoutManageradj - amount to adjustlastElement - the last knuth element
public void discardSpace(KnuthGlue spaceGlue)
discardSpace in interface BlockLevelLayoutManagerdiscardSpace in class BlockStackingLayoutManagerspaceGlue - the spacepublic 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 BlockStackingLayoutManagerprotected BlockContainer getBlockContainerFO()
public boolean getGeneratesReferenceArea()
getGeneratesReferenceArea in interface LayoutManagergetGeneratesReferenceArea in class AbstractBaseLayoutManagerpublic boolean getGeneratesBlockArea()
getGeneratesBlockArea in interface LayoutManagergetGeneratesBlockArea in class AbstractBaseLayoutManagerpublic boolean handleOverflow(int milliPoints)
handleOverflow in class BlockStackingLayoutManagermilliPoints - horizontal overflow
|
fop 2.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||