class: ListView

[111:7] extends: Node, Control, Region

The ListView class wraps the JavaFX ListView control, which displays a scrollable list of items where the user can select one or more entries. Items are provided as an ObservableList and the control automatically reflects any changes made to that list. ListView supports both horizontal and vertical orientations, single or multiple selection modes, and selection-change listeners for responding to user interaction. The tables below list every CSS property available to ListView, organized by the class level where each property is defined.

CSS Pseudo-classes -- ListView

CSS Properties -- ListView

CSS Properties -- Control

CSS Properties -- Region

Background fills

Background images

Stroked borders

Border images

Other Region properties

CSS Properties -- Node

Methods

• ListView (Items = null)

  Initializes a new ListView instance with optional items. If an item list is provided, it is set as the initial content of the ListView.

  • @p Items An array of items to populate the ListView, or null for an empty list.
  • @r this object

• onChange (callback OnChange)

  Sets a callback function that triggers when the selected item changes.

  • @p OnChange The callback function to execute on item selection change.
  • @r this object for chaining

• getSelected ()

  Retrieves the currently selected item in the ListView.

  • @r The selected item object, or null if no item is selected.

• setItems (list Items)

  Sets the list of items to display in the ListView.

  • @p Items is a list of items to set as the ListView content.
  • @r this object

• getItems ()

  Returns the list of items currently in the ListView.

  • @r A list with the current items.

• getSelectedIndex ()

  Returns the index of the currently selected item.

  • @r An int with the selected index, or -1 if nothing is selected.

• setOrientation (string Orientation)

  Sets the orientation of the ListView.

  • @p Orientation is a string: HORIZONTAL or VERTICAL.
  • @r this object

• setPrefSize (double Width, double Height)

  Sets the preferred width and height of the ListView.

  • @p Width is a double with the preferred width in pixels.
  • @p Height is a double with the preferred height in pixels.
  • @r this object

• setCellFactory (callback Factory)

  Sets a custom cell factory callback that creates cells for each item.

  • @p Factory is a callback that receives a ListView and returns a ListCell.
  • @r this object

• setId (string Id)

  Sets the CSS id of this ListView node.

  • @p Id is a string with the CSS id.
  • @r this object

• setStyle (string Style)

  Sets the inline CSS style string for this ListView.

  • @p Style is a string with the CSS style rules.
  • @r this object

• setSelectionMode (string Mode)

  Sets the selection mode for the ListView.

  • @p Mode is a string: SINGLE or MULTIPLE.
  • @r this object

• setPlaceholder (object NodeObj)

  Sets a placeholder node to display when the ListView has no items.

  • @p NodeObj is a Node object to use as the placeholder.
  • @r this object

• getSelectionModel ()

  Internal method to get the selection model for the ListView.

  • @r The selection model for managing item selection.