javafx.scene.control

Class TableView.TableViewSelectionModel<S>

java.lang.Object

javafx.scene.control.SelectionModel<T>

javafx.scene.control.MultipleSelectionModel<T>

javafx.scene.control.MultipleSelectionModelBase<T>

javafx.scene.control.TableSelectionModel<S>

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

Direct Known Subclasses:

TableView.TableViewArrayListSelectionModel

Enclosing class:

TableView<S>

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

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

Since:

JavaFX 2.0

Property Summary

Properties inherited from class javafx.scene.control.TableSelectionModel

cellSelectionEnabledProperty

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
(package private) boolean	blockFocusCall
private TableView<S>	tableView * Private fields * *

Fields inherited from class javafx.scene.control.MultipleSelectionModelBase

selectedIndices, selectedItemChange

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract void	clearAndSelect(int row, TableColumn<S,?> column) Clears all selection, and then selects the cell at the given row/column intersection.
void	clearAndSelect(int row, TableColumnBase<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).
void	clearSelection(int row, TableColumnBase<S,?> column) Removes selection from the specified row/column position (in view indexes).
void	focus(int row)
(package private) void	focus(int row, TableColumn<S,?> column) * Private implementation * *
(package private) void	focus(TablePosition<S,?> pos)
(package private) TablePosition<S,?>	getFocusedCell()
int	getFocusedIndex()
protected int	getItemCount() Returns the number of items in the data model that underpins the control.
protected S	getModelItem(int index) Returns the item at the given index.
abstract <any>	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.
abstract boolean	isSelected(int row, TableColumn<S,?> column) Convenience function which tests whether the given row and column index is currently selected in this table instance.
boolean	isSelected(int row, TableColumnBase<S,?> column) Convenience function which tests whether the given row and column index is currently selected in this table instance.
abstract void	select(int row, TableColumn<S,?> column) Selects the cell at the given row/column intersection.
void	select(int row, TableColumnBase<S,?> column) Selects the cell at the given row/column intersection.
void	selectRange(int minRow, TableColumnBase<S,?> minColumn, int maxRow, TableColumnBase<S,?> maxColumn) Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.

Methods inherited from class javafx.scene.control.TableSelectionModel

cellSelectionEnabledProperty, isCellSelectionEnabled, selectAboveCell, selectBelowCell, selectLeftCell, selectRightCell, setCellSelectionEnabled

Methods inherited from class javafx.scene.control.MultipleSelectionModelBase

clearAndSelect, clearSelection, clearSelection, 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

Field Detail

tableView

private final TableView<S> tableView

* Private fields * *

blockFocusCall

boolean blockFocusCall

Constructor Detail

TableViewSelectionModel

public 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 <any> 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.

Returns:

a read-only ObservableList representing the currently selected cells in this TableView

isSelected

public boolean isSelected(int row,
                          TableColumnBase<S,?> 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.

Specified by:

isSelected in class TableSelectionModel<S>

Parameters:

row - the row

column - the column

Returns:

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

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 table instance.

Parameters:

row - the row

column - the column

Returns:

true if row and column index is currently selected

select

public void select(int row,
                   TableColumnBase<S,?> 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.

Specified by:

select in class TableSelectionModel<S>

Parameters:

row - the row

column - the column

select

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

Selects the cell at the given row/column intersection.

Parameters:

row - the row

column - the column

clearAndSelect

public void clearAndSelect(int row,
                           TableColumnBase<S,?> 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.

Specified by:

clearAndSelect in class TableSelectionModel<S>

Parameters:

row - the row

column - the column

clearAndSelect

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

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

Parameters:

row - the row

column - the column

clearSelection

public void clearSelection(int row,
                           TableColumnBase<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. 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.

Specified by:

clearSelection in class TableSelectionModel<S>

Parameters:

row - the row

column - the column

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.

Parameters:

row - the row

column - the column

selectRange

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

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

Specified by:

selectRange in class TableSelectionModel<S>

Parameters:

minRow - the minRow

minColumn - the minColumn

maxRow - the maxRow

maxColumn - the maxColumn

getTableView

public TableView<S> getTableView()

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

Returns:

the TableView

getTableModel

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

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

Returns:

The items list of the current TableView.

getModelItem

protected S getModelItem(int index)

Returns the item at the given index. An example using ListView would be listView.getItems().get(index).

Specified by:

getModelItem in class MultipleSelectionModelBase<S>

Parameters:

index - The index of the item that is requested from the underlying data model.

Returns:

Returns null if the index is out of bounds, or an element of type T that is related to the given index.

getItemCount

protected int getItemCount()

Returns the number of items in the data model that underpins the control. An example would be that a ListView selection model would likely return listView.getItems().size(). The valid range of selectable indices is between 0 and whatever is returned by this method.

Specified by:

getItemCount in class MultipleSelectionModelBase<S>

Returns:

the number of items in the data model that underpins the control

focus

public void focus(int row)

Specified by:

focus in class MultipleSelectionModelBase<S>

getFocusedIndex

public int getFocusedIndex()

Specified by:

getFocusedIndex in class MultipleSelectionModelBase<S>

focus

void focus(int row,
           TableColumn<S,?> column)

* Private implementation * *

focus

void focus(TablePosition<S,?> pos)

getFocusedCell

TablePosition<S,?> getFocusedCell()