TreeTableView

Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate2.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

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"

Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

Creates a TreeTableView with the provided root node.

Refer to the TreeTableView class documentation for details on the default state of other properties.

This is the function called when the user completes a column-resize operation. The two most common policies are available as static functions in the TableView class: TreeTableView#UNCONSTRAINED_RESIZE_POLICY and TreeTableView#CONSTRAINED_RESIZE_POLICY.

The TreeTableColumns that are part of this TableView. As the user reorders the TableView columns, this list will be updated to reflect the current visual ordering.

Note: to display any data in a TableView, there must be at least one TreeTableColumn in this ObservableList.

The comparator property is a read-only property that is representative of the current state of the sort order list. The sort order list contains the columns that have been added to it either programmatically or via a user clicking on the headers themselves.

Returns the CssMetaData associated with this class, which may include the CssMetaData of its super classes.

Causes the cell at the given row/column view indexes to switch into its editing state, if it is not already in it, and assuming that the TableView and column are also editable.

Specifies whether this TreeTableView is editable - only if the TreeTableView and the TreeCells within it are both editable will a TreeCell be able to go into their editing state.

Represents the current cell being edited, or null if there is no cell being edited.

Represents the number of tree nodes presently able to be visible in the TreeTableView. This is essentially the count of all expanded tree items, and their children.

For example, if just the root node is visible, the expandedItemCount will be one. If the root had three children and the root was expanded, the value will be four.

Specifies whether this control has cells that are a fixed height (of the specified value). If this value is less than or equal to zero, then all cells are individually sized and positioned. This is a slow operation. Therefore, when performance matters and developers are not dependent on variable cell sizes it is a good idea to set the fixed cell size value. Generally cells are around 24px, so setting a fixed cell size of 24 is likely to result in very little difference in visuals, but a improvement to performance.

To set this property via CSS, use the -fx-fixed-cell-size property. This should not be confused with the -fx-cell-size property. The difference between these two CSS properties is that -fx-cell-size will size all cells to the specified size, but it will not enforce that this is the only size (thus allowing for variable cell sizes, and preventing the performance gains from being possible). Therefore, when performance matters use -fx-fixed-cell-size, instead of -fx-cell-size. If both properties are specified in CSS, -fx-fixed-cell-size takes precedence.

The FocusModel provides the API through which it is possible to control focus on zero or one rows of the TreeTableView. Generally the default implementation should be more than sufficient.

Called when there's a request to scroll an index into view using scrollTo

Called when there's a request to scroll a column into view using scrollToColumn(TreeTableColumn) or scrollToColumnIndex(int)

Called when there's a request to sort the control.

This Node is shown to the user when the table has no content to show. This may be the case because the table model has no data in the first place, that a filter has been applied to the table model, resulting in there being nothing to show the user, or that there are no currently visible columns.

Applies the currently installed resize policy against the given column, resizing it based on the delta value provided.

Property representing the root node of the TreeView.

Returns the index position of the given TreeItem, taking into account the current state of each TreeItem (i.e. whether or not it is expanded).

A function which produces a TreeTableRow. The system is responsible for reusing TreeTableRows. Return from this function a TreeTableRow which might be usable for representing a single row in a TableView.

Note that a TreeTableRow is not a TableCell. A TreeTableRow is simply a container for a TableCell, and in most circumstances it is more likely that you'll want to create custom TableCells, rather than TreeTableRows. The primary use case for creating custom TreeTableRow instances would most probably be to introduce some form of column spanning support.

You can create custom TableCell instances per column by assigning the appropriate function to the cellFactory property in the TreeTableColumn class.

Scrolls the TreeTableView such that the item in the given index is visible to the end user.

Scrolls the TreeTableView so that the given column is visible within the viewport.

Scrolls the TreeTableView so that the given index is visible within the viewport.

The SelectionModel provides the API through which it is possible to select single or multiple items within a TreeTableView, as well as inspect which rows have been selected by the user. Note that it has a generic type that must match the type of the TreeTableView itself.

Property that represents whether or not the TreeView root node is visible.

The sort method forces the TreeTableView to re-run its sorting algorithm. More often than not it is not necessary to call this method directly, as it is automatically called when the sort order, sort policy, or the state of the TreeTableColumn sort type properties change. In other words, this method should only be called directly when something external changes and a sort is required.

Specifies the sort mode to use when sorting the contents of this TreeTableView, should any columns be specified in the sort order list.

The sortOrder list defines the order in which TreeTableColumn instances are sorted. An empty sortOrder list means that no sorting is being applied on the TableView. If the sortOrder list has one TreeTableColumn within it, the TableView will be sorted using the sortType and comparator properties of this TreeTableColumn (assuming TreeTableColumn.sortable is true). If the sortOrder list contains multiple TreeTableColumn instances, then the TableView is firstly sorted based on the properties of the first TreeTableColumn. If two elements are considered equal, then the second TreeTableColumn in the list is used to determine ordering. This repeats until the results from all TreeTableColumn comparators are considered, if necessary.

The sort policy specifies how sorting in this TreeTableView should be performed. For example, a basic sort policy may just recursively sort the children of the root tree item, whereas a more advanced sort policy may call to a database to perform the necessary sorting on the server-side.

TreeTableView ships with a default sort policy that does precisely as mentioned above: it simply attempts to sort the tree hierarchy in-place.

It is recommended that rather than override the sort method that a different sort policy be provided instead.

This controls whether a menu button is available when the user clicks in a designated space within the TableView, within which is a radio menu item for each TreeTableColumn in this table. This menu allows for the user to show and hide all TreeTableColumns easily.

Property that represents which column should have the disclosure node shown in it (that is, the column with the arrow). By default this will be the left-most column if this property is null, otherwise it will be the specified column assuming it is non-null and contained within the visible leaf columns list.

Returns the TreeItem in the given index, or null if it is out of bounds.

Returns the number of levels of 'indentation' of the given TreeItem, based on how many times getParent() can be recursively called. If the given TreeItem is the root node of this TreeTableView, or if the TreeItem does not have any parent set, the returned value will be zero. For each time getParent() is recursively called, the returned value is incremented by one.

Returns the TreeTableColumn in the given column index, relative to all other visible leaf columns.

Returns an unmodifiable list containing the currently visible leaf columns.

Returns the position of the given column, relative to all other visible leaf columns.

Returns the number of levels of 'indentation' of the given TreeItem, based on how many times getParent() can be recursively called. DEPRECATED:

The accessible help text for this Node.

The help text provides a more detailed description of the accessible text for a node. By default, if the node has a tool tip, this text is used.

Default value is null.

The accessible role for this Node.

The screen reader uses the role of a node to determine the attributes and actions that are supported.

The role description of this Node.

Noramlly, when a role is provided for a node, the screen reader speaks the role as well as the contents of the node. When this value is set, it is possbile to override the default. This is useful because the set of roles is predefined. For example, it is possible to set the role of a node to be a button, but have the role description be arbitrary text.

Default value is null.

The accessible text for this Node.

This property is used to set the text that the screen reader will speak. If a node normally speaks text, that text is overriden. For example, a button usually speaks using the text in the control but will no longer do this when this value is set.

Default value is null.

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.

Pseudo-property that indicates this Node position inside its respective parent.

Sets this Node's alignment constraint inside its Parent. If set, will override the Parent's default alignment. Setting the value to null will remove the constraint. Internally it calls setAlignment(Node, Pos) static method JavaFX's BorderPane, StackPane and TilePane. Furthermore, it is set halignment and valignment property (using JavaFX Node's getProperties()) and called javafx.geometry.HPos) setHalignment and javafx.geometry.VPos) setValignment static methods from GridPane; this time using hpos and vpos from Pos argument. Besides, it sets this node alignment property towards JavaFX Node's getProperties() and setAlignment static method from

'''Do not confuse''' with alignment property from scalafx.delegate.AlignmentDelegate! It refers to alignment ''inside'' element, while alignmentInParent refers to element's alignment inside its parent.

If the node is resizable, will set its layout bounds to its current preferred width and height.

The background of the Region, which is made up of zero or more BackgroundFills, and zero or more BackgroundImages.

The 'alphabetic' (or 'roman') baseline offset from the node's layoutBounds.minY location that should be used when this node is being vertically aligned by baseline with other nodes.

The BlendMode used to blend this individual node into the scene behind it.

The border of the Region, which is made up of zero or more BorderStrokes, and zero or more BorderImages.

The rectangular bounds of this Node in the node's untransformed local coordinate space.

The rectangular bounds of this Node which include its transforms.

Construct an event dispatch chain for this target.

A performance hint to the system to indicate that this Node should be cached as a bitmap.

Additional hint for controlling bitmap caching.

Defines a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.

Defines whether the shape is centered within the Region's width or height.

Specifies a Node to use to define the the clipping shape for this Node.

Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.

Returns true if the given point (specified in the local coordinate space of this Node) is contained within the shape of this Node.

Returns the orientation of a node's resizing bias for layout purposes. If the node type has no bias, returns null. If the node is resizable and it's height depends on its width, returns HORIZONTAL, else if its width depends on its height, returns VERTICAL.

Resizable subclasses should override this method to return an appropriate value.

The ContextMenu to show for this control.

The CssMetaData of this Styleable.

Defines the mouse cursor for this Node and subnodes.

Indicates whether depth testing is used when rendering this node.

Sets the individual disabled state of this Node.

Indicates whether or not this Node is disabled.

Specifies an effect to apply to this Node.

The effective orientation of a node resolves the inheritance of node orientation, returning either left-to-right or right-to-left.

Verifies if a object is equals to this delegate.

Specifies the event dispatcher for this node.

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

Fires the specified event.

Specifies whether this Node should be a part of focus traversal cycle.

Indicates whether this Node currently has the input focus.

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.

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

The height of this resizable node.

Pseudo-property that returns this Node's hgrow constraint if set.

Sets the horizontal grow priority for this Node inside its parent. Setting the value to null will remove the constraint. Internally it calls setHgrow(Node, Priority) static method from JavaFX's GridPane and HBox besides fill this Node's "hgrow" property.

Whether or not this Node is being hovered over.

The id of this Node.

Property holding InputMethodRequests.

Gets the space around content, which will include any borders plus padding if set.

Returns true if the given rectangle (specified in the local coordinate space of this Node) intersects the shape of this Node.

Returns true if the given bounds (specified in the local coordinate space of this Node) intersects the shape of this Node.

The rectangular bounds that should be used for layout calculations for this node.

Defines the x coordinate of the translation that is added to this Node's transform for the purpose of layout.

Defines the y coordinate of the translation that is added to this Node's transform for the purpose of layout.

Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.

Transforms a point from the local coordinate space of this Node into the coordinate space of its parent.

Transforms a bounds from the local coordinate space of this Node into the coordinate space of its parent.

An affine transform that holds the computed local-to-parent transform. This is the concatenation of all transforms in this node, including all of the convenience transforms.

Transforms a point from the local coordinate space of this Node into the coordinate space of its Scene.

Transforms a point from the local coordinate space of this Node into the coordinate space of its Scene.

Transforms a bounds from the local coordinate space of this Node into the coordinate space of its Scene.

An affine transform that holds the computed local-to-scene transform. This is the concatenation of all transforms in this node's parents and in this node, including all of the convenience transforms.

Finds this Node, or the first sub-node, based on the given CSS selector.

Finds all Nodes, including this one and any children, which match the given CSS selector.

Defines whether or not this node's layout will be managed by it's parent.

Pseudo-property that returns this Node's margin constraint inside its Parent if set.

Sets this Node's margin constraint inside its Parent if set. If set, the parent will layout the child with the margin space around it. Setting the value to null will remove the constraint. Internally it calls setMargin(Node, Insets) static method from JavaFX's BorderPane, FlowPane, GridPane, HBox, StackPane and VBox besides fill this Node's "margin" property.

Property for overriding the region's computed maximum height.

Returns the node's maximum height for use in layout calculations.

Property for overriding the region's computed maximum width.

Returns the node's maximum width for use in layout calculations.

Property for overriding the region's computed minimum height.

Returns the node's minimum height for use in layout calculations.

Property for overriding the region's computed minimum width.

Returns the node's minimum width for use in layout calculations.

If true, this node (together with all its children) is completely transparent to mouse events.

Indicates that this Node and its subnodes requires a layout pass on the next pulse.

Node orientation describes the flow of visual data within a node.

Defines a function to be called when a context menu has been requested on this Node.

Defines a function to be called when drag gesture has been detected.

Defines a function to be called when this Node is a drag and drop gesture source after its data has been dropped on a drop target.

Defines a function to be called when the mouse button is released on this Node during drag and drop gesture.

Defines a function to be called when drag gesture enters this Node.

Defines a function to be called when drag gesture exits this Node.

Defines a function to be called when drag gesture progresses within this Node.

Defines a function to be called when this Node has input focus and the input method text has changed.

Defines a function to be called when this Node or its child Node has input focus and a key has been pressed.

Defines a function to be called when this Node or its child Node has input focus and a key has been released.

Defines a function to be called when this Node or its child Node has input focus and a key has been typed.

Defines a function to be called when a mouse button has been clicked (pressed and released) on this Node.

Defines a function to be called when a full press-drag-release gesture enters this Node.

Defines a function to be called when a full press-drag-release gesture leaves this Node.

Defines a function to be called when a full press-drag-release gesture progresses within this Node.

Defines a function to be called when a full press-drag-release gesture ends (by releasing mouse button) within this Node.

Defines a function to be called when a mouse button is pressed on this Node and then dragged.

Defines a function to be called when the mouse enters this Node.

Defines a function to be called when the mouse exits this Node.

Defines a function to be called when a mouse button has been pressed on this Node.

Defines a function to be called when a mouse button has been released on this Node.

Defines a function to be called when user performs a rotation action.

Defines a function to be called when a rotation gesture ends.

Defines a function to be called when a rotation gesture starts.

Defines a function to be called when user performs a scrolling action.

Defines a function to be called when a Scroll gesture ends.

Defines a function to be called when a Scroll gesture starts.

Defines a function to be called when a Swipe Down gesture starts.

Defines a function to be called when a Swipe Down gesture starts.

Defines a function to be called when a Swipe Right gesture starts.

Defines a function to be called when a Swipe Up gesture starts.

Defines a function to be called when user performs a Touch Moved action.

Defines a function to be called when user performs a Touch Pressed action.

Defines a function to be called when user performs a Touch Released action.

Defines a function to be called when user performs a Touch Stationary action.

Defines a function to be called when user performs a Touch action.

Defines a function to be called when a Zoom gesture ends.

Defines a function to be called when a Zoom gesture starts.

Specifies how opaque (that is, solid) the Node appears.

Defines the area of the region within which completely opaque pixels are drawn.

The top,right,bottom,left padding around the region's content.

The parent of this Node.

Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.

Transforms a point from the coordinate space of the parent into the local coordinate space of this Node.

Transforms a rectangle from the coordinate space of the parent into the local coordinate space of this Node.

Defines how the picking computation is done for this node when triggered by a MouseEvent or a contains function call.

Property for overriding the region's computed preferred height.

Property for overriding the region's computed preferred width.

Whether or not the Node is pressed.

The pseudo-class state of this Styleable.

Sets the node's layoutX and layoutY translation properties in order to relocate this node to the x,y location in the parent.

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.

Requests that this Node get the input focus, and that this Node's top-level ancestor become the focused window.

Invoked by the region's parent during layout to set the region's width and height.

Returns true since all Regions are resizable.

If the node is resizable, will set its layout bounds to the specified width and height.

Defines the angle of rotation about the Node's center, measured in degrees.

Defines the axis of rotation of this Node.

Specifies whether the shape, if defined, is scaled to match the size of the Region.

Defines the factor by which coordinates are scaled about the center of the object along the X axis of this Node.

Defines the factor by which coordinates are scaled about the center of the object along the Y axis of this Node.

Defines the factor by which coordinates are scaled about the center of the object along the Z axis of this Node.

The Scene that this Node is part of.

Transforms a point from the coordinate space of the Scene into the local coordinate space of this Node.

Transforms a point from the coordinate space of the Scene into the local coordinate space of this Node.

Transforms a rectangle from the coordinate space of the Scene into the local coordinate space of this Node.

When specified, the shape will cause the region to be rendered as the specified shape rather than as a rounded rectangle.

Skin is responsible for rendering this Control.

Defines whether this region rounds position/spacing and cell size values to pixel boundaries when laying out its children.

Takes a snapshot of this node at the next frame and calls the specified callback method when the image is ready. Arguments params and image can be null.

Takes a snapshot of this node and returns the rendered image when it is ready.