TreeTableColumn

Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate1.EventHandled Type:

def addEventHandler   [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
def removeEventHandler[E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
def addEventFilter    [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
def removeEventFilter [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[E])
def buildEventDispatchChain(chain: jfxe.EventDispatchChain): jfxe.EventDispatchChain

Companion object implementing Magnet Pattern 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"

Creates a TreeTableColumn with the text set to the provided string, with default cell factory, comparator, and onEditCommit implementation.

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

Attempts to return an ObservableValue 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 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 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 simple complete example (from scalafx-demos SimpleTreeTableView):

 import scalafx.application.JFXApp
 import scalafx.application.JFXApp.PrimaryStage
 import scalafx.controls.tableview.Person
 import scalafx.scene.Scene
 import scalafx.scene.control.{TreeTableColumn, TreeTableView, TreeItem}
 import scalafx.scene.control.TreeTableColumn._

 object SimpleTreeTableView extends JFXApp {

   val treeRoot = new TreeItem[Person](new Person("Peggy", "Sue", "555-6798"))
   treeRoot.children.add(new TreeItem[Person](new Person("Rocky", "Raccoon", "555-6798")))


   stage = new PrimaryStage {
     title = "Simple Table View"
     scene = new Scene {
       content = new TreeTableView[Person](treeRoot) {
         columns ++= List(
           new TreeTableColumn[Person, String] {
             text = "First Name"
             cellValueFactory = {_.value.getValue.firstName}
             prefWidth = 180
           },
           new TreeTableColumn[Person, String]() {
             text = "Last Name"
             cellValueFactory = {_.value.getValue.lastName}
             prefWidth = 180
           }
         )
       }
     }
   }
 }

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 TreeItemPropertyValueFactoryPerson,String)

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.

The CssMetaData of this Styleable. This may be returned as an unmodifiable list.

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.

Used to state whether this column, if it is part of the TableView.sortOrder ObservableList, should be sorted in ascending or descending order.

The TreeTableView that this TreeTableColumn belongs to.

Registers an event filter to this task. Registered event filters get an event before any associated event handlers.

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.

Construct an event dispatch chain for this target.

Comparator function used when sorting this TableColumnBase.

This menu will be shown whenever the user right clicks within the header area of this TableColumnBase.

Specifies whether this TableColumnBase allows editing.

Verifies if a object is equals to this delegate.

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") }

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

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.

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.

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") }

Tests if this TableColumnBase has properties.

The id of this TableColumnBase.

The maximum width the TableColumnBase is permitted to be resized to.

The minimum width the TableColumnBase is permitted to be resized to.

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 pseudo-class state of this Styleable.

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.

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.

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.

A boolean property to toggle on and off the sortability of this column.

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.

Returns the Node that represents this Styleable object. This method should be overridden in cases where the Styleable is not itself a Node, so that it may optionally return the relevant root node representation of itself. By default this method returns null, which can mean that either the Styleable itself is a Node, or if that is not the case, that the Styleable does not have a node representation available at the time of request.

The parent of this Styleable, or null if there is no parent.

This is the text to show in the header for this column.

The type of this Styleable that is to be used in selector matching.

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.

The width of this column.