|
fop 1.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.FlowLayoutManager
public class FlowLayoutManager
LayoutManager for an fo:flow object. Its parent LM is the PageSequenceLayoutManager. This LM is responsible for getting columns of the appropriate size and filling them with block-level areas generated by its children. TODO Reintroduce emergency counter (generate error to avoid endless loop)
| 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.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 | |
|---|---|
FlowLayoutManager(PageSequenceLayoutManager pslm,
Flow node)
This is the top level 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 child area to a the correct container, depending on its area class. |
void |
discardSpace(KnuthGlue spaceGlue)
Discard space. |
java.util.List<KnuthElement> |
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. |
int |
getContentAreaBPD()
Returns the BPD of the content area |
int |
getContentAreaIPD()
Returns the IPD of the content area |
Keep |
getKeepTogether()
Returns the keep-together strength for this element. |
Keep |
getKeepWithNext()
Returns the keep-with-next strength for this element. |
Keep |
getKeepWithPrevious()
Returns the keep-with-previous strength for this element. |
protected java.util.List<ListElement> |
getNextChildElements(LayoutManager childLM,
LayoutContext context,
LayoutContext childLC,
int alignment,
java.util.Stack<LayoutManager> lmStack,
Position restartPosition,
LayoutManager restartLM)
Overridden to wrap the child positions before returning the list Gets the next set of child elements for the given childLM. |
java.util.List |
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. |
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 take into account the current page-master's writing-mode Creates and initializes a LayoutContext to pass to the child LM |
int |
negotiateBPDAdjustment(int adj,
KnuthElement lastElement)
Negotiate BPD adjustment. |
| Methods inherited from class org.apache.fop.layoutmgr.AbstractLayoutManager |
|---|
addChildLM, addChildLMs, addId, addMarkersToPage, checkEndOfLayout, createChildLMs, createNextChildLMs, getChildLM, getChildLMs, getCurrentPage, getCurrentPV, getParent, getPSLM, hasNextChildLM, initialize, isFinished, isFirst, isLast, notifyEndOfLayout, notifyPos, setCurrentChildLM, setFinished, setParent, toString, transferExtensionAttachments, transferExtensions, transferForeignAttributes |
| 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.BlockLevelLayoutManager |
|---|
getKeepTogetherProperty, getKeepWithNextProperty, getKeepWithPreviousProperty, mustKeepTogether, mustKeepWithNext, mustKeepWithPrevious |
| Methods inherited from interface org.apache.fop.layoutmgr.LayoutManager |
|---|
addChildLM, addChildLMs, createNextChildLMs, getChildLMs, getFObj, getGeneratesBlockArea, getGeneratesLineArea, getGeneratesReferenceArea, getNextKnuthElements, getParent, getPSLM, initialize, isFinished, notifyPos, reset, setFinished, setParent |
| Methods inherited from interface org.apache.fop.datatypes.PercentBaseContext |
|---|
getBaseLength |
| Constructor Detail |
|---|
public FlowLayoutManager(PageSequenceLayoutManager pslm,
Flow node)
pslm - parent PageSequenceLayoutManager objectnode - Flow object| Method Detail |
|---|
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
protected java.util.List<ListElement> getNextChildElements(LayoutManager childLM,
LayoutContext context,
LayoutContext childLC,
int alignment,
java.util.Stack<LayoutManager> lmStack,
Position restartPosition,
LayoutManager restartLM)
childLM.getNextKnuthElements(),
passing it all relevant parameters.
getNextChildElements in class BlockStackingLayoutManagerchildLM - the current child LMcontext - the layout contextchildLC - the child layout contextalignment - the vertical alignmentlmStack - the stack of currently active LMs (if any)restartPosition - the position to restart from (if any)restartLM - the LM to restart from (if any)
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 Keep getKeepTogether()
getKeepTogether in interface BlockLevelLayoutManagergetKeepTogether in class BlockStackingLayoutManagerpublic Keep getKeepWithNext()
getKeepWithNext in interface BlockLevelLayoutManagergetKeepWithNext in class BlockStackingLayoutManagerpublic Keep getKeepWithPrevious()
getKeepWithPrevious in interface BlockLevelLayoutManagergetKeepWithPrevious in class BlockStackingLayoutManager
public java.util.List<KnuthElement> getChangedKnuthElements(java.util.List oldList,
int alignment)
getChangedKnuthElements in interface LayoutManagergetChangedKnuthElements in class BlockStackingLayoutManageroldList - the elements to replacealignment - the desired text alignment
public void addAreas(PositionIterator parentIter,
LayoutContext layoutContext)
addAreas in interface LayoutManageraddAreas in class AbstractLayoutManagerparentIter - the position iteratorlayoutContext - the contextpublic void addChildArea(Area childArea)
addChildArea in interface LayoutManageraddChildArea in class BlockStackingLayoutManagerchildArea - the area to addpublic Area getParentArea(Area childArea)
getParentArea in interface LayoutManagergetParentArea in class AbstractLayoutManagerchildArea - the child area for which the parent area is wanted
public int getContentAreaIPD()
getContentAreaIPD in interface LayoutManagergetContentAreaIPD in class BlockStackingLayoutManagerpublic int getContentAreaBPD()
getContentAreaBPD in interface LayoutManagergetContentAreaBPD in class BlockStackingLayoutManagerpublic 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 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||