javafx.scene.control

Class TableView.TableViewArrayListSelectionModel<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>

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

Enclosing class:

TableView<S>

static class TableView.TableViewArrayListSelectionModel<S>
extends TableView.TableViewSelectionModel<S>

A primitive selection model implementation, using a List to store all selected indices.

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
private <any>	cellToIndicesMap
private int	itemCount
(package private) <any>	itemsContentListener
(package private) InvalidationListener	itemsPropertyListener
private int	previousModelSize * Internal properties * *
private <any>	selectedCellsMap * Observable properties (and getters/setters) * *
private <any>	selectedCellsSeq
private TableView<S>	tableView
(package private) <any>	weakItemsContentListener

Fields inherited from class javafx.scene.control.TableView.TableViewSelectionModel

blockFocusCall

Fields inherited from class javafx.scene.control.MultipleSelectionModelBase

selectedIndices, selectedItemChange

Constructor Summary

Constructors

Constructor and Description
TableViewArrayListSelectionModel(TableView<S> tableView) * Constructors * *

Method Summary

Modifier and Type	Method and Description
void	clearAndSelect(int row) * Public selection API * *
void	clearAndSelect(int row, TableColumn<S,?> column) Clears all selection, and then selects the cell at the given row/column intersection.
void	clearSelection() Clears the selection model of all selected indices.
void	clearSelection(int index) This method will clear the selection of the item in the given index.
void	clearSelection(int row, TableColumn<S,?> column) Removes selection from the specified row/column position (in view indexes).
private void	clearSelection(TablePosition<S,?> tp)
private void	dispose()
private void	fireCustomSelectedCellsListChangeEvent(<any> c)
protected int	getItemCount() Returns the number of items in the data model that underpins the control.
<any>	getSelectedCells() A read-only ObservableList representing the currently selected cells in this TableView.
private TableColumn<S,?>	getTableColumn(int pos)
private TableColumn<S,?>	getTableColumn(TableColumn<S,?> column, int offset)
boolean	isEmpty() This method is available to test whether there are any selected indices/items.
boolean	isSelected(int index) Convenience method to inform if the given index is currently selected in this SelectionModel.
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.
private void	quietClearSelection()
void	select(int row) This will select the given index in the selection model, assuming the index is within the valid range (i.e.
void	select(int row, TableColumn<S,?> column) Selects the cell at the given row/column intersection.
void	select(S obj) This method will attempt to select the index that contains the given object.
void	selectAboveCell() Selects the cell directly above the currently selected cell.
void	selectAll() Convenience method to select all available indices.
void	selectBelowCell() Selects the cell directly below the currently selected cell.
void	selectFirst() This method will attempt to select the first index in the control.
void	selectIndices(int row, int... rows) This method allows for one or more selections to be set at the same time.
void	selectLast() This method will attempt to select the last index in the control.
void	selectLeftCell() Selects the cell to the left of the currently selected cell.
void	selectNext() This method will attempt to select the index directly after the current focused index.
void	selectPrevious() This method will attempt to select the index directly before the current focused index.
void	selectRange(int minRow, TableColumnBase<S,?> minColumn, int maxRow, TableColumnBase<S,?> maxColumn) Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.
void	selectRightCell() Selects the cell to the right of the currently selected cell.
private void	updateDefaultSelection()
private void	updateItemCount()
private void	updateItemsObserver(<any> oldList, <any> newList) * Support code * *
private void	updateSelectedIndex(int row)
private void	updateSelection(<any> c)

Methods inherited from class javafx.scene.control.TableView.TableViewSelectionModel

clearAndSelect, clearSelection, focus, focus, focus, getFocusedCell, getFocusedIndex, getModelItem, getTableModel, getTableView, isSelected, select

Methods inherited from class javafx.scene.control.TableSelectionModel

cellSelectionEnabledProperty, isCellSelectionEnabled, setCellSelectionEnabled

Methods inherited from class javafx.scene.control.MultipleSelectionModelBase

getSelectedIndices, getSelectedItems, isAtomic, 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

itemCount

private int itemCount

cellToIndicesMap

private final <any> cellToIndicesMap

tableView

private final TableView<S> tableView

itemsPropertyListener

final InvalidationListener itemsPropertyListener

itemsContentListener

final <any> itemsContentListener

weakItemsContentListener

final <any> weakItemsContentListener

selectedCellsMap

private final <any> selectedCellsMap

* Observable properties (and getters/setters) * *

selectedCellsSeq

private final <any> selectedCellsSeq

previousModelSize

private int previousModelSize

* Internal properties * *

Constructor Detail

TableViewArrayListSelectionModel

public TableViewArrayListSelectionModel(TableView<S> tableView)

* Constructors * *

Method Detail

dispose

private void dispose()

getSelectedCells

public <any> getSelectedCells()

Description copied from class: TableView.TableViewSelectionModel

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.

Specified by:

getSelectedCells in class TableView.TableViewSelectionModel<S>

Returns:

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

updateSelection

private void updateSelection(<any> c)

clearAndSelect

public void clearAndSelect(int row)

* Public selection API * *

Overrides:

clearAndSelect in class MultipleSelectionModelBase<S>

Parameters:

row - The index that should be the only selected index in this selection model.

clearAndSelect

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

Description copied from class: TableView.TableViewSelectionModel

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

Specified by:

clearAndSelect in class TableView.TableViewSelectionModel<S>

Parameters:

row - the row

column - the column

select

public void select(int row)

Description copied from class: SelectionModel

This will select the given index in the selection model, assuming the index is within the valid range (i.e. greater than or equal to zero, and less than the total number of items in the underlying data model).

If there is already one or more indices selected in this model, calling this method will not clear these selections - to do so it is necessary to first call SelectionModel.clearSelection().

If the index is already selected, it will not be selected again, or unselected. However, if multiple selection is implemented, then calling select on an already selected index will have the effect of making the index the new selected index (as returned by SelectionModel.getSelectedIndex().

Overrides:

select in class MultipleSelectionModelBase<S>

Parameters:

row - The position of the item to select in the selection model.

select

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

Description copied from class: TableView.TableViewSelectionModel

Selects the cell at the given row/column intersection.

Specified by:

select in class TableView.TableViewSelectionModel<S>

Parameters:

row - the row

column - the column

select

public void select(S obj)

Description copied from class: SelectionModel

This method will attempt to select the index that contains the given object. It will iterate through the underlying data model until it finds an item whose value is equal to the given object. At this point it will stop iterating - this means that this method will not select multiple indices.

Overrides:

select in class MultipleSelectionModelBase<S>

Parameters:

obj - The object to attempt to select in the underlying data model.

selectIndices

public void selectIndices(int row,
                          int... rows)

Description copied from class: MultipleSelectionModel

This method allows for one or more selections to be set at the same time. It will ignore any value that is not within the valid range (i.e. greater than or equal to zero, and less than the total number of items in the underlying data model). Any duplication of indices will be ignored.

If there is already one or more indices selected in this model, calling this method will not clear these selections - to do so it is necessary to first call clearSelection.

The last valid value given will become the selected index / selected item.

Overrides:

selectIndices in class MultipleSelectionModelBase<S>

Parameters:

row - the first index to select

rows - zero or more additional indices to select

selectAll

public void selectAll()

Description copied from class: MultipleSelectionModel

Convenience method to select all available indices.

Overrides:

selectAll in class MultipleSelectionModelBase<S>

selectRange

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

Description copied from class: TableView.TableViewSelectionModel

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

Overrides:

selectRange in class TableView.TableViewSelectionModel<S>

Parameters:

minRow - the minRow

minColumn - the minColumn

maxRow - the maxRow

maxColumn - the maxColumn

clearSelection

public void clearSelection(int index)

Description copied from class: SelectionModel

This method will clear the selection of the item in the given index. If the given index is not selected, nothing will happen.

Overrides:

clearSelection in class MultipleSelectionModelBase<S>

Parameters:

index - The selected item to deselect.

clearSelection

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

Description copied from class: TableView.TableViewSelectionModel

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.

Specified by:

clearSelection in class TableView.TableViewSelectionModel<S>

Parameters:

row - the row

column - the column

clearSelection

private void clearSelection(TablePosition<S,?> tp)

clearSelection

public void clearSelection()

Description copied from class: SelectionModel

Clears the selection model of all selected indices.

Overrides:

clearSelection in class MultipleSelectionModelBase<S>

quietClearSelection

private void quietClearSelection()

isSelected

public boolean isSelected(int index)

Description copied from class: SelectionModel

Convenience method to inform if the given index is currently selected in this SelectionModel. Is functionally equivalent to calling getSelectedIndices().contains(index).

Overrides:

isSelected in class MultipleSelectionModelBase<S>

Parameters:

index - The index to check as to whether it is currently selected or not.

Returns:

True if the given index is selected, false otherwise.

isSelected

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

Description copied from class: TableView.TableViewSelectionModel

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

Specified by:

isSelected in class TableView.TableViewSelectionModel<S>

Parameters:

row - the row

column - the column

Returns:

true if row and column index is currently selected

isEmpty

public boolean isEmpty()

Description copied from class: SelectionModel

This method is available to test whether there are any selected indices/items. It will return true if there are no selected items, and false if there are.

Overrides:

isEmpty in class MultipleSelectionModelBase<S>

Returns:

Will return true if there are no selected items, and false if there are.

selectPrevious

public void selectPrevious()

Description copied from class: SelectionModel

This method will attempt to select the index directly before the current focused index. If clearSelection is not called first, this method will have the result of selecting the previous index, whilst retaining the selection of any other currently selected indices.

Calling this method will only succeed if:

• There is currently a lead/focused index.
• The lead/focus index is not the first index in the control.
• The previous index is not already selected.

If any of these conditions is false, no selection event will take place.

Overrides:

selectPrevious in class MultipleSelectionModelBase<S>

selectNext

public void selectNext()

Description copied from class: SelectionModel

This method will attempt to select the index directly after the current focused index. If clearSelection is not called first, this method will have the result of selecting the next index, whilst retaining the selection of any other currently selected indices.

Calling this method will only succeed if:

• There is currently a lead/focused index.
• The lead/focus index is not the last index in the control.
• The next index is not already selected.

If any of these conditions is false, no selection event will take place.

Overrides:

selectNext in class MultipleSelectionModelBase<S>

selectAboveCell

public void selectAboveCell()

Description copied from class: TableSelectionModel

Selects the cell directly above the currently selected cell.

Specified by:

selectAboveCell in class TableSelectionModel<S>

selectBelowCell

public void selectBelowCell()

Description copied from class: TableSelectionModel

Selects the cell directly below the currently selected cell.

Specified by:

selectBelowCell in class TableSelectionModel<S>

selectFirst

public void selectFirst()

Description copied from class: MultipleSelectionModel

This method will attempt to select the first index in the control. If clearSelection is not called first, this method will have the result of selecting the first index, whilst retaining the selection of any other currently selected indices.

If the first index is already selected, calling this method will have no result, and no selection event will take place.

Overrides:

selectFirst in class MultipleSelectionModelBase<S>

selectLast

public void selectLast()

Description copied from class: MultipleSelectionModel

This method will attempt to select the last index in the control. If clearSelection is not called first, this method will have the result of selecting the last index, whilst retaining the selection of any other currently selected indices.

If the last index is already selected, calling this method will have no result, and no selection event will take place.

Overrides:

selectLast in class MultipleSelectionModelBase<S>

selectLeftCell

public void selectLeftCell()

Description copied from class: TableSelectionModel

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

Specified by:

selectLeftCell in class TableSelectionModel<S>

selectRightCell

public void selectRightCell()

Description copied from class: TableSelectionModel

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

Specified by:

selectRightCell in class TableSelectionModel<S>

updateItemsObserver

private void updateItemsObserver(<any> oldList,
                                 <any> newList)

* Support code * *

updateDefaultSelection

private void updateDefaultSelection()

getTableColumn

private TableColumn<S,?> getTableColumn(int pos)

getTableColumn

private TableColumn<S,?> getTableColumn(TableColumn<S,?> column,
                                        int offset)

updateSelectedIndex

private void updateSelectedIndex(int row)

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.

Overrides:

getItemCount in class TableView.TableViewSelectionModel<S>

Returns:

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

updateItemCount

private void updateItemCount()

fireCustomSelectedCellsListChangeEvent

private void fireCustomSelectedCellsListChangeEvent(<any> c)