TreeTableViewSelectionModel

abstract class TreeTableViewSelectionModel[S](val delegate: TreeTableViewSelectionModel[S]) extends SFXDelegate[TreeTableViewSelectionModel[S]]

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

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

Wraps a JavaFX http://docs.oracle.com/javase/8/javafx/api/javafx/scene/control/TreeTableView.TreeTableViewSelectionModel.html

Value Params
delegate

A JavaFX TreeTableViewSelectionModel to be wrapped. Its default value is a new JavaFX TreeTableViewSelectionModel.

Constructor

Creates a new TreeTableViewSelectionModel from a JavaFX one.

Since

8.0

Companion
object
trait SFXDelegate[TreeTableViewSelectionModel[S]]
class Object
trait Matchable
class Any

Type members

Types

type Delegate = TreeTableViewSelectionModel[S]

Value members

Concrete methods

def clearAndSelect(row: Int): Unit

A method that clears any selection prior to setting the selection to the given index. The purpose of this method is to avoid having to call SelectionModel.clearSelection() first, meaning that observers that are listening to the selected index property will not see the selected index being temporarily set to -1.

A method that clears any selection prior to setting the selection to the given index. The purpose of this method is to avoid having to call SelectionModel.clearSelection() first, meaning that observers that are listening to the selected index property will not see the selected index being temporarily set to -1.

Value Params
row

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

def clearSelection(): Unit

Clears the selection model of all selected indices.

Clears the selection model of all selected indices.

def clearSelection(index: Int): Unit

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

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

Value Params
index

The selected item to deselect.

def focus(row: Int): Unit
def focusedIndex: Int
def isEmpty: Boolean

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.

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.

Returns

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

def isSelected(index: Int): Boolean

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

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

Value Params
index

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

Returns

True if the given index is selected, false otherwise.

def modelItem(index: Int): TreeItem[S]

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

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

Value Params
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 TreeItem[S] that is related to the given index.

def select(row: Int): Unit

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).

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().

Value Params
row

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

def select(obj: TreeItem[S]): Unit

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.

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.

Value Params
obj

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

def selectAll(): Unit

Convenience method to select all available indices.

Convenience method to select all available indices.

def selectFirst(): Unit

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.

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.

def selectIndices(row: Int, rows: Int*): Unit

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.

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.

def selectLast(): Unit

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.

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.

def selectNext(): Unit

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.

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.

def selectPrevious(): Unit

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.

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.

def selectRange(minRow: Int, minColumn: TableColumnBase[TreeItem[S], _], maxRow: Int, maxColumn: TableColumnBase[TreeItem[S], _]): Unit

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

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

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

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

Returns 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.

Returns 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.

def selectedItems: ObservableBuffer[TreeItem[S]]

Returns 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.

Returns 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.

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

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

Inherited methods

override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value Params
ref

Object to be compared.

Returns

if the other object is equals to this delegate or not.

Definition Classes
Inherited from
SFXDelegate
override def hashCode: Int
Returns

The delegate hashcode

Definition Classes
Inherited from
SFXDelegate
override def toString: String
Returns

Returns the original delegate's toString() adding a [SFX] prefix.

Definition Classes
Inherited from
SFXDelegate

Concrete fields

override val delegate: TreeTableViewSelectionModel[S]