|
fop 1.0 | ||||||||||
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
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.
Nested Class Summary |
Nested classes inherited from class org.apache.fop.layoutmgr.BlockStackingLayoutManager |
BlockStackingLayoutManager.MappingPosition, BlockStackingLayoutManager.StackingIter |
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)
|
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. For example, if the text "representation" originates a single box element when getNextKnuthElements() is called, it will be now split in syllables (rep-re-sen-ta-tion) each one originating a box and divided by additional elements allowing a line break. In the context of page breaking, this method is called only if the pages need to be "vertically justified" modifying (also) the quantity of lines created by the paragraphs, and after a first page breaking has been performed. According to the result of the first page breaking, each paragraph now knows how many lines it must create (among the existing layout possibilities) and has to create a sequence of elements representing this layout; in particular, each box, representing a line, will contain a LineBreakPositions that will be used in the addAreas() phase. LMs having children look at the old list of elements in order to know which ones they must get the new elements from, as break conditions of preserved linefeeds can divide children into smaller groups (page sequences or paragraphs). LMs having no children can simply return the old elements if they have nothing to change. Inline LMs need to know the text alignment because it affects the elements representing feasible breaks between syllables. |
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. |
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,
Position positionAtIPDChange,
LayoutManager restartAtLM)
{@inheritDoc} |
Area |
getParentArea(Area childArea)
Return an Area which can contain the passed childArea. The childArea may not yet have any content, but it has essential traits set. In general, if the LayoutManager already has an Area it simply returns it. Otherwise, it makes a new Area of the appropriate class. It gets a parent area for its area by calling its parent LM. Finally, based on the dimensions of the parent area, it initializes its own area. This includes setting the content IPD and the maximum BPD. |
boolean |
isRestartable()
Returns if this layout manager is able to re-generate its Knuth elements after an IPD change. |
int |
negotiateBPDAdjustment(int adj,
KnuthElement lastElement)
|
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, 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 objectMethod Detail |
public java.util.List getNextKnuthElements(LayoutContext context, int alignment)
getNextKnuthElements
in interface LayoutManager
getNextKnuthElements
in class BlockStackingLayoutManager
public java.util.List getNextKnuthElements(LayoutContext context, int alignment, Position positionAtIPDChange, LayoutManager restartAtLM)
public int negotiateBPDAdjustment(int adj, KnuthElement lastElement)
negotiateBPDAdjustment
in interface BlockLevelLayoutManager
negotiateBPDAdjustment
in class BlockStackingLayoutManager
public void discardSpace(KnuthGlue spaceGlue)
discardSpace
in interface BlockLevelLayoutManager
discardSpace
in class BlockStackingLayoutManager
public Keep getKeepTogether()
getKeepTogether
in interface BlockLevelLayoutManager
getKeepTogether
in class BlockStackingLayoutManager
public Keep getKeepWithNext()
getKeepWithNext
in interface BlockLevelLayoutManager
getKeepWithNext
in class BlockStackingLayoutManager
public Keep getKeepWithPrevious()
getKeepWithPrevious
in interface BlockLevelLayoutManager
getKeepWithPrevious
in class BlockStackingLayoutManager
public java.util.List getChangedKnuthElements(java.util.List oldList, int alignment)
getChangedKnuthElements
in interface LayoutManager
getChangedKnuthElements
in class BlockStackingLayoutManager
public void addAreas(PositionIterator parentIter, LayoutContext layoutContext)
addAreas
in interface LayoutManager
addAreas
in class AbstractLayoutManager
public void addChildArea(Area childArea)
addChildArea
in interface LayoutManager
addChildArea
in class BlockStackingLayoutManager
childArea
- the area to addpublic Area getParentArea(Area childArea)
getParentArea
in interface LayoutManager
getParentArea
in class AbstractLayoutManager
childArea
- the child area for which the parent area is wanted
public int getContentAreaIPD()
getContentAreaIPD
in interface LayoutManager
getContentAreaIPD
in class BlockStackingLayoutManager
public int getContentAreaBPD()
getContentAreaBPD
in interface LayoutManager
getContentAreaBPD
in class BlockStackingLayoutManager
public boolean isRestartable()
isRestartable
in interface LayoutManager
isRestartable
in class AbstractBaseLayoutManager
|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |