javafx.scene.control

Class TableView.TableViewSelectionModel<S>

java.lang.Object

javafx.scene.control.SelectionModel<T>

javafx.scene.control.MultipleSelectionModel<S>

javafx.scene.control.TableView.TableViewSelectionModel<S>

Enclosing class:

TableView<S>

public abstract static class TableView.TableViewSelectionModel<S>
extends MultipleSelectionModel<S>

A simple extension of the SelectionModel abstract class to allow for special support for TableView controls.

Property Summary

Properties

Type	Property and Description
BooleanProperty	cellSelectionEnabled A boolean property used to represent whether the TableView is in row or cell selection modes.

Properties inherited from class javafx.scene.control.MultipleSelectionModel

selectionMode

Properties inherited from class javafx.scene.control.SelectionModel

selectedIndex, selectedItem

Constructor Summary

Constructors

Constructor and Description
TableView.TableViewSelectionModel(TableView<S> tableView) Builds a default TableViewSelectionModel instance with the provided TableView.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanProperty	cellSelectionEnabledProperty() A boolean property used to represent whether the TableView is in row or cell selection modes.
abstract void	clearAndSelect(int row, TableColumn<S,?> column) Clears all selection, and then selects the cell at the given row/column intersection.
abstract void	clearSelection(int row, TableColumn<S,?> column) Removes selection from the specified row/column position (in view indexes).
abstract ObservableList<TablePosition>	getSelectedCells() A read-only ObservableList representing the currently selected cells in this TableView.
protected java.util.List<S>	getTableModel() Convenience method that returns getTableView().getItems().
TableView<S>	getTableView() Returns the TableView instance that this selection model is installed in.
boolean	isCellSelectionEnabled() Gets the value of the property cellSelectionEnabled.
abstract boolean	isSelected(int row, TableColumn<S,?> column) Convenience function which tests whether the given row and column index is currently selected in this TableView instance.
abstract void	select(int row, TableColumn<S,?> column) Selects the cell at the given row/column intersection.
abstract void	selectAboveCell() Selects the cell directly above the currently selected cell.
abstract void	selectBelowCell() Selects the cell directly below the currently selected cell.
abstract void	selectLeftCell() Selects the cell to the left of the currently selected cell.
abstract void	selectRightCell() Selects the cell to the right of the currently selected cell.
void	setCellSelectionEnabled(boolean value) Sets the value of the property cellSelectionEnabled.

Methods inherited from class javafx.scene.control.MultipleSelectionModel

getSelectedIndices, getSelectedItems, getSelectionMode, selectAll, selectFirst, selectIndices, selectionModeProperty, selectLast, selectRange, setSelectionMode

Methods inherited from class javafx.scene.control.SelectionModel

clearAndSelect, clearSelection, clearSelection, getSelectedIndex, getSelectedItem, isEmpty, isSelected, select, select, selectedIndexProperty, selectedItemProperty, selectNext, selectPrevious, setSelectedIndex, setSelectedItem

Methods inherited from class java.lang.Object

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

Property Detail

cellSelectionEnabled

public final BooleanProperty cellSelectionEnabledProperty

A boolean property used to represent whether the TableView is in row or cell selection modes. By default a TableView is in row selection mode which means that individual cells can not be selected. Setting cellSelectionEnabled to be true results in cells being able to be selected (but not rows).

See Also:

isCellSelectionEnabled(), setCellSelectionEnabled(boolean)

Constructor Detail

TableView.TableViewSelectionModel

public TableView.TableViewSelectionModel(TableView<S> tableView)

Builds a default TableViewSelectionModel instance with the provided TableView.

Parameters:

tableView - The TableView upon which this selection model should operate.

Throws:

java.lang.NullPointerException - TableView can not be null.

Method Detail

getSelectedCells

public abstract ObservableList<TablePosition> getSelectedCells()

A read-only ObservableList representing the currently selected cells in this TableView. Rather than directly modify this list, please use the other methods provided in the TableViewSelectionModel.

isSelected

public abstract boolean isSelected(int row,
                 TableColumn<S,?> column)

Convenience function which tests whether the given row and column index is currently selected in this TableView instance.

select

public abstract void select(int row,
          TableColumn<S,?> column)

Selects the cell at the given row/column intersection.

clearAndSelect

public abstract void clearAndSelect(int row,
                  TableColumn<S,?> column)

Clears all selection, and then selects the cell at the given row/column intersection.

clearSelection

public abstract void clearSelection(int row,
                  TableColumn<S,?> column)

Removes selection from the specified row/column position (in view indexes). If this particular cell (or row if the column value is -1) is not selected, nothing happens.

selectLeftCell

public abstract void selectLeftCell()

Selects the cell to the left of the currently selected cell.

selectRightCell

public abstract void selectRightCell()

Selects the cell to the right of the currently selected cell.

selectAboveCell

public abstract void selectAboveCell()

Selects the cell directly above the currently selected cell.

selectBelowCell

public abstract void selectBelowCell()

Selects the cell directly below the currently selected cell.

cellSelectionEnabledProperty

public final BooleanProperty cellSelectionEnabledProperty()

A boolean property used to represent whether the TableView is in row or cell selection modes. By default a TableView is in row selection mode which means that individual cells can not be selected. Setting cellSelectionEnabled to be true results in cells being able to be selected (but not rows).

See Also:

isCellSelectionEnabled(), setCellSelectionEnabled(boolean)

setCellSelectionEnabled

public final void setCellSelectionEnabled(boolean value)

Sets the value of the property cellSelectionEnabled.

Property description:

A boolean property used to represent whether the TableView is in row or cell selection modes. By default a TableView is in row selection mode which means that individual cells can not be selected. Setting cellSelectionEnabled to be true results in cells being able to be selected (but not rows).

isCellSelectionEnabled

public final boolean isCellSelectionEnabled()

Gets the value of the property cellSelectionEnabled.

Property description:

A boolean property used to represent whether the TableView is in row or cell selection modes. By default a TableView is in row selection mode which means that individual cells can not be selected. Setting cellSelectionEnabled to be true results in cells being able to be selected (but not rows).

getTableView

public TableView<S> getTableView()

Returns the TableView instance that this selection model is installed in.

getTableModel

protected java.util.List<S> getTableModel()

Convenience method that returns getTableView().getItems().

Returns:

The items list of the current TableView.