TreeTableColumn
Related Docs:
object TreeTableColumn
| package control
Creates a TreeTableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.
Creates a TreeTableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.
The string to show when the TreeTableColumn is placed within the TreeTableView.
Creates a new TreeTableColumn from a JavaFX one.
Creates a new TreeTableColumn from a JavaFX one.
A JavaFX TreeTableColumn to be wrapped. Its default value is a new JavaFX TreeTableColumn.
Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"
Registers an event filter to this task.
Registers an event filter to this task. Registered event filters get an event before any associated event handlers.
Event class
the type of the events to receive by the filter
the filter to register that will filter event
Registers an event handler to this task.
Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.
Event class
the type of the events to receive by the handler
the handler to register that will manipulate event
Construct an event dispatch chain for this target.
Construct an event dispatch chain for this target.
The cell factory for all cells in this column.
The cell factory for all cells in this column. The cell factory is responsible for rendering the data contained within each TreeTableCell for a single TreeTableColumn.
By default TreeTableColumn uses a default cell factory, but this can be replaced with a custom implementation, for example to show data in a different way or to support editing. There is a lot of documentation on creating custom cell factories elsewhere (see Cell and TreeTableView for example).
Finally, there are a number of pre-built cell factories available in the javafx.scene.control.cell package.
Attempts to return an ObservableValue<T> for the given item (which is of type S).
Attempts to return an ObservableValue<T> for the given item (which is of type S). In other words, this method expects to receive an object from the underlying data model for the entire 'row' in the table, and it must return an ObservableValue<T> for the value in this specific column.
This is achieved by calling the cell value factory, and returning whatever it returns when passed a CellDataFeatures (see, for example, the CellDataFeatures classes belonging to TableColumn and TreeTableColumn for more information).
The item (of type S) for which an ObservableValue<T> is sought.
An ObservableValue<T> for this specific table column.
Attempts to return an ObservableValue<T> for the item in the given index (which is of type S).
Attempts to return an ObservableValue<T> for the item in the given index (which is of type S). In other words, this method expects to receive an integer value that is greater than or equal to zero, and less than the size of the underlying data model. If the index is valid, this method will return an ObservableValue<T> for this specific column.
This is achieved by calling the cell value factory, and returning whatever it returns when passed a CellDataFeatures (see, for example, the CellDataFeatures classes belonging to TableColumn and TreeTableColumn for more information).
The index of the item (of type S) for which an ObservableValue<T> is sought.
An ObservableValue<T> for this specific table column.
The cell value factory needs to be set to specify how to populate all cells within a single TreeTableColumn.
The cell value factory needs to be set to specify how to populate all cells within a single TreeTableColumn. A cell value factory is a Callback that provides a TreeTableColumn.CellDataFeatures instance, and expects an ObservableValue to be returned. The returned ObservableValue instance will be observed internally to allow for updates to the value to be immediately reflected on screen.
An example of how to set a cell value factory is:
// p.value returns the TreeItem[Person] instance for a particular TreeTableView row, // p.value.value returns the Person instance inside the TreeItem[Person] cellValueFactory = { p => p.value.value.firstName }
A common approach is to want to populate cells in a TreeTableColumn using a single value from a Java bean. To support this common scenario, there is the TreeItemPropertyValueFactory class. Refer to this class for more information on how to use it, but briefly here is how the above use case could be simplified using the TreeItemPropertyValueFactory class:
firstNameCol.cellValueFactory = new TreeItemPropertyValueFactory[Person,String]("firstName"))
This enables support for nested columns, which can be useful to group together related data.
This enables support for nested columns, which can be useful to group together related data. For example, we may have a 'Name' column with two nested columns for 'First' and 'Last' names.
This has no impact on the table as such - all column indices point to the leaf columns only, and it isn't possible to sort using the parent column, just the leaf columns. In other words, this is purely a visual feature.
An ObservableBuffer containing TableColumnBase instances (or subclasses) that are the children of this TableColumnBase. If these children TableColumnBase instances are set as visible, they will appear beneath this table column.
Comparator function used when sorting this TableColumnBase.
Comparator function used when sorting this TableColumnBase.
This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.
The CssMetaData of this Styleable.
The CssMetaData of this Styleable. This may be returned as an unmodifiable list.
A JavaFX TreeTableColumn to be wrapped.
A JavaFX TreeTableColumn to be wrapped. Its default value is a new JavaFX TreeTableColumn.
Specifies whether this TableColumnBase allows editing.
Specifies whether this TableColumnBase allows editing.
Verifies if a object is equals to this delegate.
Verifies if a object is equals to this delegate.
Object to be compared.
if the other object is equals to this delegate or not.
Returns a object that implements scalafx.event.EventHandlerDelegate.EventHandled.
Returns a object that implements scalafx.event.EventHandlerDelegate.EventHandled.
Registers an event filter.
Registers an event filter. Registered event filters get an event before any associated event handlers.
Example of filtering mouse events
pane.filterEvent(MouseEvent.Any) { me: MouseEvent => { me.eventType match { case MouseEvent.MousePressed => { ... } case MouseEvent.MouseDragged => { ... } case _ => { ... } } } }
or
pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
type JavaFX delegate of the event
ScalaFX type for J type wrapper.
type of events that will be handled.
code handling the event, see examples above.
Returns the actual value for a cell from the given item.
Returns the actual value for a cell from the given item.
Returns the actual value for a cell at a given row index (and which belongs to this TableColumnBase).
Returns the actual value for a cell at a given row index (and which belongs to this TableColumnBase).
The id of this Styleable.
The id of this Styleable.
IMPLEMENTATION NOTE: For this method was adopted the name getId instead id to not
conflict with its subclasses already have a method with this name which returns a
StringProperty.
A string representation of the CSS style associated with this specific Node.
A string representation of the CSS style associated with this specific Node.
IMPLEMENTATION NOTE: For this method was adopted the name getStyle instead style to not
conflict with its subclasses already have a method with this name which returns a
StringProperty.
The graphic in the TableColumnBase.
The graphic in the TableColumnBase.
Registers an event handler.
Registers an event handler. The handler is called when the node receives an Event of the specified type during the bubbling phase of event delivery.
Example of handling mouse events
pane.handleEvent(MouseEvent.Any) { me: MouseEvent => { me.eventType match { case MouseEvent.MousePressed => ... case MouseEvent.MouseDragged => ... case _ => {} } } }
or
pane.handleEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
type JavaFX delegate of the event
ScalaFX type for J type wrapper.
type of events that will be handled.
code handling the event, see examples above.
Returns a subscription that can be used to cancel/remove this event handler
Tests if this TableColumnBase has properties.
Tests if this TableColumnBase has properties.
The delegate hashcode
The id of this TableColumnBase.
The id of this TableColumnBase.
The maximum width the TableColumnBase is permitted to be resized to.
The maximum width the TableColumnBase is permitted to be resized to.
The minimum width the TableColumnBase is permitted to be resized to.
The minimum width the TableColumnBase is permitted to be resized to.
This event handler will be fired when the user cancels editing a cell.
This event handler will be fired when the user successfully commits their editing.
This event handler will be fired when the user successfully initiates editing.
This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.
This read-only property will always refer to the parent of this column, in the situation where nested columns are being used.
The preferred width of the TableColumnBase.
The preferred width of the TableColumnBase.
The pseudo-class state of this Styleable.
The pseudo-class state of this Styleable.
Unregisters a previously registered event filter from this task.
Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.
Event class
the event type from which to unregister
the filter to unregister
Unregisters a previously registered event handler from this task.
Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.
Event class
the event type from which to unregister
the handler to unregister
Used to indicate whether the width of this column can change.
Used to indicate whether the width of this column can change.
The sort node is commonly seen represented as a triangle that rotates on screen to indicate whether the TableColumnBase is part of the sort order, and if so, what position in the sort order it is in.
The sort node is commonly seen represented as a triangle that rotates on screen to indicate whether the TableColumnBase is part of the sort order, and if so, what position in the sort order it is in.
Used to state whether this column, if it is part of the TableView.sortOrder ObservableList, should be sorted in ascending or descending order.
A boolean property to toggle on and off the sortability of this column.
A boolean property to toggle on and off the sortability of this column.
The CSS style string associated to this TableColumnBase.
The CSS style string associated to this TableColumnBase.
A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.
Return the parent of this Styleable, or null if there is no parent.
Return the parent of this Styleable, or null if there is no parent.
getTreeTableView()
This is the text to show in the header for this column.
This is the text to show in the header for this column.
Returns the original delegate's toString() adding a [SFX] prefix.
The TreeTableView that this TreeTableColumn belongs to.
The type of this Styleable that is to be used in selector matching.
The type of this Styleable that is to be used in selector matching. This is analogous to an "element" in HTML. (CSS Type Selector).
"TreeTableColumn"
Returns a previously set Object property, or null if no such property has been set using the setUserData(Any) method.
Returns a previously set Object property, or null if no such property has been set using the setUserData(Any) method.
Toggling this will immediately toggle the visibility of this column, and all children columns.
Toggling this will immediately toggle the visibility of this column, and all children columns.
The width of this column.
The width of this column.
Wraps a JavaFX http://docs.oracle.com/javase/8/javafx/api/javafx/scene/control/TreeTableColumn.html
The type of the TreeTableView generic type (i.e. S == TreeTableView<S>)
The type of the content in all cells in this TreeTableColumn.
8.0