Options
All
  • Public
  • Public/Protected
  • All
Menu

A lines manager that equally distributes the available row height to all lines.

since

1.0

see

Row.getLineCount()

Type parameters

Hierarchy

Implements

Index

Constructors

constructor

  • Constructs a new lines manager for the given row. The manager attaches listeners to Row.lineCountProperty() and Row.heightProperty() in order to recalculate the line locations and heights.

    Parameters

    • row: R

      the row for which to use the manager

    Returns EqualLinesManager

Methods

getLineHeight

  • getLineHeight(lineIndex: number, rowHeight: number): number
  • Returns the height of the line with the given index. In most cases the height is somewhere between 0 and Row.getHeight().

    throws

    IllegalLineIndexException - if no line with the given index exists

    since

    1.0

    Parameters

    • lineIndex: number

      the index of the line

    • rowHeight: number

      the height of the row where the line is located

    Returns number

    the height of the given line

getLineIndex

  • getLineIndex(activity: A): number
  • Returns the line index for the given activity. This method is responsible for placing activities on different lines.

    since

    1.0

    Parameters

    • activity: A

      the activity for which a line index is requested

    Returns number

    the line index of the given activity

getLineLayout

  • getLineLayout(lineIndex: number): Layout
  • Returns the layout for the line with the given line index. A row and each line within a row can have their own layout.

    throws

    IllegalLineIndexException - if no line with the given index exists

    since

    1.0

    Parameters

    • lineIndex: number

      the index of the line

    Returns Layout

    the layout of the given line

getLineLocation

  • getLineLocation(lineIndex: number, rowHeight: number): number
  • Returns the location of the line with the given index. In most cases the value of the location is somewhere between 0 and Row.getHeight(). Lines are free to overlap each other.

    throws

    IllegalLineIndexException - if no line with the given index exists

    since

    1.0

    Parameters

    • lineIndex: number

      the index of the line

    • rowHeight: number

      the height of the row where the line is located

    Returns number

    the location of the given line (y-coordinate)

getRow

  • getRow(): R
  • Returns the row for which the manager is used.

    Returns R

    the row