public abstract static class TreeTableView.TreeTableViewSelectionModel<S> extends TableSelectionModel<TreeItem<S>>
SelectionModel abstract class to
allow for special support for TreeTableView controls.cellSelectionEnabledselectionModeselectedIndex, selectedItem| Constructor and Description |
|---|
TreeTableViewSelectionModel(TreeTableView<S> treeTableView)
Builds a default TreeTableViewSelectionModel instance with the provided
TreeTableView.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clearAndSelect(int row)
A method that clears any selection prior to setting the selection to the
given index.
|
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 |
focus(int row) |
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.
|
ObservableList<Integer> |
getSelectedIndices()
Returns a read-only ObservableList of all selected indices.
|
ObservableList<T> |
getSelectedItems()
Returns a read-only ObservableList of all selected items.
|
TreeTableView<S> |
getTreeTableView()
Returns the TreeTableView instance that this selection model is installed in.
|
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.
|
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(T obj)
This method will attempt to select the index that contains the given
object.
|
void |
selectAll()
Convenience method to select all available indices.
|
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 |
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<TreeItem<S>,?> minColumn,
int maxRow,
TableColumnBase<TreeItem<S>,?> maxColumn)
Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn),
inclusive.
|
cellSelectionEnabledProperty, clearAndSelect, clearSelection, isCellSelectionEnabled, isSelected, select, selectAboveCell, selectBelowCell, selectLeftCell, selectRightCell, setCellSelectionEnabledgetSelectionMode, selectionModeProperty, selectRange, setSelectionModegetSelectedIndex, getSelectedItem, selectedIndexProperty, selectedItemProperty, setSelectedIndex, setSelectedItempublic TreeTableViewSelectionModel(TreeTableView<S> treeTableView)
treeTableView - The TreeTableView upon which this selection model should
operate.NullPointerException - TreeTableView can not be null.public abstract ObservableList<TreeTablePosition<S,?>> getSelectedCells()
public TreeTableView<S> getTreeTableView()
public TreeItem<S> getModelItem(int index)
listView.getItems().get(index).index - The index of the item that is requested from the underlying
data model.protected int getItemCount()
listView.getItems().size(). The valid range of selectable
indices is between 0 and whatever is returned by this method.public void focus(int row)
public int getFocusedIndex()
public void selectRange(int minRow,
TableColumnBase<TreeItem<S>,?> minColumn,
int maxRow,
TableColumnBase<TreeItem<S>,?> maxColumn)
selectRange in class TableSelectionModel<TreeItem<S>>public ObservableList<Integer> getSelectedIndices()
MultipleSelectionModelReturns a read-only ObservableList of all selected indices. The
ObservableList will be updated by the selection model to always reflect
changes in selection. This can be observed by adding a
ListChangeListener to the returned ObservableList.
getSelectedIndices in class MultipleSelectionModel<T>public ObservableList<T> getSelectedItems()
MultipleSelectionModelReturns a read-only ObservableList of all selected items. The
ObservableList will be updated further by the selection model to always reflect
changes in selection. This can be observed by adding a
ListChangeListener to the returned ObservableList.
getSelectedItems in class MultipleSelectionModel<T>public void clearAndSelect(int row)
SelectionModelSelectionModel.clearSelection() first, meaning that observers that are listening to
the selected index property will not
see the selected index being temporarily set to -1.clearAndSelect in class SelectionModel<T>row - The index that should be the only selected index in this
selection model.public void select(int row)
SelectionModelThis 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().
select in class SelectionModel<T>row - The position of the item to select in the selection model.public void select(T obj)
SelectionModelThis 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.
select in class SelectionModel<T>obj - The object to attempt to select in the underlying data model.public void selectIndices(int row,
int... rows)
MultipleSelectionModelThis 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.
selectIndices in class MultipleSelectionModel<T>public void selectAll()
MultipleSelectionModelConvenience method to select all available indices.
selectAll in class MultipleSelectionModel<T>public void selectFirst()
MultipleSelectionModelThis 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.
selectFirst in class MultipleSelectionModel<T>public void selectLast()
MultipleSelectionModelThis 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.
selectLast in class MultipleSelectionModel<T>public void clearSelection(int index)
SelectionModelThis method will clear the selection of the item in the given index. If the given index is not selected, nothing will happen.
clearSelection in class SelectionModel<T>index - The selected item to deselect.public void clearSelection()
SelectionModelClears the selection model of all selected indices.
clearSelection in class SelectionModel<T>public boolean isSelected(int index)
SelectionModelConvenience method to inform if the given index is currently selected
in this SelectionModel. Is functionally equivalent to calling
getSelectedIndices().contains(index).
isSelected in class SelectionModel<T>index - The index to check as to whether it is currently selected
or not.public boolean isEmpty()
SelectionModelisEmpty in class SelectionModel<T>public void selectPrevious()
SelectionModelThis 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:
If any of these conditions is false, no selection event will take place.
selectPrevious in class SelectionModel<T>public void selectNext()
SelectionModelThis 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:
If any of these conditions is false, no selection event will take place.
selectNext in class SelectionModel<T>Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.