|
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
public abstract class AbstractLayoutManager
The base class for most LayoutManagers.
Field Summary | |
---|---|
protected java.util.ListIterator |
childLMiter
child LM and child LM iterator during getNextKnuthElement phase |
protected java.util.List |
childLMs
List of child LayoutManagers |
protected LayoutManager |
curChildLM
child LM and child LM iterator during getNextKnuthElement phase |
protected java.util.ListIterator |
fobjIter
Iterator for child LayoutManagers |
protected java.util.Map |
markers
Marker map for markers related to this LayoutManager |
protected LayoutManager |
parentLM
Parent LayoutManager for this LayoutManager |
Fields inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
---|
fobj, generatesBlockArea, generatesReferenceArea |
Constructor Summary | |
---|---|
AbstractLayoutManager()
Abstract layout manager. |
|
AbstractLayoutManager(FObj fo)
Abstract layout manager. |
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 a child area to 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; |
protected java.util.List |
createChildLMs(int size)
Create the LM instances for the children of the formatting object being handled by this LM. |
boolean |
createNextChildLMs(int pos)
Create more child LMs of the parent, up to child LM index pos |
java.util.LinkedList |
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 possibile hyphenation points. |
protected LayoutManager |
getChildLM()
Return currently active child LayoutManager or null if all children have finished layout. |
java.util.List |
getChildLMs()
|
Page |
getCurrentPage()
|
PageViewport |
getCurrentPV()
|
java.util.LinkedList |
getNextKnuthElements(LayoutContext context,
int alignment)
Get a sequence of KnuthElements representing the content of the node assigned to the LM |
LayoutManager |
getParent()
Get the parent layout manager. |
Area |
getParentArea(Area childArea)
Return an Area which can contain the passed childArea. |
PageSequenceLayoutManager |
getPSLM()
Get the active PageSequenceLayoutManager instance for this layout process. |
protected boolean |
hasNextChildLM()
Return indication if getChildLM will return another LM. |
void |
initialize()
initialize the layout manager. |
boolean |
isFinished()
Tell whether this LayoutManager has handled all of its content. |
boolean |
isFirst(Position pos)
Indicates whether the given Position is the first area-generating Position of this LM. |
boolean |
isLast(Position pos)
Indicates whether the given Position is the last area-generating Position of this LM. |
Position |
notifyPos(Position pos)
Adds a Position to the Position participating in the first|last determination by assigning it a unique position index. |
protected void |
reset(Position pos)
Reset the layoutmanager "iterator" so that it will start with the passed Position's generating LM on the next call to getChildLM. |
void |
resetPosition(Position resetPos)
Reset to the position. |
void |
setFinished(boolean fin)
Set the flag indicating the LayoutManager has handled all of its content. |
void |
setParent(LayoutManager lm)
Set the parent layout manager. |
protected void |
transferForeignAttributes(Area targetArea)
Transfers foreign attributes from the formatting object to the area. |
Methods inherited from class org.apache.fop.layoutmgr.AbstractBaseLayoutManager |
---|
getAncestorBlockAreaBPD, getAncestorBlockAreaIPD, getBaseLength, getContentAreaBPD, getContentAreaIPD, getFObj, getGeneratesBlockArea, 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 |
Field Detail |
---|
protected LayoutManager parentLM
protected java.util.List childLMs
protected java.util.ListIterator fobjIter
protected java.util.Map markers
protected LayoutManager curChildLM
protected java.util.ListIterator childLMiter
Constructor Detail |
---|
public AbstractLayoutManager()
public AbstractLayoutManager(FObj fo)
fo
- the formatting object for this layout managerMethod Detail |
---|
public void setParent(LayoutManager lm)
LayoutManager
setParent
in interface LayoutManager
lm
- the parent layout managerLayoutManager.setParent(LayoutManager)
public LayoutManager getParent()
LayoutManager
getParent
in interface LayoutManager
LayoutManager.getParent()
public void initialize()
LayoutManager
initialize
in interface LayoutManager
LayoutManager.initialize()
protected LayoutManager getChildLM()
protected boolean hasNextChildLM()
protected void reset(Position pos)
pos
- a Position returned by a child layout manager
representing a potential break decision.
If pos is null, then back up to the first child LM.public void resetPosition(Position resetPos)
LayoutManager
resetPosition
in interface LayoutManager
resetPos
- the Position to reset toLayoutManager.resetPosition(Position)
public boolean isFinished()
isFinished
in interface LayoutManager
public void setFinished(boolean fin)
setFinished
in interface LayoutManager
fin
- the flag value to be setpublic void addAreas(PositionIterator posIter, LayoutContext context)
LayoutManager
addAreas
in interface LayoutManager
posIter
- the position iteratorcontext
- the contextLayoutManager.addAreas(
org.apache.fop.layoutmgr.PositionIterator
, org.apache.fop.layoutmgr.LayoutContext)
public java.util.LinkedList getNextKnuthElements(LayoutContext context, int alignment)
LayoutManager
getNextKnuthElements
in interface LayoutManager
context
- the LayoutContext used to store layout informationalignment
- the desired text alignement
LayoutManager.getNextKnuthElements(LayoutContext, int)
public java.util.LinkedList getChangedKnuthElements(java.util.List oldList, int alignment)
LayoutManager
getChangedKnuthElements
in interface LayoutManager
oldList
- the elements to replacealignment
- the desired text alignment
LayoutManager.getChangedKnuthElements(List, int)
public Area getParentArea(Area childArea)
getParentArea
in interface LayoutManager
childArea
- the child area for which the parent area is wanted
public void addChildArea(Area childArea)
addChildArea
in interface LayoutManager
childArea
- the child area to be addedprotected java.util.List createChildLMs(int size)
size
- the requested number of child LMs
public PageSequenceLayoutManager getPSLM()
LayoutManager
getPSLM
in interface LayoutManager
PageSequenceLayoutManager.getPSLM()
public Page getCurrentPage()
PageSequenceLayoutManager.getCurrentPage()
public PageViewport getCurrentPV()
public boolean createNextChildLMs(int pos)
LayoutManager
createNextChildLMs
in interface LayoutManager
pos
- index up to which child LMs are requested
LayoutManager.createNextChildLMs(int)
public java.util.List getChildLMs()
getChildLMs
in interface LayoutManager
LayoutManager.getChildLMs()
public void addChildLM(LayoutManager lm)
LayoutManager
addChildLM
in interface LayoutManager
lm
- the LM to be addedLayoutManager.addChildLM(org.apache.fop.layoutmgr.LayoutManager)
public void addChildLMs(java.util.List newLMs)
LayoutManager
addChildLMs
in interface LayoutManager
newLMs
- the list of LMs to be addedLayoutManager.addChildLMs(java.util.List)
public Position notifyPos(Position pos)
notifyPos
in interface LayoutManager
pos
- the Position
public boolean isFirst(Position pos)
pos
- the Position (must be one with a position index)
public boolean isLast(Position pos)
pos
- the Position (must be one with a position index)
protected void transferForeignAttributes(Area targetArea)
targetArea
- the area to set the attributes on
|
fop 0.94 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |