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

## 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` Represents a list of inline Knuth elements.

    Fields in org.apache.fop.layoutmgr declared as KnuthSequence
    Modifier and Type | Field and Description
    --- | ---
    `protected KnuthSequence` | 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 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.

  - ### 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
    --- | ---
    `java.util.List<KnuthSequence>` | InlineContainerLayoutManager.`getNextKnuthElements(LayoutContext context, int alignment)`

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