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

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

- Packages that use Keep
  Package | Description
  --- | ---
  org.apache.fop.fo.flow.table |
  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 Keep in org.apache.fop.fo.flow.table

    Methods in org.apache.fop.fo.flow.table that return Keep
    Modifier and Type | Method and Description
    --- | ---
    `Keep` | EffRow.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | PrimaryGridUnit.`getKeepWithNext()` Returns the strength of the keep constraint if the last child block (or its descendants) of this cell has keep-with-next.
    `Keep` | EffRow.`getKeepWithNext()` Returns the strength of the keep constraint if the enclosing (if any) fo:table-row element of this row, or if any of the cells ending on this row, have keep-with-next set.
    `Keep` | PrimaryGridUnit.`getKeepWithPrevious()` Returns the strength of the keep constraint if the first child block (or its descendants) of this cell has keep-with-previous.
    `Keep` | EffRow.`getKeepWithPrevious()` Returns the strength of the keep constraint if the enclosing (if any) fo:table-row element of this row, or if any of the cells starting on this row, have keep-with-previous set.

    Methods in org.apache.fop.fo.flow.table with parameters of type Keep
    Modifier and Type | Method and Description
    --- | ---
    `void` | PrimaryGridUnit.`setKeepWithNext(Keep keep)` Don't use, reserved for TableCellLM.
    `void` | PrimaryGridUnit.`setKeepWithPrevious(Keep keep)` Don't use, reserved for TableCellLM.

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

    Fields in org.apache.fop.layoutmgr declared as Keep
    Modifier and Type | Field and Description
    --- | ---
    `static Keep` | Keep.`KEEP_ALWAYS` keep always
    `static Keep` | Keep.`KEEP_AUTO` keep auto

    Methods in org.apache.fop.layoutmgr that return Keep
    Modifier and Type | Method and Description
    --- | ---
    `Keep` | Keep.`compare(Keep other)` Compare this Keep instance to another one, and return the stronger one if the context is the same
    `static Keep` | Keep.`getKeep(KeepProperty keepProperty)` Obtain a Keep instance corresponding to the given `KeepProperty`
    `Keep` | MultiCaseLayoutManager.`getKeepTogether()`
    `Keep` | FlowLayoutManager.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | FootnoteBodyLayoutManager.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | BlockLevelLayoutManager.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | FloatContentLayoutManager.`getKeepTogether()`
    `Keep` | BlockStackingLayoutManager.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | StaticContentLayoutManager.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | MultiCaseLayoutManager.`getKeepWithNext()`
    `Keep` | FlowLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | FootnoteBodyLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | BlockLevelLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | FloatContentLayoutManager.`getKeepWithNext()`
    `Keep` | BlockStackingLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | StaticContentLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | LayoutContext.`getKeepWithNextPending()` Returns the strength of a keep-with-next currently pending.
    `Keep` | MultiCaseLayoutManager.`getKeepWithPrevious()`
    `Keep` | FlowLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.
    `Keep` | FootnoteBodyLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.
    `Keep` | BlockLevelLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.
    `Keep` | FloatContentLayoutManager.`getKeepWithPrevious()`
    `Keep` | BlockStackingLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.
    `Keep` | StaticContentLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.
    `Keep` | LayoutContext.`getKeepWithPreviousPending()` Returns the strength of a keep-with-previous currently pending.
    `protected Keep` | BlockStackingLayoutManager.`getParentKeepTogether()` Retrieves and returns the keep-together strength from the parent element.

    Methods in org.apache.fop.layoutmgr with parameters of type Keep
    Modifier and Type | Method and Description
    --- | ---
    `Keep` | Keep.`compare(Keep other)` Compare this Keep instance to another one, and return the stronger one if the context is the same
    `void` | LayoutContext.`updateKeepWithNextPending(Keep keep)` Updates the currently pending keep-with-next strength.
    `void` | LayoutContext.`updateKeepWithPreviousPending(Keep keep)` Updates the currently pending keep-with-previous strength.

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

    Methods in org.apache.fop.layoutmgr.inline that return Keep
    Modifier and Type | Method and Description
    --- | ---
    `Keep` | LineLayoutManager.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | LineLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | LineLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.

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

    Methods in org.apache.fop.layoutmgr.list that return Keep
    Modifier and Type | Method and Description
    --- | ---
    `Keep` | ListItemContentLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | ListItemContentLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.

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

    Methods in org.apache.fop.layoutmgr.table that return Keep
    Modifier and Type | Method and Description
    --- | ---
    `Keep` | TableCellLayoutManager.`getKeepTogether()` Returns the keep-together strength for this element.
    `Keep` | TableAndCaptionLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | TableCellLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | TableCaptionLayoutManager.`getKeepWithNext()` Returns the keep-with-next strength for this element.
    `Keep` | TableAndCaptionLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.
    `Keep` | TableCellLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.
    `Keep` | TableCaptionLayoutManager.`getKeepWithPrevious()` Returns the keep-with-previous strength for this element.

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