|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LayoutManager
The interface for all LayoutManagers.
Method Summary | |
---|---|
void |
addAreas(PositionIterator posIter,
LayoutContext context)
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 area as a child of the current area. |
void |
addChildLM(LayoutManager lm)
Add the LM in the argument to the list of child LMs; set this LM as the parent; initialize the LM. |
void |
addChildLMs(java.util.List newLMs)
Add the LMs in the argument to the list of child LMs; |
boolean |
createNextChildLMs(int pos)
Create more child LMs of the parent, up to child LM index pos |
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. |
java.util.List |
getChildLMs()
|
int |
getContentAreaBPD()
Returns the BPD of the content area |
int |
getContentAreaIPD()
Returns the IPD of the content area |
FObj |
getFObj()
Returns the fo this layout manager is associated with. |
boolean |
getGeneratesBlockArea()
Returns an indication if the layout manager generates a block area. |
boolean |
getGeneratesLineArea()
Returns an indication if the layout manager generates a line area. |
boolean |
getGeneratesReferenceArea()
Returns an indication if the layout manager generates a reference area. |
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 positionAtIPDChange,
LayoutManager restartAtLM)
Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected. |
LayoutManager |
getParent()
Get the parent layout manager. |
Area |
getParentArea(Area childArea)
Get the parent area for an area. |
PageSequenceLayoutManager |
getPSLM()
Get the active PageSequenceLayoutManager instance for this layout process. |
void |
initialize()
initialize the layout manager. |
boolean |
isFinished()
Return a value indicating whether this LayoutManager has laid out all its content (or generated BreakPossibilities for all content.) |
boolean |
isRestartable()
Returns true if this layout manager is able to re-generate its
Knuth elements after an IPD change. |
Position |
notifyPos(Position pos)
Adds a Position to the Position participating in the first|last determination by assigning it a unique position index. |
void |
reset()
Re-initializes this layout manager in order to re-generate its Knuth elements according to a new IPD value. |
void |
setFinished(boolean isFinished)
Set a flag indicating whether the LayoutManager has laid out all its content. |
void |
setParent(LayoutManager lm)
Set the parent layout manager. |
Methods inherited from interface org.apache.fop.datatypes.PercentBaseContext |
---|
getBaseLength |
Method Detail |
---|
void setParent(LayoutManager lm)
lm
- the parent layout managerLayoutManager getParent()
void initialize()
PageSequenceLayoutManager getPSLM()
boolean isFinished()
void setFinished(boolean isFinished)
isFinished
- the value to set the finished flag toArea getParentArea(Area childArea)
childArea
- the child area to get the parent for
void addChildArea(Area childArea)
childArea
- the child area to addvoid addAreas(PositionIterator posIter, LayoutContext context)
posIter
- the position iteratorcontext
- the contextboolean createNextChildLMs(int pos)
pos
- index up to which child LMs are requested
java.util.List getChildLMs()
void addChildLM(LayoutManager lm)
lm
- the LM to be addedvoid addChildLMs(java.util.List newLMs)
newLMs
- the list of LMs to be addedjava.util.List getNextKnuthElements(LayoutContext context, int alignment)
context
- the LayoutContext used to store layout informationalignment
- the desired text alignment
java.util.List getChangedKnuthElements(java.util.List oldList, int alignment)
oldList
- the elements to replacealignment
- the desired text alignment
int getContentAreaIPD()
int getContentAreaBPD()
boolean getGeneratesReferenceArea()
boolean getGeneratesBlockArea()
boolean getGeneratesLineArea()
FObj getFObj()
Position notifyPos(Position pos)
pos
- the Position
void reset()
boolean isRestartable()
true
if this layout manager is able to re-generate its
Knuth elements after an IPD change.
true
if this layout manager can be restarted after an IPD
changejava.util.List getNextKnuthElements(LayoutContext context, int alignment, java.util.Stack lmStack, Position positionAtIPDChange, LayoutManager restartAtLM)
context
- the layout contextalignment
- the alignmentlmStack
- the stack of LMs that are active at the IPD changepositionAtIPDChange
- 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
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |