public Class NoSelectionModel<T>

Implements abstract javafx.scene.control.SelectionModel.clearAndSelect.

Doc from javafx.scene.control.SelectionModel.clearAndSelect.

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 clearSelection() first, meaning that observers that are listening to the selected index property will not see the selected index being temporarily set to -1.

Parameters

index:int

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

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.clearSelection.

Doc from javafx.scene.control.SelectionModel.clearSelection.

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

Parameters

index:int

The selected item to deselect.

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.clearSelection.

Doc from javafx.scene.control.SelectionModel.clearSelection.

Clears the selection model of all selected indices.

Annotations

@Override

Implements abstract javafx.scene.control.MultipleSelectionModel.getSelectedIndices.

Doc from javafx.scene.control.MultipleSelectionModel.getSelectedIndices.

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:ObservableList<Integer>

the list of selected indices

Annotations

@Override

Implements abstract javafx.scene.control.MultipleSelectionModel.getSelectedItems.

Doc from javafx.scene.control.MultipleSelectionModel.getSelectedItems.

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:ObservableList<T>

the list of selected items

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.isEmpty.

Doc from javafx.scene.control.SelectionModel.isEmpty.

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:boolean

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

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.isSelected.

Doc from javafx.scene.control.SelectionModel.isSelected.

This method tests whether the given index is currently selected in this SelectionModel.

Parameters

index:int

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

Returns:boolean

True if the given index is selected, false otherwise.

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.select.

Doc from javafx.scene.control.SelectionModel.select.

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

Parameters

index:int

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

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.select.

Doc from javafx.scene.control.SelectionModel.select.

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.

Parameters

obj:T

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

Annotations

@Override

Implements abstract javafx.scene.control.MultipleSelectionModel.selectAll.

Doc from javafx.scene.control.MultipleSelectionModel.selectAll.

Convenience method to select all available indices.

Annotations

@Override

Implements abstract javafx.scene.control.MultipleSelectionModel.selectFirst.

Doc from javafx.scene.control.MultipleSelectionModel.selectFirst.

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.

Annotations

@Override

Implements abstract javafx.scene.control.MultipleSelectionModel.selectIndices.

Doc from javafx.scene.control.MultipleSelectionModel.selectIndices.

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.

Parameters

index:int

the first index to select

indices:int[]

zero or more additional indices to select

Annotations

@Override

Implements abstract javafx.scene.control.MultipleSelectionModel.selectLast.

Doc from javafx.scene.control.MultipleSelectionModel.selectLast.

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.

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.selectNext.

Doc from javafx.scene.control.SelectionModel.selectNext.

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.

Annotations

@Override

Implements abstract javafx.scene.control.SelectionModel.selectPrevious.

Doc from javafx.scene.control.SelectionModel.selectPrevious.

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.

Annotations

@Override