javafx.scene.control

Class TreeTableView.TreeTableViewSelectionModel<S>

java.lang.Object

javafx.scene.control.SelectionModel<T>

javafx.scene.control.MultipleSelectionModel<T>

javafx.scene.control.MultipleSelectionModelBase<T>

javafx.scene.control.TableSelectionModel<TreeItem<S>>

javafx.scene.control.TreeTableView.TreeTableViewSelectionModel<S>

Direct Known Subclasses:

TreeTableView.TreeTableViewArrayListSelectionModel

Enclosing class:

TreeTableView<S>

public abstract static class TreeTableView.TreeTableViewSelectionModel<S>
extends TableSelectionModel<TreeItem<S>>

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

Since:

JavaFX 8.0

Nested Class Summary

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

MultipleSelectionModelBase.BitSetReadOnlyUnbackedObservableList, MultipleSelectionModelBase.ShiftParams

Field Summary

Fields

Modifier and Type	Field and Description
private TreeTableView<S>	treeTableView * Private fields * *

Fields inherited from class javafx.scene.control.MultipleSelectionModelBase

selectedIndices, selectedIndicesSeq, selectedItemChange

Constructor Summary

Constructors

Constructor and Description
TreeTableViewSelectionModel(TreeTableView<S> treeTableView) Builds a default TreeTableViewSelectionModel instance with the provided TreeTableView.

Method Summary

Modifier and Type	Method and Description
void	focus(int row)
private void	focus(int row, TreeTableColumn<S,?> column) * Private implementation * *
private void	focus(TreeTablePosition<S,?> pos)
private TreeTablePosition<S,?>	getFocusedCell()
int	getFocusedIndex()
protected int	getItemCount() Returns the number of items in the data model that underpins the control.
TreeItem<S>	getModelItem(int index) Returns the item at the given index.
abstract ObservableList<TreeTablePosition<S,?>>	getSelectedCells() A read-only ObservableList representing the currently selected cells in this TreeTableView.
TreeTableView<S>	getTreeTableView() Returns the TreeTableView instance that this selection model is installed in.
void	selectRange(int minRow, TableColumnBase<TreeItem<S>,?> minColumn, int maxRow, TableColumnBase<TreeItem<S>,?> maxColumn) Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.

Methods inherited from class javafx.scene.control.TableSelectionModel

cellSelectionEnabledProperty, clearAndSelect, clearSelection, isCellSelectionEnabled, isSelected, select, selectAboveCell, selectBelowCell, selectLeftCell, selectRightCell, setCellSelectionEnabled

Methods inherited from class javafx.scene.control.MultipleSelectionModelBase

clearAndSelect, clearSelection, clearSelection, createRangeChange, getSelectedIndices, getSelectedItems, isAtomic, isEmpty, isSelected, select, select, selectAll, selectFirst, selectIndices, selectLast, selectNext, selectPrevious, 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

treeTableView

private final TreeTableView<S> treeTableView

* Private fields * *

Constructor Detail

TreeTableViewSelectionModel

public TreeTableViewSelectionModel(TreeTableView<S> treeTableView)

Builds a default TreeTableViewSelectionModel instance with the provided TreeTableView.

Parameters:

treeTableView - The TreeTableView upon which this selection model should operate.

Throws:

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

Method Detail

getSelectedCells

public abstract ObservableList<TreeTablePosition<S,?>> getSelectedCells()

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

getTreeTableView

public TreeTableView<S> getTreeTableView()

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

getModelItem

public TreeItem<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<TreeItem<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<TreeItem<S>>

focus

public void focus(int row)

Specified by:

focus in class MultipleSelectionModelBase<TreeItem<S>>

getFocusedIndex

public int getFocusedIndex()

Specified by:

getFocusedIndex in class MultipleSelectionModelBase<TreeItem<S>>

selectRange

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

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

Specified by:

selectRange in class TableSelectionModel<TreeItem<S>>

focus

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

* Private implementation * *

focus

private void focus(TreeTablePosition<S,?> pos)

getFocusedCell

private TreeTablePosition<S,?> getFocusedCell()