Class MultiColumnListView.ListViewColumn<T>

java.lang.Object
com.dlsc.gemsfx.MultiColumnListView.ListViewColumn<T>
Type Parameters:
T - the type of items shown by the column
Enclosing class:
MultiColumnListView<T>
public static class MultiColumnListView.ListViewColumn<T> extends Object
The model object representing a single column. The type of the items in all columns must be the same.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    header
    An optional node that will serve as the column's header.
    final javafx.beans.property.ListProperty<T>
    items
    The data shown in the column.
    final javafx.beans.property.ObjectProperty<Object>
    userObject
    An optional user object that can be associated with the column.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ListViewColumn()
    Creates an empty column.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.scene.Node
    getHeader()
    Gets the value of the header property.
    final javafx.collections.ObservableList<T>
    getItems()
    Gets the value of the items property.
    final javafx.collections.ObservableList<MultiColumnListView.ColumnItem<T>>
    getItemWrappers()
    The list of wrapped items that is being shown by the ListView of this column.
    final Object
    getUserObject()
    Gets the value of the userObject property.
    final javafx.beans.property.ObjectProperty<javafx.scene.Node>
    headerProperty()
    An optional node that will serve as the column's header.
    final javafx.beans.property.ListProperty<T>
    itemsProperty()
    The data shown in the column.
    final void
    setHeader(javafx.scene.Node header)
    Sets the value of the header property.
    final void
    setItems(javafx.collections.ObservableList<T> items)
    Sets the value of the items property.
    final void
    setUserObject(Object value)
    Sets the value of the userObject property.
    final javafx.beans.property.ObjectProperty<Object>
    userObjectProperty()
    An optional user object that can be associated with the column.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Property Details

  • Constructor Details

    • ListViewColumn

      public ListViewColumn()
      Creates an empty column.

  • Method Details

    • getItemWrappers

      public final javafx.collections.ObservableList<MultiColumnListView.ColumnItem<T>> getItemWrappers()
      The list of wrapped items that is being shown by the ListView of this column. This list is maintained by the control itself. It is kept in sync with the list returned by getItems() and it might temporarily contain the two placeholder items that are used to visualize an ongoing drag and drop operation.
      Returns:
      the internal list of wrapped items

    • getItems

      public final javafx.collections.ObservableList<T> getItems()
      Gets the value of the items property.
      Property description:
      The data shown in the column.
      Returns:
      the value of the items property
      See Also:

    • itemsProperty

      public final javafx.beans.property.ListProperty<T> itemsProperty()
      The data shown in the column.
      Returns:
      the model for this column
      See Also:

    • setItems

      public final void setItems(javafx.collections.ObservableList<T> items)
      Sets the value of the items property.
      Property description:
      The data shown in the column.
      Parameters:
      items - the value for the items property
      See Also:

    • getHeader

      public final javafx.scene.Node getHeader()
      Gets the value of the header property.
      Property description:
      An optional node that will serve as the column's header. It will be shown above the column.
      Returns:
      the value of the header property
      See Also:

    • headerProperty

      public final javafx.beans.property.ObjectProperty<javafx.scene.Node> headerProperty()
      An optional node that will serve as the column's header. It will be shown above the column.
      Returns:
      the header node / header UI
      See Also:

    • setHeader

      public final void setHeader(javafx.scene.Node header)
      Sets the value of the header property.
      Property description:
      An optional node that will serve as the column's header. It will be shown above the column.
      Parameters:
      header - the value for the header property
      See Also:

    • getUserObject

      public final Object getUserObject()
      Gets the value of the userObject property.
      Property description:
      An optional user object that can be associated with the column. This can be used to store additional information about the column, such as an identifier or metadata.
      Returns:
      the value of the userObject property
      See Also:

    • setUserObject

      public final void setUserObject(Object value)
      Sets the value of the userObject property.
      Property description:
      An optional user object that can be associated with the column. This can be used to store additional information about the column, such as an identifier or metadata.
      Parameters:
      value - the value for the userObject property
      See Also:

    • userObjectProperty

      public final javafx.beans.property.ObjectProperty<Object> userObjectProperty()
      An optional user object that can be associated with the column. This can be used to store additional information about the column, such as an identifier or metadata.
      Returns:
      the userObject property
      See Also: