scalafx.scene.control.TreeTableView
TreeTableViewSelectionModel
Companion object TreeTableViewSelectionModel
abstract class TreeTableViewSelectionModel[S] extends SFXDelegate[javafx.scene.control.TreeTableView.TreeTableViewSelectionModel[S]]
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
- Source
- TreeTableView.scala
- Since
8.0
- Alphabetic
- By Inheritance
- TreeTableViewSelectionModel
- SFXDelegate
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
TreeTableViewSelectionModel(delegate: javafx.scene.control.TreeTableView.TreeTableViewSelectionModel[S])
Creates a new TreeTableViewSelectionModel from a JavaFX one.
Creates a new TreeTableViewSelectionModel from a JavaFX one.
- delegate
A JavaFX TreeTableViewSelectionModel to be wrapped. Its default value is a new JavaFX TreeTableViewSelectionModel.
Type Members
- type Delegate = javafx.scene.control.TreeTableView.TreeTableViewSelectionModel[S]
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clearAndSelect(row: Int): Unit
A method that clears any selection prior to setting the selection to the given index.
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.
- row
The index that should be the only selected index in this selection model.
-
def
clearSelection(index: Int): Unit
This method will clear the selection of the item in the given index.
This method will clear the selection of the item in the given index. If the given index is not selected, nothing will happen.
- index
The selected item to deselect.
-
def
clearSelection(): Unit
Clears the selection model of all selected indices.
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
val
delegate: javafx.scene.control.TreeTableView.TreeTableViewSelectionModel[S]
JavaFX object to be wrapped.
JavaFX object to be wrapped.
- Definition Classes
- TreeTableViewSelectionModel → SFXDelegate
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(ref: Any): Boolean
Verifies if a object is equals to this delegate.
Verifies if a object is equals to this delegate.
- ref
Object to be compared.
- returns
if the other object is equals to this delegate or not.
- Definition Classes
- SFXDelegate → AnyRef → Any
- def focus(row: Int): Unit
- def focusedIndex: Int
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- returns
The delegate hashcode
- Definition Classes
- SFXDelegate → AnyRef → Any
-
def
isEmpty: Boolean
This method is available to test whether there are any selected indices/items.
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.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isSelected(index: Int): Boolean
Convenience method to inform if the given index is currently selected in this SelectionModel.
Convenience method to inform if the given index is currently selected in this SelectionModel. Is functionally equivalent to calling getSelectedIndices().contains(index).
- 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.
Returns the item at the given index. An example using ListView would be listView.getItems().get(index).
- 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.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
select(obj: TreeItem[S]): Unit
This method will attempt to select the index that contains the given object.
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.
- obj
The object to attempt to select in the underlying data model.
-
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.
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().
- row
The position of the item to select in the selection model.
-
def
selectAll(): Unit
Convenience method to select all available indices.
-
def
selectFirst(): Unit
This method will attempt to select the first index in the control.
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.
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.
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.
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.
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[javafx.scene.control.TreeItem[S], _], maxRow: Int, maxColumn: TableColumnBase[javafx.scene.control.TreeItem[S], _]): Unit
Selects the cells in the range (minRow, minColumn) to (maxRow, maxColumn), inclusive.
-
def
selectedCells: ObservableBuffer[TreeTablePosition[S, _]]
A read-only ObservableBuffer representing the currently selected cells in this TreeTableView.
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.
-
def
selectedIndices: ObservableBuffer[Integer]
Returns a read-only ObservableList of all selected indices.
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[javafx.scene.control.TreeItem[S]]
Returns a read-only ObservableList of all selected items.
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- returns
Returns the original delegate's
toString()
adding a[SFX]
prefix.
- Definition Classes
- SFXDelegate → AnyRef → Any
-
def
treeTableView: TreeTableView[S]
Returns the TreeTableView instance that this selection model is installed in.
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8. This means that every ScalaFX application is also a valid Scala application. By extension it supports full interoperability with Java and can run anywhere the Java Virtual Machine (JVM) and JavaFX 2.0 or JavaFX 8 are supported.
Package Structure
ScalaFX package structure corresponds to JavaFX package structure, for instance
scalafx.animation
corresponds tojavafx.animation
.Example Usage
A basic ScalaFX application is created creating an object that is an instance of
JFXApp
. Following Java FX theatre metaphor, it contains astage
that contains ascene
. Astage
roughly corresponds to a window in a typical UI environment. Thescene
holds UI content presented to the user. In the example below, the content is a pane with a singlelabel
component.