Uses of Class org.apache.fop.layoutmgr.KnuthSequence (Apache FOP Core 2.11 API)
Date: 2025-04-24

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

- Packages that use KnuthSequence
  Package | Description
  --- | ---
  org.apache.fop.layoutmgr | FOP's layout engine.
  org.apache.fop.layoutmgr.inline | Layout managers for inline formatting objects and line building.

- - ### Uses of KnuthSequence in org.apache.fop.layoutmgr

    Subclasses of KnuthSequence in org.apache.fop.layoutmgr
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `AbstractBreaker.BlockSequence` Helper class, extending the functionality of the basic `BlockKnuthSequence`.
    `class` | `BlockKnuthSequence` Represents a list of block level Knuth elements.
    `class` | `InlineKnuthSequence<T extends ListElement>` Represents a list of inline Knuth elements.

    Fields in org.apache.fop.layoutmgr declared as KnuthSequence
    Modifier and Type | Field and Description
    --- | ---
    `protected KnuthSequence<KnuthElement>` | BreakingAlgorithm.`par` The paragraph of KnuthElements.

    Methods in org.apache.fop.layoutmgr that return KnuthSequence
    Modifier and Type | Method and Description
    --- | ---
    `KnuthSequence` | InlineKnuthSequence.`endSequence()` Finalizes a Knuth sequence.
    `KnuthSequence` | AbstractBreaker.BlockSequence.`endSequence()` Finalizes a Knuth sequence.
    `abstract KnuthSequence` | KnuthSequence.`endSequence()` Finalizes a Knuth sequence.
    `KnuthSequence` | BlockKnuthSequence.`endSequence()` Finalizes a Knuth sequence.
    `KnuthSequence` | AbstractBreaker.BlockSequence.`endSequence(Position breakPosition)` Finalizes a Knuth sequence.

    Methods in org.apache.fop.layoutmgr that return types with arguments of type KnuthSequence
    Modifier and Type | Method and Description
    --- | ---
    `List<KnuthSequence>` | RetrieveTableMarkerLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.

    Methods in org.apache.fop.layoutmgr with parameters of type KnuthSequence
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | InlineKnuthSequence.`appendSequence(KnuthSequence sequence)` Append sequence to this sequence if it can be appended.
    `abstract boolean` | KnuthSequence.`appendSequence(KnuthSequence sequence)` Append sequence to this sequence if it can be appended.
    `boolean` | BlockKnuthSequence.`appendSequence(KnuthSequence sequence)` Append sequence to this sequence if it can be appended.
    `boolean` | InlineKnuthSequence.`appendSequence(KnuthSequence sequence, boolean keepTogether, BreakElement breakElement)` Append sequence to this sequence if it can be appended.
    `abstract boolean` | KnuthSequence.`appendSequence(KnuthSequence sequence, boolean keepTogether, BreakElement breakElement)` Append sequence to this sequence if it can be appended.
    `boolean` | BlockKnuthSequence.`appendSequence(KnuthSequence sequence, boolean keepTogether, BreakElement breakElement)` Append sequence to this sequence if it can be appended.
    `boolean` | KnuthSequence.`appendSequenceOrClose(KnuthSequence sequence)` Append sequence to this sequence if it can be appended.
    `boolean` | KnuthSequence.`appendSequenceOrClose(KnuthSequence sequence, boolean keepTogether, BreakElement breakElement)` Append sequence to this sequence if it can be appended.
    `protected void` | BreakingAlgorithm.`calculateBreakPoints(BreakingAlgorithm.KnuthNode node, KnuthSequence par, int total)` Determines the set of optimal breakpoints corresponding to the given active node.
    `boolean` | InlineKnuthSequence.`canAppendSequence(KnuthSequence sequence)` Can sequence be appended to this sequence?
    `abstract boolean` | KnuthSequence.`canAppendSequence(KnuthSequence sequence)` Can sequence be appended to this sequence?
    `boolean` | BlockKnuthSequence.`canAppendSequence(KnuthSequence sequence)` Can sequence be appended to this sequence?
    `int` | BreakingAlgorithm.`findBreakingPoints(KnuthSequence par, double threshold, boolean force, int allowedBreaks)`
    `int` | BreakingAlgorithm.`findBreakingPoints(KnuthSequence par, int startIndex, double threshold, boolean force, int allowedBreaks)` Finds an optimal set of breakpoints for the given paragraph.
    `abstract void` | BreakingAlgorithm.`updateData2(BreakingAlgorithm.KnuthNode bestActiveNode, KnuthSequence sequence, int total)` Empty method, hook for subclasses.

    Constructor parameters in org.apache.fop.layoutmgr with type arguments of type KnuthSequence
    Constructor and Description
    `BlockKnuthSequence(List<KnuthSequence> list)` Creates a new list from an existing list.

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

    Methods in org.apache.fop.layoutmgr.inline that return types with arguments of type KnuthSequence
    Modifier and Type | Method and Description
    --- | ---
    `List<KnuthSequence>` | FootnoteLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.
    `List<KnuthSequence>` | LeaderLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.
    `LinkedList<KnuthSequence>` | FloatLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)`
    `List<KnuthSequence>` | LeafNodeLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.
    `List<KnuthSequence>` | WrapperLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)`
    `List<KnuthSequence>` | TextLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.
    `List<KnuthSequence>` | InlineContainerLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)`
    `List<KnuthSequence>` | InlineLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.
    `List<KnuthSequence>` | AbstractGraphicsLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.
    `List<KnuthSequence>` | CharacterLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)` Get a sequence of KnuthElements representing the content of the node assigned to the LM.

Copyright © 2025 Apache Software Foundation. All rights reserved.