| org.apache.fop.layoutmgr.LayoutManager
All known Subclasses: org.apache.fop.layoutmgr.AbstractBaseLayoutManager,
| addAreas | | void addAreas(PositionIterator posIter, LayoutContext context)(Code) | | Tell the layout manager to add all the child areas implied
by Position objects which will be returned by the
Iterator.
Parameters:
posIter - the position iterator
Parameters:
context - the context |
| addChildArea | | void addChildArea(Area childArea)(Code) | | Add the area as a child of the current area.
This is called by child layout managers to add their
areas as children of the current area.
Parameters:
childArea - the child area to add |
| addChildLM | | void addChildLM(LayoutManager lm)(Code) | | Add the LM in the argument to the list of child LMs;
set this LM as the parent;
initialize the LM.
Parameters:
lm - the LM to be added |
| addChildLMs | | void addChildLMs(List newLMs)(Code) | | Add the LMs in the argument to the list of child LMs;
Parameters:
newLMs - the list of LMs to be added |
| createNextChildLMs | | boolean createNextChildLMs(int pos)(Code) | | Create more child LMs of the parent, up to child LM index pos
Parameters:
pos - index up to which child LMs are requested true if requested index does exist |
| getChangedKnuthElements | | LinkedList getChangedKnuthElements(List oldList, int alignment)(Code) | | 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 possibile 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.
Parameters:
oldList - the elements to replace
Parameters:
alignment - the desired text alignment the updated list of KnuthElements |
| getChildLMs | | List getChildLMs()(Code) | | the list of child LMs |
| getContentAreaBPD | | int getContentAreaBPD()(Code) | | Returns the BPD of the content area
the BPD of the content area |
| getContentAreaIPD | | int getContentAreaIPD()(Code) | | Returns the IPD of the content area
the IPD of the content area |
| getFObj | | FObj getFObj()(Code) | | Returns the fo this layout manager is associated with.
The fo for this layout manager or null. |
| getGeneratesBlockArea | | boolean getGeneratesBlockArea()(Code) | | Returns an indication if the layout manager generates a block area.
True if the layout manager generates a block area |
| getGeneratesLineArea | | boolean getGeneratesLineArea()(Code) | | Returns an indication if the layout manager generates a line area.
True if the layout manager generates a line area |
| getGeneratesReferenceArea | | boolean getGeneratesReferenceArea()(Code) | | Returns an indication if the layout manager generates a reference area.
True if the layout manager generates a reference area |
| getNextKnuthElements | | LinkedList getNextKnuthElements(LayoutContext context, int alignment)(Code) | | Get a sequence of KnuthElements representing the content
of the node assigned to the LM
Parameters:
context - the LayoutContext used to store layout information
Parameters:
alignment - the desired text alignement the list of KnuthElements |
| getParent | | LayoutManager getParent()(Code) | | Get the parent layout manager.
the parent layout manager. |
| getParentArea | | Area getParentArea(Area childArea)(Code) | | Get the parent area for an area.
This should get the parent depending on the class of the
area passed in.
Parameters:
childArea - the child area to get the parent for the parent Area |
| initialize | | void initialize()(Code) | | initialize the layout manager. Allows each layout manager
to calculate often used values.
|
| isFinished | | boolean isFinished()(Code) | | Return a value indicating whether this LayoutManager has laid out
all its content (or generated BreakPossibilities for all content.)
true if this layout manager is finished |
| notifyPos | | Position notifyPos(Position pos)(Code) | | Adds a Position to the Position participating in the first|last determination by assigning
it a unique position index.
Parameters:
pos - the Position the same Position but with a position index |
| resetPosition | | void resetPosition(Position position)(Code) | | Reset to the position.
Parameters:
position - the Position to reset to |
| setFinished | | void setFinished(boolean isFinished)(Code) | | Set a flag indicating whether the LayoutManager has laid out all
its content. This is generally called by the LM itself, but can
be called by a parentLM when backtracking.
Parameters:
isFinished - the value to set the finished flag to |
| setParent | | void setParent(LayoutManager lm)(Code) | | Set the parent layout manager.
The parent layout manager is required for adding areas.
Parameters:
lm - the parent layout manager |
|
|