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

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

- Packages that use KnuthElement
  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.table | Layout managers for tables.

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

    Subclasses of KnuthElement in org.apache.fop.layoutmgr
    Modifier and Type | Class and Description
    --- | ---
    `class` | `KnuthBlockBox` Knuth box used to represent a line in block-progression-dimension (i.e.
    `class` | `KnuthBox` An instance of this class represents an unbreakable piece of content with fixed width: for example an image, a syllable (but only if letter spacing is constant), ...
    `class` | `KnuthGlue` An instance of this class represents a piece of content with adjustable width: for example a space between words of justified text.
    `class` | `KnuthPenalty` An instance of this class represents information about a feasible breaking point; it does not represent any piece of content.
    `class` | `WhitespaceManagementPenalty` A special penalty used to specify content having multiple variants.

    Fields in org.apache.fop.layoutmgr with type parameters of type KnuthElement
    Modifier and Type | Field and Description
    --- | ---
    `protected KnuthSequence<KnuthElement>` | BreakingAlgorithm.`par` The paragraph of KnuthElements.
    `protected List<KnuthElement>` | BlockStackingLayoutManager.`storedList` Only used to store the original list when createUnitElements is called

    Methods in org.apache.fop.layoutmgr that return KnuthElement
    Modifier and Type | Method and Description
    --- | ---
    `protected KnuthElement` | BreakingAlgorithm.`getElement(int idx)` Return the element at index idx in the paragraph.
    `KnuthElement` | WhitespaceManagementPenalty.Variant.`getPenalty()`
    `protected KnuthElement` | BreakingAlgorithm.`handleElementAt(int position, boolean previousIsBox, int allowedBreaks)` Generic handler for a `KnuthElement` at the given `position`, taking into account whether the preceding element was a box, and which type(s) of breaks are allowed.

    Methods in org.apache.fop.layoutmgr that return types with arguments of type KnuthElement
    Modifier and Type | Method and Description
    --- | ---
    `List<List<KnuthElement>>` | KnuthBlockBox.`getElementLists()` Returns the list of Knuth sequences registered by this box.
    `static List<List<KnuthElement>>` | PageBreaker.`getFootnoteKnuthElements(FlowLayoutManager flowLM, LayoutContext context, List<FootnoteBodyLayoutManager> footnoteBodyLMs)`
    `List<List<KnuthElement>>` | PageSequenceLayoutManager.`getTableFooterFootnotes()`
    `List<List<KnuthElement>>` | PageSequenceLayoutManager.`getTableHeaderFootnotes()`

    Methods in org.apache.fop.layoutmgr with parameters of type KnuthElement
    Modifier and Type | Method and Description
    --- | ---
    `protected double` | BalancingColumnBreakingAlgorithm.`computeDemerits(BreakingAlgorithm.KnuthNode activeNode, KnuthElement element, int fitnessClass, double r)` Computes the demerits of the current breaking (that is, up to the given element), if the next-to-last chosen breakpoint is the given active node.
    `protected double` | BreakingAlgorithm.`computeDemerits(BreakingAlgorithm.KnuthNode activeNode, KnuthElement element, int fitnessClass, double r)` Computes the demerits of the current breaking (that is, up to the given element), if the next-to-last chosen breakpoint is the given active node.
    `protected int` | BreakingAlgorithm.`computeDifference(BreakingAlgorithm.KnuthNode activeNode, KnuthElement element, int elementIndex)` Return the difference between the natural width of a line that would be made between the given active node and the given element, and the available width of the real line.
    `protected void` | BreakingAlgorithm.`considerLegalBreak(KnuthElement element, int elementIdx)` Determines if the given breakpoint is a feasible breakpoint.
    `protected boolean` | BreakingAlgorithm.`elementCanEndLine(KnuthElement element, int line, int difference)` Check if the given `KnuthElement` can end the line with the given number.
    `int` | FlowLayoutManager.`negotiateBPDAdjustment(int adj, KnuthElement lastElement)` Negotiate BPD adjustment.
    `int` | BlockLevelLayoutManager.`negotiateBPDAdjustment(int adj, KnuthElement lastElement)` Negotiate BPD adjustment.
    `int` | BlockContainerLayoutManager.`negotiateBPDAdjustment(int adj, KnuthElement lastElement)` Negotiate BPD adjustment.
    `int` | BlockStackingLayoutManager.`negotiateBPDAdjustment(int adj, KnuthElement lastElement)` Negotiate BPD adjustment.

    Method parameters in org.apache.fop.layoutmgr with type arguments of type KnuthElement
    Modifier and Type | Method and Description
    --- | ---
    `void` | PageSequenceLayoutManager.`addTableFooterFootnotes(List<List<KnuthElement>> footerFootnotes)` Registers the given footnotes so that they can be added to the current page, after any other footnote.
    `void` | PageSequenceLayoutManager.`addTableHeaderFootnotes(List<List<KnuthElement>> headerFootnotes)` Registers the given footnotes so that they can be added to the current page, before any other footnote.

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

    Subclasses of KnuthElement in org.apache.fop.layoutmgr.inline
    Modifier and Type | Class and Description
    --- | ---
    `class` | `KnuthInlineBox` A knuth inline box.

    Methods in org.apache.fop.layoutmgr.inline with parameters of type KnuthElement
    Modifier and Type | Method and Description
    --- | ---
    `int` | LineLayoutManager.`negotiateBPDAdjustment(int adj, KnuthElement lastElement)` Negotiate BPD adjustment.

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

    Methods in org.apache.fop.layoutmgr.table with parameters of type KnuthElement
    Modifier and Type | Method and Description
    --- | ---
    `int` | TableLayoutManager.`negotiateBPDAdjustment(int adj, KnuthElement lastElement)` Negotiate BPD adjustment.
    `int` | TableCellLayoutManager.`negotiateBPDAdjustment(int adj, KnuthElement lastElement)` Negotiate BPD adjustment.

Copyright © 2025 Apache Software Foundation. All rights reserved.