javafx.scene.control

Class TableSelectionModel<T>

java.lang.Object

javafx.scene.control.SelectionModel<T>

javafx.scene.control.MultipleSelectionModel<T>

javafx.scene.control.MultipleSelectionModelBase<T>

javafx.scene.control.TableSelectionModel<T>

Type Parameters:

T - The type of the underlying data model for the UI control.

Direct Known Subclasses:

TableView.TableViewSelectionModel, TreeTableView.TreeTableViewSelectionModel

public abstract class TableSelectionModel<T>
extends MultipleSelectionModelBase<T>

The abstract base class for MultipleSelectionModel implementations that are used within table-like controls (most notably TableView and TreeTableView.

Since:

JavaFX 8.0

Property Summary

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

Properties inherited from class javafx.scene.control.MultipleSelectionModel

selectionModeProperty

Properties inherited from class javafx.scene.control.SelectionModel

selectedIndexProperty, selectedItemProperty

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.MultipleSelectionModelBase

MultipleSelectionModelBase.SelectedIndicesList, MultipleSelectionModelBase.ShiftParams

Field Summary

Fields

Modifier and Type	Field and Description
private BooleanProperty	cellSelectionEnabled A boolean property used to represent whether the table is in row or cell selection modes.

Fields inherited from class javafx.scene.control.MultipleSelectionModelBase

selectedIndices, selectedItemChange

Constructor Summary

Constructors

Constructor and Description
TableSelectionModel()

Method Summary

Modifier and Type	Method and Description
BooleanProperty	cellSelectionEnabledProperty() A boolean property used to represent whether the table is in row or cell selection modes.
abstract void	clearAndSelect(int row, TableColumnBase<T,?> column) Clears all selection, and then selects the cell at the given row/column intersection.
abstract void	clearSelection(int row, TableColumnBase<T,?> column) Removes selection from the specified row/column position (in view indexes).
boolean	isCellSelectionEnabled() Gets the value of the property cellSelectionEnabled.
abstract boolean	isSelected(int row, TableColumnBase<T,?> column) Convenience function which tests whether the given row and column index is currently selected in this table instance.
abstract void	select(int row, TableColumnBase<T,?> 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	selectRange(int minRow, TableColumnBase<T,?> minColumn, int maxRow, TableColumnBase<T,?> maxColumn) Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.
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.MultipleSelectionModelBase

clearAndSelect, clearSelection, clearSelection, focus, getFocusedIndex, getItemCount, getModelItem, getSelectedIndices, getSelectedItems, isAtomic, isEmpty, isSelected, select, select, selectAll, selectFirst, selectIndices, selectLast, selectNext, selectPrevious, shiftSelection, shiftSelection, startAtomic, stopAtomic

Methods inherited from class javafx.scene.control.MultipleSelectionModel

getSelectionMode, selectionModeProperty, selectRange, setSelectionMode

Methods inherited from class javafx.scene.control.SelectionModel

getSelectedIndex, getSelectedItem, selectedIndexProperty, selectedItemProperty, 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 table is in row or cell selection modes. By default a table 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)

Field Detail

cellSelectionEnabled

private BooleanProperty cellSelectionEnabled

A boolean property used to represent whether the table is in row or cell selection modes. By default a table 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).

Constructor Detail

TableSelectionModel

public TableSelectionModel()

Method Detail

isSelected

public abstract boolean isSelected(int row,
                                   TableColumnBase<T,?> column)

Convenience function which tests whether the given row and column index is currently selected in this table instance. If the table control is in its 'cell selection' mode (where individual cells can be selected, rather than entire rows), and if the column argument is null, this method should return true only if all cells in the given row are selected.

Parameters:

row - the row

column - the column

Returns:

true if the given row and column index is currently selected in this table instance

select

public abstract void select(int row,
                            TableColumnBase<T,?> column)

Selects the cell at the given row/column intersection. If the table control is in its 'cell selection' mode (where individual cells can be selected, rather than entire rows), and if the column argument is null, this method should select all cells in the given row.

Parameters:

row - the row

column - the column

clearAndSelect

public abstract void clearAndSelect(int row,
                                    TableColumnBase<T,?> column)

Clears all selection, and then selects the cell at the given row/column intersection. If the table control is in its 'cell selection' mode (where individual cells can be selected, rather than entire rows), and if the column argument is null, this method should select all cells in the given row.

Parameters:

row - the row

column - the column

clearSelection

public abstract void clearSelection(int row,
                                    TableColumnBase<T,?> 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. If the table control is in its 'cell selection' mode (where individual cells can be selected, rather than entire rows), and if the column argument is null, this method should deselect all cells in the given row.

Parameters:

row - the row

column - the column

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.

selectRange

public abstract void selectRange(int minRow,
                                 TableColumnBase<T,?> minColumn,
                                 int maxRow,
                                 TableColumnBase<T,?> maxColumn)

Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.

Parameters:

minRow - the minRow

minColumn - the minColumn

maxRow - the maxRow

maxColumn - the maxColumn

cellSelectionEnabledProperty

public final BooleanProperty cellSelectionEnabledProperty()

A boolean property used to represent whether the table is in row or cell selection modes. By default a table 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.

isCellSelectionEnabled

public final boolean isCellSelectionEnabled()

Gets the value of the property cellSelectionEnabled.