Uses of Interface
org.apache.fop.layoutmgr.LayoutManager

Packages that use LayoutManager

Package	Description
org.apache.fop.layoutmgr	FOP's layout engine.
org.apache.fop.layoutmgr.inline	Layout managers for inline formatting objects and line building.
org.apache.fop.layoutmgr.list	Layout managers for lists.
org.apache.fop.layoutmgr.table	Layout managers for tables.

Uses of LayoutManager in org.apache.fop.layoutmgr

Subinterfaces of LayoutManager in org.apache.fop.layoutmgr

Modifier and Type	Interface	Description
interface	BlockLevelLayoutManager	The interface for LayoutManagers which generate block areas

Classes in org.apache.fop.layoutmgr that implement LayoutManager

Modifier and Type	Class	Description
class	AbstractBaseLayoutManager	The base class for nearly all LayoutManagers.
class	AbstractLayoutManager	The base class for most LayoutManagers.
class	AbstractPageSequenceLayoutManager	Abstract base class for a page sequence layout manager.
class	BlockContainerLayoutManager	LayoutManager for a block-container FO.
class	BlockLayoutManager	LayoutManager for a block FO.
class	BlockStackingLayoutManager	Base LayoutManager class for all areas which stack their child areas in the block-progression direction, such as Flow, Block, ListBlock.
class	ExternalDocumentLayoutManager	LayoutManager for an external-document extension element.
class	FloatContentLayoutManager
class	FlowLayoutManager	LayoutManager for an fo:flow object.
class	FootnoteBodyLayoutManager	Layout manager for footnote bodies.
class	MultiCaseLayoutManager
class	MultiSwitchLayoutManager
class	PageSequenceLayoutManager	LayoutManager for a PageSequence.
class	RetrieveTableMarkerLayoutManager
class	SpacedBorderedPaddedBlockLayoutManager	A block-stacking layout manager for an FO that supports spaces, border and padding.
class	StaticContentLayoutManager	LayoutManager for an fo:flow object.

Fields in org.apache.fop.layoutmgr declared as LayoutManager

Modifier and Type	Field	Description
private LayoutManager	PositionIterator.childLM
protected LayoutManager	AbstractLayoutManager.curChildLM	child LM during getNextKnuthElement phase
private LayoutManager	LayoutException.layoutManager
private LayoutManager	Position.layoutManager
private LayoutManager	LMiter.lp	The LayoutManager to which this LMiter is attached
protected LayoutManager	AbstractBreaker.originalRestartAtLM
protected LayoutManager	AbstractLayoutManager.parentLayoutManager	Parent LayoutManager for this LayoutManager
private LayoutManager	PageBreakingAlgorithm.topLevelLM

Fields in org.apache.fop.layoutmgr with type parameters of type LayoutManager

Modifier and Type	Field	Description
protected java.util.ListIterator<LayoutManager>	AbstractLayoutManager.childLMiter	child LM iterator during getNextKnuthElement phase
protected java.util.List<LayoutManager>	AbstractLayoutManager.childLMs	List of child LayoutManagers
protected java.util.List<LayoutManager>	LMiter.listLMs	list of layout managers
protected java.util.ListIterator<LayoutManager>	BlockLayoutManager.proxyLMiter	Iterator over the child layout managers.

Methods in org.apache.fop.layoutmgr that return LayoutManager

Modifier and Type	Method	Description
protected LayoutManager	AbstractLayoutManager.getChildLM()	Return currently active child LayoutManager or null if all children have finished layout.
protected abstract LayoutManager	AbstractBreaker.getCurrentChildLM()
protected LayoutManager	BlockContainerLayoutManager.BlockContainerBreaker.getCurrentChildLM()
protected LayoutManager	LocalBreaker.getCurrentChildLM()
LayoutManager	LayoutException.getLayoutManager()	Returns the layout manager that detected the problem.
LayoutManager	ListElement.getLayoutManager()
protected LayoutManager	KnuthPossPosIter.getLM(java.lang.Object nextObj)
LayoutManager	Position.getLM()
LayoutManager	Position.getLM(int depth)
protected LayoutManager	PositionIterator.getLM(java.lang.Object nextObj)
LayoutManager	PositionIterator.getNextChildLM()
protected LayoutManager	UnresolvedListElement.getOriginatingLayoutManager()
LayoutManager	AbstractLayoutManager.getParent()	Get the parent layout manager.
LayoutManager	LayoutManager.getParent()	Get the parent layout manager.
protected LayoutManager	RestartAtLM.getRestartAtLM(AbstractBreaker breaker, PageBreakingAlgorithm alg, boolean ipdChangesOnNextPage, boolean onLastPageAndIPDChanges, boolean visitedBefore, AbstractBreaker.BlockSequence blockList, int start)
protected abstract LayoutManager	AbstractBreaker.getTopLevelLM()
protected LayoutManager	BlockContainerLayoutManager.BlockContainerBreaker.getTopLevelLM()
protected LayoutManager	LocalBreaker.getTopLevelLM()
protected LayoutManager	PageBreaker.getTopLevelLM()
LayoutManager	LayoutManagerMaker.makeLayoutManager(FONode node)	Make a specific LayoutManager for the node.
LayoutManager	LayoutManagerMapping.makeLayoutManager(FONode node)	Make a specific LayoutManager for the node.
LayoutManager	LMiter.next()
LayoutManager	LMiter.previous()

Methods in org.apache.fop.layoutmgr that return types with arguments of type LayoutManager

Modifier and Type	Method	Description
protected java.util.List<LayoutManager>	AbstractLayoutManager.createChildLMs(int size)	Create the LM instances for the children of the formatting object being handled by this LM.
java.util.List<LayoutManager>	AbstractLayoutManager.getChildLMs()
java.util.List<LayoutManager>	LayoutManager.getChildLMs()

Methods in org.apache.fop.layoutmgr with parameters of type LayoutManager

Modifier and Type	Method	Description
void	LMiter.add(LayoutManager lm)
private java.util.List<ListElement>	FlowLayoutManager.addChildElements(java.util.List<ListElement> elements, LayoutManager childLM, LayoutContext context, int alignment, java.util.Stack<LayoutManager> lmStack, Position position, LayoutManager restartAtLM)
void	AbstractLayoutManager.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	LayoutManager.addChildLM(LayoutManager lm)	Add the LM in the argument to the list of child LMs; set this LM as the parent; initialize the LM.
private LineLayoutManager	BlockLayoutManager.createLineManager(LayoutManager firstlm)	Create a new LineLM, and collect all consecutive inline generating LMs as its child LMs.
protected int	AbstractBreaker.getNextBlockList(LayoutContext childLC, int nextSequenceStartsOn, Position positionAtIPDChange, LayoutManager restartAtLM, java.util.List<ListElement> firstElements)	Gets the next block list (sequence) and adds it to a list of block lists if it's not empty.
protected int	PageBreaker.getNextBlockList(LayoutContext childLC, int nextSequenceStartsOn, Position positionAtIPDChange, LayoutManager restartLM, java.util.List<ListElement> firstElements)	Gets the next block list (sequence) and adds it to a list of block lists if it's not empty.
protected java.util.List<ListElement>	BlockLayoutManager.getNextChildElements(LayoutManager childLM, LayoutContext context, LayoutContext childLC, int alignment, java.util.Stack lmStack, Position restartPosition, LayoutManager restartAtLM)	Overridden to take into account that the childLM may be the block's LineLayoutManager.
protected java.util.List<ListElement>	BlockStackingLayoutManager.getNextChildElements(LayoutManager childLM, LayoutContext context, LayoutContext childLC, int alignment, java.util.Stack<LayoutManager> lmStack, Position restartPosition, LayoutManager restartAtLM)	Gets the next set of child elements for the given childLM.
protected java.util.List<ListElement>	FlowLayoutManager.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<ListElement>	AbstractBaseLayoutManager.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.
protected java.util.List<ListElement>	AbstractBreaker.getNextKnuthElements(LayoutContext context, int alignment, Position positionAtIPDChange, LayoutManager restartAtLM)	Get a sequence of KnuthElements representing the content of the node assigned to the LM
java.util.List<ListElement>	BlockContainerLayoutManager.getNextKnuthElements(LayoutContext context, int alignment, java.util.Stack lmStack, Position restartPosition, LayoutManager restartAtLM)	Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected.
java.util.List<ListElement>	BlockLayoutManager.getNextKnuthElements(LayoutContext context, int alignment, java.util.Stack lmStack, Position restartPosition, LayoutManager restartAtLM)	Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected.
java.util.List<ListElement>	BlockStackingLayoutManager.getNextKnuthElements(LayoutContext context, int alignment, java.util.Stack lmStack, Position restartPosition, LayoutManager restartAtLM)	Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected.
(package private) java.util.List<ListElement>	FlowLayoutManager.getNextKnuthElements(LayoutContext context, int alignment, Position restartPosition, LayoutManager restartLM)	Get a sequence of KnuthElements representing the content of the node assigned to the LM.
java.util.List<ListElement>	LayoutManager.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.
protected java.util.List<ListElement>	PageBreaker.getNextKnuthElements(LayoutContext context, int alignment, Position positionAtIPDChange, LayoutManager restartAtLM)	Get a sequence of KnuthElements representing the content of the node assigned to the LM
private boolean	FlowLayoutManager.handleSpanChange(LayoutManager childLM, LayoutContext context)
void	LMiter.set(LayoutManager lm)
protected void	AbstractLayoutManager.setCurrentChildLM(LayoutManager childLM)	Set currently active child layout manager.
void	AbstractLayoutManager.setParent(LayoutManager lm)	Set the parent layout manager.
void	LayoutManager.setParent(LayoutManager lm)	Set the parent layout manager.
void	KnuthSequence.wrapPositions(LayoutManager lm)	Wrap the Positions of the elements of this sequence in a Position for LayoutManager lm.

Method parameters in org.apache.fop.layoutmgr with type arguments of type LayoutManager

Modifier and Type	Method	Description
private java.util.List<ListElement>	FlowLayoutManager.addChildElements(java.util.List<ListElement> elements, LayoutManager childLM, LayoutContext context, int alignment, java.util.Stack<LayoutManager> lmStack, Position position, LayoutManager restartAtLM)
void	LayoutManager.addChildLMs(java.util.List<LayoutManager> newLMs)	Add the LMs in the argument to the list of child LMs;
private int	FloatContentLayoutManager.getContentAreaIPD(java.util.List<LayoutManager> childLMs)
private int	FloatContentLayoutManager.getContentAreaIPD(java.util.List<LayoutManager> childLMs, Area childArea)
protected java.util.List<ListElement>	BlockStackingLayoutManager.getNextChildElements(LayoutManager childLM, LayoutContext context, LayoutContext childLC, int alignment, java.util.Stack<LayoutManager> lmStack, Position restartPosition, LayoutManager restartAtLM)	Gets the next set of child elements for the given childLM.
protected java.util.List<ListElement>	FlowLayoutManager.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.
void	LayoutManagerMaker.makeLayoutManagers(FONode node, java.util.List<LayoutManager> lms)	Make LayoutManagers for the node and add them to the list lms.

Constructors in org.apache.fop.layoutmgr with parameters of type LayoutManager

Constructor	Description
BalancingColumnBreakingAlgorithm(LayoutManager topLevelLM, PageProvider pageProvider, PageBreakingAlgorithm.PageBreakingLayoutListener layoutListener, int alignment, int alignmentLast, MinOptMax footnoteSeparatorLength, boolean partOverflowRecovery, int columnCount)
BlockContainerPosition(LayoutManager lm, BlockContainerLayoutManager.BlockContainerBreaker breaker)
FloatPosition(LayoutManager lm, int breakIndex, double bpdA, int diff)
LayoutException(java.lang.String message, LayoutManager lm)	Constructs a new layout exception with the specified detail message.
LeafPosition(LayoutManager layoutManager, int pos)	Construct a leaf position.
LeafPosition(LayoutManager layoutManager, int pos, int index)	Construct a leaf position.
LMiter(LayoutManager lp)	Construct a layout manager iterator.
MappingPosition(LayoutManager lm, int first, int last)	Construct mapping position.
NonLeafPosition(LayoutManager lm, Position sub)	Construct a leaf position.
PageBreakingAlgorithm(LayoutManager topLevelLM, PageProvider pageProvider, PageBreakingAlgorithm.PageBreakingLayoutListener layoutListener, int alignment, int alignmentLast, MinOptMax footnoteSeparatorLength, boolean partOverflowRecovery, boolean autoHeight, boolean favorSinglePart, LayoutContext childLC)	Construct a page breaking algorithm.
PageBreakPosition(LayoutManager lm, int breakIndex, int ffli, int ffei, int flli, int flei, double bpdA, int diff)
Position(LayoutManager lm)	Construct a position.
Position(LayoutManager lm, int index)	Construct a position.
WhitespaceManagementPosition(LayoutManager lm)

Uses of LayoutManager in org.apache.fop.layoutmgr.inline

Subinterfaces of LayoutManager in org.apache.fop.layoutmgr.inline

Modifier and Type	Interface	Description
interface	InlineLevelLayoutManager	The interface for LayoutManagers which generate inline areas

Classes in org.apache.fop.layoutmgr.inline that implement LayoutManager

Modifier and Type	Class	Description
class	AbstractGraphicsLayoutManager	LayoutManager handling the common tasks for the fo:instream-foreign-object and fo:external-graphics formatting objects
class	AbstractPageNumberCitationLayoutManager	LayoutManager for the fo:page-number-citation(-last) formatting object
class	BasicLinkLayoutManager	LayoutManager for the fo:basic-link formatting object
class	BidiLayoutManager	Layout manager for fo:bidi-override.
class	CharacterLayoutManager	LayoutManager for the fo:character formatting object
class	ContentLayoutManager	Content Layout Manager.
class	ExternalGraphicLayoutManager	LayoutManager for the fo:external-graphic formatting object
class	FloatLayoutManager
class	FootnoteLayoutManager	Layout manager for fo:footnote.
class	InlineContainerLayoutManager	This creates a single inline container area after laying out the child block areas.
class	InlineLayoutManager	LayoutManager for objects which stack children in the inline direction, such as Inline or Line
class	InlineStackingLayoutManager	Class modelling the commonalities of layoutmanagers for objects which stack children in the inline direction, such as Inline or Line.
class	InstreamForeignObjectLM	LayoutManager for the fo:instream-foreign-object formatting object
class	LeaderLayoutManager	LayoutManager for the fo:leader formatting object
class	LeafNodeLayoutManager	Base LayoutManager for leaf-node FObj, ie: ones which have no children.
class	LineLayoutManager	LayoutManager for lines.
class	PageNumberCitationLastLayoutManager	LayoutManager for the fo:page-number-citation-last formatting object.
class	PageNumberCitationLayoutManager	LayoutManager for the fo:page-number-citation formatting object.
class	PageNumberLayoutManager	LayoutManager for the fo:page-number formatting object
class	TextLayoutManager	LayoutManager for text (a sequence of characters) which generates one or more inline areas.
class	WrapperLayoutManager	This is the layout manager for the fo:wrapper formatting object.

Fields in org.apache.fop.layoutmgr.inline declared as LayoutManager

Modifier and Type	Field	Description
private LayoutManager	InlineLayoutManager.lastChildLM
private LayoutManager	ContentLayoutManager.parentLM

Methods in org.apache.fop.layoutmgr.inline that return LayoutManager

Modifier and Type	Method	Description
protected LayoutManager	FloatLayoutManager.getChildLM()
LayoutManager	ContentLayoutManager.getParent()	Get the parent layout manager.

Methods in org.apache.fop.layoutmgr.inline that return types with arguments of type LayoutManager

Modifier and Type	Method	Description
java.util.List<LayoutManager>	ContentLayoutManager.getChildLMs()

Methods in org.apache.fop.layoutmgr.inline with parameters of type LayoutManager

Modifier and Type	Method	Description
void	ContentLayoutManager.addChildLM(LayoutManager lm)	Add the LM in the argument to the list of child LMs; set this LM as the parent; initialize the LM.
private void	ContentLayoutManager.fillArea(LayoutManager curLM)
private boolean	InlineLayoutManager.mustKeepTogether(LayoutManager lm)
void	ContentLayoutManager.setParent(LayoutManager lm)	Set the parent layout manager.

Method parameters in org.apache.fop.layoutmgr.inline with type arguments of type LayoutManager

Modifier and Type	Method	Description
void	ContentLayoutManager.addChildLMs(java.util.List<LayoutManager> newLMs)	Add the LMs in the argument to the list of child LMs;

Constructors in org.apache.fop.layoutmgr.inline with parameters of type LayoutManager

Constructor	Description
ContentLayoutManager(Area area, LayoutManager parentLM)	Constructs a new ContentLayoutManager
LineBreakPosition(LayoutManager lm, int index, int startIndex, int breakIndex, int shrink, int stretch, int diff, double ipdA, double adjust, int si, int ei, int lh, int lw, int sb, int sa, int bl)

Uses of LayoutManager in org.apache.fop.layoutmgr.list

Classes in org.apache.fop.layoutmgr.list that implement LayoutManager

Modifier and Type	Class	Description
class	ListBlockLayoutManager	LayoutManager for a list-block FO.
class	ListItemContentLayoutManager	LayoutManager for a list-item-label or list-item-body FO.
class	ListItemLayoutManager	LayoutManager for a list-item FO.

Methods in org.apache.fop.layoutmgr.list with parameters of type LayoutManager

Modifier and Type	Method	Description
java.util.List<ListElement>	ListBlockLayoutManager.getNextKnuthElements(LayoutContext context, int alignment, java.util.Stack lmStack, Position restartPosition, LayoutManager restartAtLM)	Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected.
java.util.List<ListElement>	ListItemContentLayoutManager.getNextKnuthElements(LayoutContext context, int alignment, java.util.Stack lmStack, Position restartPosition, LayoutManager restartAtLM)	Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected.
java.util.List<ListElement>	ListItemLayoutManager.getNextKnuthElements(LayoutContext context, int alignment, java.util.Stack lmStack, Position restartPosition, LayoutManager restartAtLM)	Returns an updated list of Knuth elements corresponding to this layout manager, after a change of IPD has been detected.
private boolean	ListItemLayoutManager.isChangingIPD(LayoutManager lm)
private boolean	ListItemLayoutManager.shouldWeAvoidBreak(java.util.List<ListElement> returnList, LayoutManager lm)

Constructors in org.apache.fop.layoutmgr.list with parameters of type LayoutManager

Constructor	Description
ListItemPosition(LayoutManager lm, int labelFirst, int labelLast, int bodyFirst, int bodyLast)

Uses of LayoutManager in org.apache.fop.layoutmgr.table

Classes in org.apache.fop.layoutmgr.table that implement LayoutManager

Modifier and Type	Class	Description
class	TableAndCaptionLayoutManager	LayoutManager for a table-and-caption FO.
class	TableCaptionLayoutManager	LayoutManager for a table-caption FO.
class	TableCellLayoutManager	LayoutManager for a table-cell FO.
class	TableLayoutManager	LayoutManager for a table FO.

Methods in org.apache.fop.layoutmgr.table with parameters of type LayoutManager

Modifier and Type	Method	Description
void	TableCellLayoutManager.setParent(LayoutManager lm)	Set the parent layout manager.

Method parameters in org.apache.fop.layoutmgr.table with type arguments of type LayoutManager

Modifier and Type	Method	Description
private void	TableCellLayoutManager.clearRetrieveTableMarkerChildNodes(java.util.List<LayoutManager> childrenLMs)

Constructors in org.apache.fop.layoutmgr.table with parameters of type LayoutManager

Constructor	Description
TableContentPosition(LayoutManager lm, java.util.List<CellPart> cellParts, EffRow row)	Creates a new TableContentPosition.
TableHeaderFooterPosition(LayoutManager lm, boolean header, java.util.List<ListElement> nestedElements)	Creates a new TableHeaderFooterPosition.
TableHFPenaltyPosition(LayoutManager lm)	Creates a new TableHFPenaltyPosition