|
fop 0.94 | |||||||||
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.BlockLayoutManager
public class BlockLayoutManager
LayoutManager for a block FO.
Nested Class Summary | |
---|---|
protected class |
BlockLayoutManager.ProxyLMiter
Proxy iterator for Block LM. |
Nested classes/interfaces inherited from class org.apache.fop.layoutmgr.BlockStackingLayoutManager |
---|
BlockStackingLayoutManager.MappingPosition, BlockStackingLayoutManager.StackingIter |
Field Summary | |
---|---|
protected java.util.List |
childBreaks
The list of child BreakPoss instances. |
protected java.util.ListIterator |
proxyLMiter
Iterator over the child layout managers. |
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, markers, parentLM |
Fields inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
---|
fobj, generatesBlockArea, generatesReferenceArea |
Fields inherited from interface org.apache.fop.layoutmgr.BlockLevelLayoutManager |
---|
LINE_HEIGHT_ADJUSTMENT, LINE_NUMBER_ADJUSTMENT, NO_ADJUSTMENT, SPACE_AFTER_ADJUSTMENT, SPACE_BEFORE_ADJUSTMENT |
Constructor Summary | |
---|---|
BlockLayoutManager(Block inBlock)
Creates a new BlockLayoutManager. |
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 childArea to the current area. |
boolean |
createNextChildLMs(int pos)
Create more child LMs of the parent, up to child LM index pos |
protected void |
flush()
Force current area to be added to parent area. |
protected Block |
getBlockFO()
convenience method that returns the Block node |
int |
getContentAreaBPD()
Returns the BPD of the content area |
int |
getContentAreaIPD()
Returns the IPD of the content area |
boolean |
getGeneratesBlockArea()
Returns an indication if the layout manager generates a block area. |
java.util.LinkedList |
getNextKnuthElements(LayoutContext context,
int alignment)
Get a sequence of KnuthElements representing the content of the node assigned to the LM |
Area |
getParentArea(Area childArea)
Return an Area which can contain the passed childArea. |
void |
initialize()
initialize the layout manager. |
boolean |
mustKeepTogether()
|
boolean |
mustKeepWithNext()
|
boolean |
mustKeepWithPrevious()
|
void |
notifyBorder(RelSide side,
MinOptMax effectiveLength)
Notifies the layout manager about the effective length/width of its border. |
void |
notifyPadding(RelSide side,
MinOptMax effectiveLength)
Notifies the layout manager about the effective length/width of its padding. |
void |
notifySpace(RelSide side,
MinOptMax effectiveLength)
Notifies the layout manager about the effective length of its space. |
void |
resetPosition(Position resetPos)
Reset to the position. |
Methods inherited from class org.apache.fop.layoutmgr.AbstractLayoutManager |
---|
addChildLM, addChildLMs, createChildLMs, getChildLM, getChildLMs, getCurrentPage, getCurrentPV, getParent, getPSLM, hasNextChildLM, isFinished, isFirst, isLast, notifyPos, reset, setFinished, setParent, transferForeignAttributes |
Methods inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
---|
getAncestorBlockAreaBPD, getAncestorBlockAreaIPD, getBaseLength, getFObj, getGeneratesLineArea, getGeneratesReferenceArea, getParentAreaBPD, getParentAreaIPD, getReferenceAreaBPD, getReferenceAreaIPD, setGeneratesBlockArea, setGeneratesReferenceArea |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.fop.layoutmgr.LayoutManager |
---|
addChildLM, addChildLMs, getChildLMs, getFObj, getGeneratesLineArea, getGeneratesReferenceArea, getParent, getPSLM, isFinished, notifyPos, setFinished, setParent |
Methods inherited from interface org.apache.fop.datatypes.PercentBaseContext |
---|
getBaseLength |
Field Detail |
---|
protected java.util.ListIterator proxyLMiter
protected java.util.List childBreaks
Constructor Detail |
---|
public BlockLayoutManager(Block inBlock)
inBlock
- the block FO object to create the layout manager for.Method Detail |
---|
public void initialize()
LayoutManager
initialize
in interface LayoutManager
initialize
in class AbstractLayoutManager
LayoutManager.initialize()
public java.util.LinkedList getNextKnuthElements(LayoutContext context, int alignment)
LayoutManager
getNextKnuthElements
in interface LayoutManager
getNextKnuthElements
in class BlockStackingLayoutManager
context
- the LayoutContext used to store layout informationalignment
- the desired text alignement
BlockStackingLayoutManager
public boolean createNextChildLMs(int pos)
LayoutManager
createNextChildLMs
in interface LayoutManager
createNextChildLMs
in class AbstractLayoutManager
pos
- index up to which child LMs are requested
LayoutManager.createNextChildLMs(int)
public boolean mustKeepTogether()
mustKeepTogether
in interface BlockLevelLayoutManager
mustKeepTogether
in class BlockStackingLayoutManager
BlockLevelLayoutManager.mustKeepTogether()
public boolean mustKeepWithPrevious()
mustKeepWithPrevious
in interface BlockLevelLayoutManager
mustKeepWithPrevious
in class BlockStackingLayoutManager
BlockLevelLayoutManager.mustKeepWithPrevious()
public boolean mustKeepWithNext()
mustKeepWithNext
in interface BlockLevelLayoutManager
mustKeepWithNext
in class BlockStackingLayoutManager
BlockLevelLayoutManager.mustKeepWithNext()
public void addAreas(PositionIterator parentIter, LayoutContext layoutContext)
LayoutManager
addAreas
in interface LayoutManager
addAreas
in class AbstractLayoutManager
parentIter
- the position iteratorlayoutContext
- the contextLayoutManager.addAreas(org.apache.fop.layoutmgr.PositionIterator, org.apache.fop.layoutmgr.LayoutContext)
public Area getParentArea(Area childArea)
getParentArea
in interface LayoutManager
getParentArea
in class AbstractLayoutManager
childArea
- area to get the parent area for
public void addChildArea(Area childArea)
BlockStackingLayoutManager
addChildArea
in interface LayoutManager
addChildArea
in class BlockStackingLayoutManager
childArea
- the area to add: will be some block-stacked Area.LayoutManager.addChildArea(Area)
protected void flush()
flush
in class BlockStackingLayoutManager
BlockStackingLayoutManager.flush()
public void resetPosition(Position resetPos)
LayoutManager
resetPosition
in interface LayoutManager
resetPosition
in class AbstractLayoutManager
resetPos
- the Position to reset toLayoutManager.resetPosition(org.apache.fop.layoutmgr.Position)
protected Block getBlockFO()
public int getContentAreaIPD()
getContentAreaIPD
in interface LayoutManager
getContentAreaIPD
in class BlockStackingLayoutManager
LayoutManager.getContentAreaIPD()
public int getContentAreaBPD()
getContentAreaBPD
in interface LayoutManager
getContentAreaBPD
in class BlockStackingLayoutManager
LayoutManager.getContentAreaBPD()
public boolean getGeneratesBlockArea()
LayoutManager
getGeneratesBlockArea
in interface LayoutManager
getGeneratesBlockArea
in class AbstractBaseLayoutManager
LayoutManager.getGeneratesBlockArea()
public void notifySpace(RelSide side, MinOptMax effectiveLength)
ConditionalElementListener
notifySpace
in interface ConditionalElementListener
side
- the side to which the space applieseffectiveLength
- the effective length after space-resolution (null means zero length)ConditionalElementListener
public void notifyBorder(RelSide side, MinOptMax effectiveLength)
ConditionalElementListener
notifyBorder
in interface ConditionalElementListener
side
- the side to which the border applieseffectiveLength
- the effective length in the current break situation
(null means zero length)ConditionalElementListener
public void notifyPadding(RelSide side, MinOptMax effectiveLength)
ConditionalElementListener
notifyPadding
in interface ConditionalElementListener
side
- the side to which the padding applieseffectiveLength
- the effective length in the current break situation
(null means zero length)ConditionalElementListener
|
fop 0.94 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |