Uses of Class org.apache.fop.layoutmgr.Position (Apache FOP 2.7 API)
Date: 2022-01-12

## Uses of Class
org.apache.fop.layoutmgr.Position

- Packages that use Position
  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 Position in org.apache.fop.layoutmgr

    Subclasses of Position in org.apache.fop.layoutmgr
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `AbstractBreaker.FloatPosition`
    `static class` | `AbstractBreaker.PageBreakPosition` A page break position.
    `protected static class` | `BlockStackingLayoutManager.MappingPosition` A mapping position.
    `class` | `LeafPosition` A leaf position.
    `class` | `NonLeafPosition` A non-leaf position.
    `static class` | `SpaceResolver.SpaceHandlingBreakPosition` Position class for break possibilities.
    `static class` | `SpaceResolver.SpaceHandlingPosition` Position class for no-break situations.

    Fields in org.apache.fop.layoutmgr declared as Position
    Modifier and Type | Field and Description
    --- | ---
    `protected Position` | AbstractBreaker.`positionAtBreak`

    Methods in org.apache.fop.layoutmgr that return Position
    Modifier and Type | Method and Description
    --- | ---
    `protected Position` | BlockStackingLayoutManager.`getAuxiliaryPosition()`
    `Position` | SpaceResolver.SpaceHandlingBreakPosition.`getOriginalBreakPosition()`
    `protected Position` | PositionIterator.`getPos(java.lang.Object nextObj)` Default implementation assumes that the passed `nextObj` is itself a `Position`, and just returns it.
    `protected Position` | KnuthPossPosIter.`getPos(java.lang.Object nextObj)` Default implementation assumes that the passed `nextObj` is itself a `Position`, and just returns it.
    `Position` | ListElement.`getPosition()`
    `Position` | Position.`getPosition()` Overridden by NonLeafPosition to return the Position of its child LM.
    `Position` | NonLeafPosition.`getPosition()`
    `Position` | SpaceResolver.SpaceHandlingBreakPosition.`getPosition()` Overridden by NonLeafPosition to return the Position of its child LM.
    `Position` | Position.`getPosition(int depth)` Overridden by NonLeafPosition to return the Position of its child LM.
    `Position` | PositionIterator.`next()`
    `Position` | KnuthPossPosIter.`next()`
    `Position` | AbstractLayoutManager.`notifyPos(Position pos)` Adds a Position to the Position participating in the first|last determination by assigning it a unique position index.
    `Position` | LayoutManager.`notifyPos(Position pos)` Adds a Position to the Position participating in the first|last determination by assigning it a unique position index.

    Methods in org.apache.fop.layoutmgr with parameters of type Position
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | AbstractLayoutManager.`checkEndOfLayout(Position pos)` Checks to see if the incoming `Position` is the last one for this LM, and if so, calls `AbstractLayoutManager.notifyEndOfLayout()` and cleans up.
    `protected boolean` | AbstractBreaker.`containsNonRestartableLM(Position position)` Returns `true` if the given position or one of its descendants corresponds to a non-restartable LM.
    `AbstractBreaker.BlockSequence` | AbstractBreaker.BlockSequence.`endBlockSequence(Position breakPosition)` Finalizes a this `AbstractBreaker.BlockSequence`, adding a terminating penalty-glue-penalty sequence
    `KnuthSequence` | AbstractBreaker.BlockSequence.`endSequence(Position breakPosition)` Finalizes a Knuth sequence.
    `protected int` | PageBreaker.`getNextBlockList(LayoutContext childLC, int nextSequenceStartsOn, Position positionAtIPDChange, LayoutManager restartLM, java.util.List firstElements)` Gets the next block list (sequence) and adds it to a list of block lists if it's not empty.
    `protected int` | AbstractBreaker.`getNextBlockList(LayoutContext childLC, int nextSequenceStartsOn, Position positionAtIPDChange, LayoutManager restartAtLM, java.util.List<KnuthElement> 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>` | 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.
    `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>` | 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<KnuthElement>` | 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
    `protected java.util.List` | 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
    `java.util.List` | 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.
    `java.util.List` | 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` | 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` | 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.
    `java.util.List` | 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.
    `boolean` | AbstractLayoutManager.`isFirst(Position pos)` Indicates whether the given Position is the first area-generating Position of this LM.
    `boolean` | AbstractLayoutManager.`isLast(Position pos)` Indicates whether the given Position is the last area-generating Position of this LM.
    `Position` | AbstractLayoutManager.`notifyPos(Position pos)` Adds a Position to the Position participating in the first|last determination by assigning it a unique position index.
    `Position` | LayoutManager.`notifyPos(Position pos)` Adds a Position to the Position participating in the first|last determination by assigning it a unique position index.
    `void` | ListElement.`setPosition(Position position)` Change the Position stored in this element.

    Constructors in org.apache.fop.layoutmgr with parameters of type Position
    Constructor and Description
    `BorderElement(Position position, CondLengthProperty condLength, RelSide side, boolean isFirst, boolean isLast, PercentBaseContext context)` Main constructor
    `BorderOrPaddingElement(Position position, CondLengthProperty condLength, RelSide side, boolean isFirst, boolean isLast, PercentBaseContext context)` Main constructor
    `BreakElement(Position position, int penaltyWidth, int penaltyValue, int breakClass, LayoutContext context)` Constructor for hard breaks.
    `BreakElement(Position position, int penaltyValue, int breakClass, LayoutContext context)` Create a new BreakElement for the given `position`, `penaltyValue` and `breakClass`.
    `BreakElement(Position position, int penaltyValue, LayoutContext context)` Main constructor
    `KnuthBlockBox(int width, java.util.List list, Position pos, boolean auxiliary)` Creates a new box.
    `KnuthBlockBox(int width, java.util.List list, Position pos, boolean auxiliary, java.util.List<FloatContentLayoutManager> fclms)`
    `KnuthBlockBox(int width, MinOptMax range, int bpdim, Position pos, boolean auxiliary)` Creates a new box.
    `KnuthBox(int width, Position pos, boolean auxiliary)` Creates a new `KnuthBox`.
    `KnuthElement(int width, Position pos, boolean auxiliary)` Creates a new `KnuthElement`.
    `KnuthGlue(int width, int stretch, int shrink, Adjustment adjustmentClass, Position pos, boolean auxiliary)` Creates a new `KnuthGlue`.
    `KnuthGlue(int width, int stretch, int shrink, Position pos, boolean auxiliary)` Creates a new `KnuthGlue`.
    `KnuthGlue(MinOptMax minOptMax, Position pos, boolean auxiliary)` Creates a new `KnuthGlue`.
    `KnuthPenalty(int width, int penalty, boolean penaltyFlagged, int breakClass, Position pos, boolean isAuxiliary)` Create a new KnuthPenalty.
    `KnuthPenalty(int width, int penalty, boolean penaltyFlagged, Position pos, boolean auxiliary)` Create a new KnuthPenalty.
    `ListElement(Position position)` Main constructor
    `NonLeafPosition(LayoutManager lm, Position sub)` Construct a leaf position.
    `PaddingElement(Position position, CondLengthProperty condLength, RelSide side, boolean isFirst, boolean isLast, PercentBaseContext context)` Main constructor
    `SpaceElement(Position position, SpaceProperty space, RelSide side, boolean isFirst, boolean isLast, PercentBaseContext context)` Main constructor
    `UnresolvedListElement(Position position)` Main constructor
    `UnresolvedListElementWithLength(Position position, MinOptMax length, RelSide side, boolean conditional, boolean isFirst, boolean isLast)` Main constructor

  - ### Uses of Position in org.apache.fop.layoutmgr.inline

    Methods in org.apache.fop.layoutmgr.inline that return Position
    Modifier and Type | Method and Description
    --- | ---
    `protected Position` | InlineLayoutManager.`getAuxiliaryPosition()`
    `Position` | ContentLayoutManager.`notifyPos(Position pos)` Adds a Position to the Position participating in the first|last determination by assigning it a unique position index.

    Methods in org.apache.fop.layoutmgr.inline with parameters of type Position
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | InlineLevelLayoutManager.`getWordChars(Position pos)` Get the word chars corresponding to the given position.
    `java.lang.String` | ContentLayoutManager.`getWordChars(Position pos)` Get the word chars corresponding to the given position.
    `java.lang.String` | LeafNodeLayoutManager.`getWordChars(Position pos)` Get the word chars corresponding to the given position.
    `java.lang.String` | TextLayoutManager.`getWordChars(Position pos)` Get the word chars corresponding to the given position.
    `java.lang.String` | InlineContainerLayoutManager.`getWordChars(Position pos)`
    `java.lang.String` | CharacterLayoutManager.`getWordChars(Position pos)` Get the word chars corresponding to the given position.
    `java.lang.String` | InlineStackingLayoutManager.`getWordChars(Position pos)` Get the word chars corresponding to the given position.
    `void` | InlineLevelLayoutManager.`hyphenate(Position pos, HyphContext hyphContext)` Tell the LM to hyphenate a word
    `void` | LeaderLayoutManager.`hyphenate(Position pos, HyphContext hc)` Tell the LM to hyphenate a word
    `void` | ContentLayoutManager.`hyphenate(Position pos, HyphContext hc)` Tell the LM to hyphenate a word
    `void` | LeafNodeLayoutManager.`hyphenate(Position pos, HyphContext hyphContext)` Tell the LM to hyphenate a word
    `void` | TextLayoutManager.`hyphenate(Position pos, HyphContext hyphContext)` Tell the LM to hyphenate a word
    `void` | InlineContainerLayoutManager.`hyphenate(Position pos, HyphContext hyphContext)`
    `void` | CharacterLayoutManager.`hyphenate(Position pos, HyphContext hc)` Tell the LM to hyphenate a word
    `void` | InlineStackingLayoutManager.`hyphenate(Position pos, HyphContext hc)` Tell the LM to hyphenate a word
    `Position` | ContentLayoutManager.`notifyPos(Position pos)` Adds a Position to the Position participating in the first|last determination by assigning it a unique position index.

    Constructors in org.apache.fop.layoutmgr.inline with parameters of type Position
    Constructor and Description
    `KnuthInlineBox(int width, AlignmentContext alignmentContext, Position pos, boolean auxiliary)` Create a new KnuthBox.

  - ### Uses of Position in org.apache.fop.layoutmgr.list

    Subclasses of Position in org.apache.fop.layoutmgr.list
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ListItemLayoutManager.ListItemPosition`

    Methods in org.apache.fop.layoutmgr.list that return Position
    Modifier and Type | Method and Description
    --- | ---
    `Position` | ListItemLayoutManager.ListItemPosition.`getOriginalBodyPosition()`
    `Position` | ListItemLayoutManager.ListItemPosition.`getOriginalLabelPosition()`

    Methods in org.apache.fop.layoutmgr.list with parameters of type Position
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List` | 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.
    `java.util.List` | 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` | 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.
    `void` | ListItemLayoutManager.ListItemPosition.`setOriginalBodyPosition(Position originalBodyPosition)`
    `void` | ListItemLayoutManager.ListItemPosition.`setOriginalLabelPosition(Position originalLabelPosition)`

  - ### Uses of Position in org.apache.fop.layoutmgr.table

    Methods in org.apache.fop.layoutmgr.table that return Position
    Modifier and Type | Method and Description
    --- | ---
    `Position` | TableLayoutManager.`getAuxiliaryPosition()`

Copyright 1999-2022 The Apache Software Foundation. All Rights Reserved.