scalafx
API
Generated with
scalafx/scalafx/scalafx.scene/scalafx.scene.control/TreeTableView

TreeTableView

scalafx.scene.control.TreeTableView
See theTreeTableView companion object
class TreeTableView[S](val delegate: TreeTableView[S]) extends Control, SFXDelegate[TreeTableView[S]]

The TreeTableView control is designed to visualize an unlimited number of rows of data, broken out into columns. The TreeTableView control is conceptually very similar to the TreeView and TableView controls, and as you read on you'll come to see the APIs are largely the same. However, to give a high-level overview, you'll note that the TreeTableView uses the same TreeItem API as TreeView, and that you therefore are required to simply set the root node in the TreeTableView. Similarly, the TreeTableView control makes use of the same TableColumn-based approach that the TableView control uses, except instead of using the TableView-specific TableColumn class, you should instead use the TreeTableView-specific TreeTableColumn class instead.

Wraps a JavaFX http://docs.oracle.com/javase/8/javafx/api/javafx/scene/control/TreeTableView.TreeTableView.html

Type parameters

S

The type of the TreeItem instances used in this TreeTableView.

Value parameters

delegate

A JavaFX TreeTableView to be wrapped. Its default value is a new JavaFX TreeTableView.

Attributes

Constructor

Creates a new TreeTableView from a JavaFX one.

Since

8.0

Companion
object
Graph
Supertypes
class Control
trait Skinnable
class Region
class Parent
class Node
trait Styleable
class EventTarget
trait SFXDelegate[TreeTableView[S]]
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

object FilterMagnet

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
sealed trait FilterMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
object HandlerMagnet

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
sealed trait HandlerMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any

Types

type Delegate = TreeTableView[S]

Value members

Constructors

def this(rootItem: TreeItem[S])

Creates a TreeTableView with the provided root node.

Creates a TreeTableView with the provided root node.

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

Value parameters

rootItem

The node to be the root in this TreeTableView.

Attributes

Concrete methods

def columnResizePolicy: ObjectProperty[ResizeFeatures[S] => Boolean]

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.

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.

Attributes

def columnResizePolicy_=(p: Callback[ResizeFeatures[_], Boolean]): Unit
def columns: ObservableBuffer[TreeTableColumn[S, _]]

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.

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.

Attributes

def comparator: ReadOnlyObjectProperty[Comparator[TreeItem[S]]]

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.

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.

Attributes

def controlCssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

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

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

Attributes

def edit(row: Int, item: TreeTableColumn[S, _]): Unit

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.

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.

Attributes

def editable: BooleanProperty

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.

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.

Attributes

def editingCell: ReadOnlyObjectProperty[TreeTablePosition[S, _]]

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

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

Attributes

def expandedItemCount: ReadOnlyIntegerProperty

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.

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.

Attributes

def fixedCellSize: DoubleProperty

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.

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.

Attributes

def focusModel: ObjectProperty[TreeTableViewFocusModel[S]]

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.

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.

Attributes

def onScrollTo: ObjectProperty[EventHandler[ScrollToEvent[Integer]]]

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

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

Attributes

def onScrollToColumn: ObjectProperty[EventHandler[ScrollToEvent[TreeTableColumn[S, _]]]]

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 scroll a column into view using scrollToColumn(TreeTableColumn) or scrollToColumnIndex(int)

Attributes

def onScrollToColumn_=(v: EventHandler[ScrollToEvent[TreeTableColumn[S, _]]]): Unit
def onScrollTo_=(v: EventHandler[ScrollToEvent[Integer]]): Unit
def onSort: ObjectProperty[EventHandler[SortEvent[TreeTableView[S]]]]

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

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

Attributes

def onSort_=(v: EventHandler[SortEvent[TreeTableView[S]]]): Unit
def placeholder: ObjectProperty[Node]

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.

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.

Attributes

def resizeColumn(column: TreeTableColumn[S, _], delta: Double): Boolean

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

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

Attributes

def root: ObjectProperty[TreeItem[S]]

Property representing the root node of the TreeView.

Property representing the root node of the TreeView.

Attributes

def root_=(v: TreeItem[S]): Unit
def row(item: TreeItem[S]): Int

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

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

Attributes

def rowFactory: ObjectProperty[Callback[TreeTableView[S], TreeTableRow[S]]]

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.

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.

Attributes

def scrollTo(index: Int): Unit

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

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

Value parameters

index

The index that should be made visible to the user, assuming of course that it is greater than, or equal to 0, and less than the number of the visible items in the TreeTableView.

Attributes

def scrollToColumn(column: TreeTableColumn[S, _]): Unit

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

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

Value parameters

column

The column that should be visible to the user.

Attributes

def scrollToColumnIndex(index: Int): Unit

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

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

Value parameters

index

The index of a column that should be visible to the user.

Attributes

def selectionModel: ObjectProperty[TreeTableViewSelectionModel[S]]

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.

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.

Attributes

def showRoot: BooleanProperty

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

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

Attributes

def sort(): Unit

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.

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.

Attributes

def sortMode: ObjectProperty[TreeSortMode]

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

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

Attributes

def sortOrder: ObservableBuffer[TreeTableColumn[S, _]]

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

Attributes

def sortPolicy: ObjectProperty[TreeTableView[S] => Boolean]

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.

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.

Attributes

def tableMenuButtonVisible: BooleanProperty

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.

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.

Attributes

def treeColumn: ObjectProperty[TreeTableColumn[S, _]]

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.

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.

Attributes

def treeItem(row: Int): TreeItem[S]

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

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

Value parameters

row

The index of the TreeItem being sought.

Attributes

Returns

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

def treeItemLevel(node: TreeItem[_]): Int

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

Value parameters

node

The TreeItem for which the level is needed.

Attributes

Returns

An integer representing the number of parents above the given node, or -1 if the given TreeItem is null.

def visibleLeafColumn(column: Int): TreeTableColumn[S, _]

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

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

Attributes

def visibleLeafColumns: ObservableBuffer[TreeTableColumn[S, _]]

Returns an unmodifiable list containing the currently visible leaf columns.

Returns an unmodifiable list containing the currently visible leaf columns.

Attributes

def visibleLeafIndex(column: TreeTableColumn[S, _]): Int

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

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

Attributes

Deprecated methods

def nodeLevel(node: TreeItem[S]): Int

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

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

Value parameters

node

The ScalaFX TreeItem for which the level is needed.

Attributes

Returns

An integer representing the number of parents above the given node, or -1 if the given TreeItem is null.

Deprecated
true

Inherited methods

def accessibleHelp: ObjectProperty[String]

The accessible help text for this Node.

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.

Attributes

Since

JavaFX 8u40

Inherited from:
Node
def accessibleHelp_=(v: String): Unit

Attributes

Inherited from:
Node
def accessibleRole: ObjectProperty[AccessibleRole]

The accessible role for this Node.

The accessible role for this Node.

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

Attributes

Since

JavaFX 8u40

Inherited from:
Node
def accessibleRoleDescription: ObjectProperty[String]

The role description of this Node.

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.

Attributes

Since

JavaFX 8u40

Inherited from:
Node
def accessibleRoleDescription_=(v: String): Unit

Attributes

Inherited from:
Node
def accessibleRole_=(v: AccessibleRole): Unit

Attributes

Inherited from:
Node
def accessibleText: ObjectProperty[String]

The accessible text for this Node.

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.

Attributes

Since

JavaFX 8u40

Inherited from:
Node
def accessibleText_=(v: String): Unit

Attributes

Inherited from:
Node
def alignmentInParent: Pos

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

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

Attributes

Inherited from:
Node
def alignmentInParent_=(p: Pos): Unit

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&apos;s getProperties() and setAlignment static method from

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&apos;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.

Value parameters

p

New node's Position

Attributes

Inherited from:
Node
def autosize(): Unit

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

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

Attributes

Inherited from:
Node
def background: ObjectProperty[Background]

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

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

Attributes

Inherited from:
Region
def background_=(v: Background): Unit

Attributes

Inherited from:
Region
def baselineOffset: Double

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

Attributes

Inherited from:
Node
def blendMode: ObjectProperty[BlendMode]

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

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

Attributes

Inherited from:
Node
def blendMode_=(v: BlendMode): Unit

Attributes

Inherited from:
Node
def border: ObjectProperty[Border]

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

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

Attributes

Inherited from:
Region
def border_=(v: Border): Unit

Attributes

Inherited from:
Region
def boundsInLocal: ReadOnlyObjectProperty[Bounds]

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

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

Attributes

Inherited from:
Node
def boundsInParent: ReadOnlyObjectProperty[Bounds]

The rectangular bounds of this Node which include its transforms.

The rectangular bounds of this Node which include its transforms.

Attributes

Inherited from:
Node
def buildEventDispatchChain(tail: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.

The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.

The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.

Value parameters

tail

the initial chain to build from

Attributes

Returns

the resulting event dispatch chain for this target

See also
Inherited from:
EventTarget
def cache: BooleanProperty

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

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

Attributes

Inherited from:
Node
def cacheHint: ObjectProperty[CacheHint]

Additional hint for controlling bitmap caching.

Additional hint for controlling bitmap caching.

Attributes

Inherited from:
Node
def cacheHint_=(v: CacheHint): Unit

Attributes

Inherited from:
Node
def cacheShape: BooleanProperty

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 a hint to the system indicating that the Shape used to define the region's background is stable and would benefit from caching.

Attributes

Inherited from:
Region
def cacheShape_=(v: Boolean): Unit

Attributes

Inherited from:
Region
def cache_=(v: Boolean): Unit

Attributes

Inherited from:
Node
def centerShape: BooleanProperty

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

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

Attributes

Inherited from:
Region
def centerShape_=(v: Boolean): Unit

Attributes

Inherited from:
Region
def clip: ObjectProperty[Node]

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

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

Attributes

Inherited from:
Node
def clip_=(v: Node): Unit

Attributes

Inherited from:
Node
def contains(localPoint: Point2D): Boolean

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.

Attributes

Inherited from:
Node
def contains(localX: Double, localY: Double): Boolean

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.

Attributes

Inherited from:
Node
def contentBias: Orientation

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.

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.

Attributes

Returns

orientation of width/height dependency or null if there is none

Inherited from:
Node
def contextMenu: ObjectProperty[ContextMenu]

The ContextMenu to show for this control.

The ContextMenu to show for this control.

Attributes

Inherited from:
Control
def contextMenu_=(v: ContextMenu): Unit

Attributes

Inherited from:
Control
def cssMetaData: Seq[CssMetaData[_ <: Styleable, _]]

The CssMetaData of this Styleable.

The CssMetaData of this Styleable.

Attributes

Inherited from:
Styleable
def cursor: ObjectProperty[Cursor]

Defines the mouse cursor for this Node and subnodes.

Defines the mouse cursor for this Node and subnodes.

Attributes

Inherited from:
Node
def cursor_=(v: Cursor): Unit

Attributes

Inherited from:
Node
def depthTest: ObjectProperty[DepthTest]

Indicates whether depth testing is used when rendering this node.

Indicates whether depth testing is used when rendering this node.

Attributes

Inherited from:
Node
def depthTest_=(v: DepthTest): Unit

Attributes

Inherited from:
Node
def disable: BooleanProperty

Sets the individual disabled state of this Node.

Sets the individual disabled state of this Node.

Attributes

Inherited from:
Node
def disable_=(v: Boolean): Unit

Attributes

Inherited from:
Node
def disabled: ReadOnlyBooleanProperty

Indicates whether or not this Node is disabled.

Indicates whether or not this Node is disabled.

Attributes

Inherited from:
Node
def effect: ObjectProperty[Effect]

Specifies an effect to apply to this Node.

Specifies an effect to apply to this Node.

Attributes

Inherited from:
Node
def effect_=(v: Effect): Unit

Attributes

Inherited from:
Node
def effectiveNodeOrientation: ReadOnlyObjectProperty[NodeOrientation]

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

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

Attributes

Inherited from:
Node
override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value parameters

ref

Object to be compared.

Attributes

Returns

if the other object is equals to this delegate or not.

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def eventDispatcher: ObjectProperty[EventDispatcher]

Specifies the event dispatcher for this node.

Specifies the event dispatcher for this node.

Attributes

Inherited from:
Node
def eventDispatcher_=(v: EventDispatcher): Unit

Attributes

Inherited from:
Node
def filterEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

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

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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Attributes

Inherited from:
EventTarget
def fireEvent(event: Event): Unit

Fires the specified event.

Fires the specified event.

Attributes

Inherited from:
Node
def focusTraversable: BooleanProperty

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

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

Attributes

Inherited from:
Node
def focusTraversable_=(v: Boolean): Unit

Attributes

Inherited from:
Node
def focusVisible: ReadOnlyBooleanProperty

Indicates whether this Node should visibly indicate focus. This flag is set when the node acquires input focus via keyboard navigation, and it is cleared when the node loses focus or when requestFocus is called.

Indicates whether this Node should visibly indicate focus. This flag is set when the node acquires input focus via keyboard navigation, and it is cleared when the node loses focus or when requestFocus is called.

Attributes

Since

19

Inherited from:
Node
def focusWithin: ReadOnlyBooleanProperty

Indicates whether this Node or any of its descendants currently has the input focus.

Indicates whether this Node or any of its descendants currently has the input focus.

Attributes

Since

19

Inherited from:
Node
def focused: ReadOnlyBooleanProperty

Indicates whether this Node currently has the input focus.

Indicates whether this Node currently has the input focus.

Attributes

Inherited from:
Node
def getId: String

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.

Attributes

Inherited from:
Styleable
def getStyle: String

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.

Attributes

Inherited from:
Styleable
def handleEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

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.

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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

handler

code handling the event, see examples above.

Attributes

Returns

Returns a subscription that can be used to cancel/remove this event handler

Inherited from:
EventTarget
override def hashCode: Int

Attributes

Returns

The delegate hashcode

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def height: ReadOnlyDoubleProperty

The height of this resizable node.

The height of this resizable node.

Attributes

Inherited from:
Region
def hgrow: Priority

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

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

Attributes

Returns

the horizontal grow priority for the child or null if no priority was set

Inherited from:
Node
def hgrow_=(p: Priority): Unit

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.

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.

Value parameters

p

the horizontal grow priority for this Node

Attributes

Inherited from:
Node
def hover: ReadOnlyBooleanProperty

Whether or not this Node is being hovered over.

Whether or not this Node is being hovered over.

Attributes

Inherited from:
Node
def id: StringProperty

The id of this Node.

The id of this Node.

Attributes

Inherited from:
Node
def id_=(v: String): Unit

Attributes

Inherited from:
Node
def inputMethodRequests: ObjectProperty[InputMethodRequests]

Property holding InputMethodRequests.

Property holding InputMethodRequests.

Attributes

Inherited from:
Node
def inputMethodRequests_=(v: InputMethodRequests): Unit

Attributes

Inherited from:
Node
def insets: Insets

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

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

Attributes

Inherited from:
Region
def intersects(localX: Double, localY: Double, localWidth: Double, localHeight: Double): Boolean

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 rectangle (specified in the local coordinate space of this Node) intersects the shape of this Node.

Attributes

Inherited from:
Node
def intersects(localBounds: Bounds): Boolean

Returns true if the given bounds (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.

Attributes

Inherited from:
Node
def layoutBounds: ReadOnlyObjectProperty[Bounds]

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

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

Attributes

Inherited from:
Node
def layoutX: DoubleProperty

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

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

Attributes

Inherited from:
Node
def layoutX_=(v: Double): Unit

Attributes

Inherited from:
Node
def layoutY: DoubleProperty

Defines the y 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.

Attributes

Inherited from:
Node
def layoutY_=(v: Double): Unit

Attributes

Inherited from:
Node
def localToParent(localPoint: Point2D): Point2D

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.

Attributes

Inherited from:
Node
def localToParent(localX: Double, localY: Double): Point2D

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.

Attributes

Inherited from:
Node
def localToParent(localBounds: Bounds): Bounds

Transforms a bounds 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.

Attributes

Inherited from:
Node
def localToParentTransform: Transform

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.

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.

Attributes

Since

2.2

Inherited from:
Node
def localToScene(localPoint: Point2D): Point2D

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.

Attributes

Inherited from:
Node
def localToScene(localX: Double, localY: Double): Point2D

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.

Attributes

Inherited from:
Node
def localToScene(localBounds: Bounds): Bounds

Transforms a bounds 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.

Attributes

Inherited from:
Node
def localToSceneTransform: Transform

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.

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.

Attributes

Since

2.2

Inherited from:
Node
def lookup(selector: String): Node

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

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

Attributes

Inherited from:
Node
def lookupAll(selector: String): Set[Node]

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

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

Attributes

Inherited from:
Node
def managed: BooleanProperty

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

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

Attributes

Inherited from:
Node
def managed_=(v: Boolean): Unit

Attributes

Inherited from:
Node
def margin: Insets

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

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

Attributes

Returns

this Node's margin constraint inside its Parent or null if no margin was set.

Inherited from:
Node
def margin_=(i: Insets): Unit

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.

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.

Value parameters

i

The margin of space around this Node inside its parent.

Attributes

Inherited from:
Node
def maxHeight: DoubleProperty

Property for overriding the region's computed maximum height.

Property for overriding the region's computed maximum height.

Attributes

Inherited from:
Region
def maxHeight(height: Double): Double

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

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

Attributes

Inherited from:
Node
def maxHeight_=(v: Double): Unit

Attributes

Inherited from:
Region
def maxWidth: DoubleProperty

Property for overriding the region's computed maximum width.

Property for overriding the region's computed maximum width.

Attributes

Inherited from:
Region
def maxWidth(width: Double): Double

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

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

Attributes

Inherited from:
Node
def maxWidth_=(v: Double): Unit

Attributes

Inherited from:
Region
def minHeight: DoubleProperty

Property for overriding the region's computed minimum height.

Property for overriding the region's computed minimum height.

Attributes

Inherited from:
Region
def minHeight(height: Double): Double

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

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

Attributes

Inherited from:
Node
def minHeight_=(v: Double): Unit

Attributes

Inherited from:
Region
def minWidth: DoubleProperty

Property for overriding the region's computed minimum width.

Property for overriding the region's computed minimum width.

Attributes

Inherited from:
Region
def minWidth(width: Double): Double

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

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

Attributes

Inherited from:
Node
def minWidth_=(v: Double): Unit

Attributes

Inherited from:
Region
def mouseTransparent: BooleanProperty

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

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

Attributes

Inherited from:
Node
def mouseTransparent_=(v: Boolean): Unit

Attributes

Inherited from:
Node
def needsLayout: ReadOnlyBooleanProperty

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

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

Attributes

Inherited from:
Parent
def nodeOrientation: ObjectProperty[NodeOrientation]

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

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

Attributes

Inherited from:
Node
def nodeOrientation_=(v: NodeOrientation): Unit

Attributes

Inherited from:
Node
def onContextMenuRequested: ObjectProperty[EventHandler[_ >: ContextMenuEvent]]

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

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

Attributes

Inherited from:
Node
def onContextMenuRequested_=(v: EventHandler[_ >: ContextMenuEvent]): Unit

Attributes

Inherited from:
Node
def onDragDetected: ObjectProperty[EventHandler[_ >: MouseEvent]]

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

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

Attributes

Inherited from:
Node
def onDragDetected_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onDragDone: ObjectProperty[EventHandler[_ >: DragEvent]]

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 this Node is a drag and drop gesture source after its data has been dropped on a drop target.

Attributes

Inherited from:
Node
def onDragDone_=(v: EventHandler[_ >: DragEvent]): Unit

Attributes

Inherited from:
Node
def onDragDropped: ObjectProperty[EventHandler[_ >: DragEvent]]

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 the mouse button is released on this Node during drag and drop gesture.

Attributes

Inherited from:
Node
def onDragDropped_=(v: EventHandler[_ >: DragEvent]): Unit

Attributes

Inherited from:
Node
def onDragEntered: ObjectProperty[EventHandler[_ >: DragEvent]]

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

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

Attributes

Inherited from:
Node
def onDragEntered_=(v: EventHandler[_ >: DragEvent]): Unit

Attributes

Inherited from:
Node
def onDragExited: ObjectProperty[EventHandler[_ >: DragEvent]]

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

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

Attributes

Inherited from:
Node
def onDragExited_=(v: EventHandler[_ >: DragEvent]): Unit

Attributes

Inherited from:
Node
def onDragOver: ObjectProperty[EventHandler[_ >: DragEvent]]

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

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

Attributes

Inherited from:
Node
def onDragOver_=(v: EventHandler[_ >: DragEvent]): Unit

Attributes

Inherited from:
Node
def onInputMethodTextChanged: ObjectProperty[EventHandler[_ >: InputMethodEvent]]

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 has input focus and the input method text has changed.

Attributes

Inherited from:
Node
def onInputMethodTextChanged_=(v: EventHandler[_ >: InputMethodEvent]): Unit

Attributes

Inherited from:
Node
def onKeyPressed: ObjectProperty[EventHandler[_ >: KeyEvent]]

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

Attributes

Inherited from:
Node
def onKeyPressed_=(v: EventHandler[_ >: KeyEvent]): Unit

Attributes

Inherited from:
Node
def onKeyReleased: ObjectProperty[EventHandler[_ >: KeyEvent]]

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

Attributes

Inherited from:
Node
def onKeyReleased_=(v: EventHandler[_ >: KeyEvent]): Unit

Attributes

Inherited from:
Node
def onKeyTyped: ObjectProperty[EventHandler[_ >: KeyEvent]]

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 this Node or its child Node has input focus and a key has been typed.

Attributes

Inherited from:
Node
def onKeyTyped_=(v: EventHandler[_ >: KeyEvent]): Unit

Attributes

Inherited from:
Node
def onMouseClicked: ObjectProperty[EventHandler[_ >: MouseEvent]]

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 mouse button has been clicked (pressed and released) on this Node.

Attributes

Inherited from:
Node
def onMouseClicked_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onMouseDragEntered: ObjectProperty[EventHandler[_ >: MouseDragEvent]]

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 enters this Node.

Attributes

Inherited from:
Node
def onMouseDragEntered_=(v: EventHandler[_ >: MouseDragEvent]): Unit

Attributes

Inherited from:
Node
def onMouseDragExited: ObjectProperty[EventHandler[_ >: MouseDragEvent]]

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 leaves this Node.

Attributes

Inherited from:
Node
def onMouseDragExited_=(v: EventHandler[_ >: MouseDragEvent]): Unit

Attributes

Inherited from:
Node
def onMouseDragOver: ObjectProperty[EventHandler[_ >: MouseDragEvent]]

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 progresses within this Node.

Attributes

Inherited from:
Node
def onMouseDragOver_=(v: EventHandler[_ >: MouseDragEvent]): Unit

Attributes

Inherited from:
Node
def onMouseDragReleased: ObjectProperty[EventHandler[_ >: MouseDragEvent]]

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 full press-drag-release gesture ends (by releasing mouse button) within this Node.

Attributes

Inherited from:
Node
def onMouseDragReleased_=(v: EventHandler[_ >: MouseDragEvent]): Unit

Attributes

Inherited from:
Node
def onMouseDragged: ObjectProperty[EventHandler[_ >: MouseEvent]]

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 a mouse button is pressed on this Node and then dragged.

Attributes

Inherited from:
Node
def onMouseDragged_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onMouseEntered: ObjectProperty[EventHandler[_ >: MouseEvent]]

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

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

Attributes

Inherited from:
Node
def onMouseEntered_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onMouseExited: ObjectProperty[EventHandler[_ >: MouseEvent]]

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

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

Attributes

Inherited from:
Node
def onMouseExited_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onMouseMoved: ObjectProperty[EventHandler[_ >: MouseEvent]]

Attributes

Inherited from:
Node
def onMouseMoved_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onMousePressed: ObjectProperty[EventHandler[_ >: MouseEvent]]

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 pressed on this Node.

Attributes

Inherited from:
Node
def onMousePressed_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onMouseReleased: ObjectProperty[EventHandler[_ >: MouseEvent]]

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

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

Attributes

Inherited from:
Node
def onMouseReleased_=(v: EventHandler[_ >: MouseEvent]): Unit

Attributes

Inherited from:
Node
def onRotate: ObjectProperty[EventHandler[_ >: RotateEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onRotate_=(v: EventHandler[_ >: RotateEvent]): Unit

Attributes

Inherited from:
Node
def onRotationFinished: ObjectProperty[EventHandler[_ >: RotateEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onRotationFinished_=(v: EventHandler[_ >: RotateEvent]): Unit

Attributes

Inherited from:
Node
def onRotationStarted: ObjectProperty[EventHandler[_ >: RotateEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onRotationStarted_=(v: EventHandler[_ >: RotateEvent]): Unit

Attributes

Inherited from:
Node
def onScroll: ObjectProperty[EventHandler[_ >: ScrollEvent]]

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

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

Attributes

Inherited from:
Node
def onScrollFinished: ObjectProperty[EventHandler[_ >: ScrollEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onScrollFinished_=(v: EventHandler[_ >: ScrollEvent]): Unit

Attributes

Inherited from:
Node
def onScrollStarted: ObjectProperty[EventHandler[_ >: ScrollEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onScrollStarted_=(v: EventHandler[_ >: ScrollEvent]): Unit

Attributes

Inherited from:
Node
def onScroll_=(v: EventHandler[_ >: ScrollEvent]): Unit

Attributes

Inherited from:
Node
def onSwipeDown: ObjectProperty[EventHandler[_ >: SwipeEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onSwipeDown_=(v: EventHandler[_ >: SwipeEvent]): Unit

Attributes

Inherited from:
Node
def onSwipeLeft: ObjectProperty[EventHandler[_ >: SwipeEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onSwipeLeft_=(v: EventHandler[_ >: SwipeEvent]): Unit

Attributes

Inherited from:
Node
def onSwipeRight: ObjectProperty[EventHandler[_ >: SwipeEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onSwipeRight_=(v: EventHandler[_ >: SwipeEvent]): Unit

Attributes

Inherited from:
Node
def onSwipeUp: ObjectProperty[EventHandler[_ >: SwipeEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onSwipeUp_=(v: EventHandler[_ >: SwipeEvent]): Unit

Attributes

Inherited from:
Node
def onTouchMoved: ObjectProperty[EventHandler[_ >: TouchEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onTouchMoved_=(v: EventHandler[_ >: TouchEvent]): Unit

Attributes

Inherited from:
Node
def onTouchPressed: ObjectProperty[EventHandler[_ >: TouchEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onTouchPressed_=(v: EventHandler[_ >: TouchEvent]): Unit

Attributes

Inherited from:
Node
def onTouchReleased: ObjectProperty[EventHandler[_ >: TouchEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onTouchReleased_=(v: EventHandler[_ >: TouchEvent]): Unit

Attributes

Inherited from:
Node
def onTouchStationary: ObjectProperty[EventHandler[_ >: TouchEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onTouchStationary_=(v: EventHandler[_ >: TouchEvent]): Unit

Attributes

Inherited from:
Node
def onZoom: ObjectProperty[EventHandler[_ >: ZoomEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onZoomFinished: ObjectProperty[EventHandler[_ >: ZoomEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onZoomFinished_=(v: EventHandler[_ >: ZoomEvent]): Unit

Attributes

Inherited from:
Node
def onZoomStarted: ObjectProperty[EventHandler[_ >: ZoomEvent]]

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

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

Attributes

Since

2.2

Inherited from:
Node
def onZoomStarted_=(v: EventHandler[_ >: ZoomEvent]): Unit

Attributes

Inherited from:
Node
def onZoom_=(v: EventHandler[_ >: ZoomEvent]): Unit

Attributes

Inherited from:
Node
def opacity: DoubleProperty

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

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

Attributes

Inherited from:
Node
def opacity_=(v: Double): Unit

Attributes

Inherited from:
Node
def opaqueInsets: ObjectProperty[Insets]

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

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

Attributes

Inherited from:
Region
def opaqueInsets_=(v: Insets): Unit

Attributes

Inherited from:
Region
def padding: ObjectProperty[Insets]

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

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

Attributes

Inherited from:
Region
def padding_=(v: Insets): Unit

Attributes

Inherited from:
Region
def parent: ReadOnlyObjectProperty[Parent]

The parent of this Node.

The parent of this Node.

Attributes

Inherited from:
Node
def parentToLocal(parentPoint: Point2D): Point2D

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.

Attributes

Inherited from:
Node
def parentToLocal(parentX: Double, parentY: Double): Point2D

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.

Attributes

Inherited from:
Node
def parentToLocal(parentBounds: Bounds): Bounds

Transforms a rectangle 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.

Attributes

Inherited from:
Node
def pickOnBounds: BooleanProperty

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

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

Attributes

Inherited from:
Node
def pickOnBounds_=(v: Boolean): Unit

Attributes

Inherited from:
Node
def prefHeight: DoubleProperty

Property for overriding the region's computed preferred height.

Property for overriding the region's computed preferred height.

Attributes

Inherited from:
Region
def prefHeight_=(v: Double): Unit

Attributes

Inherited from:
Region
def prefWidth: DoubleProperty

Property for overriding the region's computed preferred width.

Property for overriding the region's computed preferred width.

Attributes

Inherited from:
Region
def prefWidth_=(v: Double): Unit

Attributes

Inherited from:
Region
def pressed: ReadOnlyBooleanProperty

Whether or not the Node is pressed.

Whether or not the Node is pressed.

Attributes

Inherited from:
Node
def pseudoClassStates: ObservableSet[PseudoClass]

The pseudo-class state of this Styleable.

The pseudo-class state of this Styleable.

Attributes

Inherited from:
Styleable
def relocate(x: Double, y: Double): Unit

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

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

Attributes

Inherited from:
Node
def requestFocus(): Unit

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

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

Attributes

Inherited from:
Node
override def resize(width: Double, height: Double): Unit

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

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

Attributes

Definition Classes
Inherited from:
Region
def resize: Boolean

Returns true since all Regions are resizable.

Returns true since all Regions are resizable.

Attributes

Inherited from:
Region
def resizeRelocate(x: Double, y: Double, width: Double, height: Double): Unit

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

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

Attributes

Inherited from:
Node
def rotate: DoubleProperty

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

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

Attributes

Inherited from:
Node
def rotate_=(v: Double): Unit

Attributes

Inherited from:
Node
def rotationAxis: ObjectProperty[Point3D]

Defines the axis of rotation of this Node.

Defines the axis of rotation of this Node.

Attributes

Inherited from:
Node
def rotationAxis_=(v: Point3D): Unit

Attributes

Inherited from:
Node
def scaleShape: BooleanProperty

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

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

Attributes

Inherited from:
Region
def scaleShape_=(v: Boolean): Unit

Attributes

Inherited from:
Region
def scaleX: DoubleProperty

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 X axis of this Node.

Attributes

Inherited from:
Node
def scaleX_=(v: Double): Unit

Attributes

Inherited from:
Node
def scaleY: DoubleProperty

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 Y axis of this Node.

Attributes

Inherited from:
Node
def scaleY_=(v: Double): Unit

Attributes

Inherited from:
Node
def scaleZ: DoubleProperty

Defines the factor by which coordinates are scaled about the center of the object along the Z 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.

Attributes

Inherited from:
Node
def scaleZ_=(v: Double): Unit

Attributes

Inherited from:
Node
def scene: ReadOnlyObjectProperty[Scene]

The Scene that this Node is part of.

The Scene that this Node is part of.

Attributes

Inherited from:
Node
def sceneToLocal(scenePoint: Point2D): Point2D

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.

Attributes

Inherited from:
Node
def sceneToLocal(sceneX: Double, sceneY: Double): Point2D

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.

Attributes

Inherited from:
Node
def sceneToLocal(sceneBounds: Bounds): Bounds

Transforms a rectangle 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.

Attributes

Inherited from:
Node
def shape: ObjectProperty[Shape]

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

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

Attributes

Inherited from:
Region
def shape_=(v: Shape): Unit

Attributes

Inherited from:
Region
def skin: ObjectProperty[Skin[_]]

Skin is responsible for rendering this Control.

Skin is responsible for rendering this Control.

Attributes

Inherited from:
Skinnable
def skin_=(v: Skin[_]): Unit

Attributes

Inherited from:
Skinnable
def snapToPixel: BooleanProperty

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

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

Attributes

Inherited from:
Region
def snapToPixel_=(v: Boolean): Unit

Attributes

Inherited from:
Region
def snapshot(callback: SnapshotResult => Unit, params: SnapshotParameters, image: WritableImage): Unit

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 at the next frame and calls the specified callback method when the image is ready. Arguments params and image can be null.

Attributes

Inherited from:
Node
def snapshot(params: SnapshotParameters, image: WritableImage): WritableImage

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

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

Attributes

Inherited from:
Node
def startDragAndDrop(transferModes: TransferMode*): Dragboard

Confirms a potential drag and drop gesture that is recognized over this Node.

Confirms a potential drag and drop gesture that is recognized over this Node.

Attributes

Inherited from:
Node
def startFullDrag(): Unit

Starts a full press-drag-release gesture with this node as gesture source.

Starts a full press-drag-release gesture with this node as gesture source.

Attributes

Inherited from:
Node
def style: 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.

Attributes

Inherited from:
Node
def styleClass: ObservableBuffer[String]

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.

Attributes

Inherited from:
Styleable
def styleClass_=(c: Iterable[String]): Unit

Sets the list of CSS styles classes, replacing the prior content. If you want append to current content, use add or similar.

Sets the list of CSS styles classes, replacing the prior content. If you want append to current content, use add or similar.

Value parameters

c

list of CSS styles classes to replace prior content.

Attributes

Inherited from:
Node
def style_=(v: String): Unit

Attributes

Inherited from:
Node
def styleableNode: Node

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.

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.

Attributes

Returns

the Node that represents this Styleable object

Since

9

Inherited from:
Styleable
def styleableParent: Styleable

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

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

Attributes

Inherited from:
Styleable
def stylesheets: ObservableBuffer[String]

Gets an observable list of string URLs linking to the stylesheets to use with this Parent's contents.

Gets an observable list of string URLs linking to the stylesheets to use with this Parent's contents.

Attributes

Inherited from:
Parent
def stylesheets_=(c: Iterable[String]): Unit

Sets the list of stylesheets URLs, replacing the prior content. If you want append to current content, use add or similar.

Sets the list of stylesheets URLs, replacing the prior content. If you want append to current content, use add or similar.

Value parameters

c

list of stylesheets URLs to replace prior content.

Attributes

Inherited from:
Parent
def toBack(): Unit

Moves this Node to the back of its sibling nodes in terms of z-order.

Moves this Node to the back of its sibling nodes in terms of z-order.

Attributes

Inherited from:
Node
def toFront(): Unit

Moves this Node to the front of its sibling nodes in terms of z-order.

Moves this Node to the front of its sibling nodes in terms of z-order.

Attributes

Inherited from:
Node
override def toString: String

Attributes

Returns

Returns the original delegate's toString() adding a [SFX] prefix.

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def tooltip: ObjectProperty[Tooltip]

The ToolTip for this control.

The ToolTip for this control.

Attributes

Inherited from:
Control
def tooltip_=(v: Tooltip): Unit

Attributes

Inherited from:
Control
def transforms: ObservableBuffer[Transform]

Defines the ObservableList of Transform objects to be applied to this Node.

Defines the ObservableList of Transform objects to be applied to this Node.

Attributes

Inherited from:
Node
def transforms_=(c: Iterable[Transform]): Unit

Sets the list of transforms, replacing the prior content. If you want append to current content, use add or similar.

Sets the list of transforms, replacing the prior content. If you want append to current content, use add or similar.

Value parameters

c

list of transforms to replace prior content.

Attributes

Inherited from:
Node
def translateX: DoubleProperty

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

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

Attributes

Inherited from:
Node
def translateX_=(v: Double): Unit

Attributes

Inherited from:
Node
def translateY: DoubleProperty

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

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

Attributes

Inherited from:
Node
def translateY_=(v: Double): Unit

Attributes

Inherited from:
Node
def translateZ: DoubleProperty

Defines the Z coordinate of the translation that is added to the transformed coordinates of this Node.

Defines the Z coordinate of the translation that is added to the transformed coordinates of this Node.

Attributes

Inherited from:
Node
def translateZ_=(v: Double): Unit

Attributes

Inherited from:
Node
def typeSelector: String

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.

Attributes

Inherited from:
Styleable
def userData: AnyRef

Returns a previously set Object property, or null if no such property has been set using the setUserData(AnyRef) method.

Returns a previously set Object property, or null if no such property has been set using the setUserData(AnyRef) method.

Attributes

Inherited from:
Node
def userData_=(v: AnyRef): Unit

Attributes

Inherited from:
Node
def vgrow: Priority

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

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

Attributes

Returns

the vertical grow priority for the child or null if no priority was set

Inherited from:
Node
def vgrow_=(p: Priority): Unit

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

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

Value parameters

p

the vertical grow priority for this Node

Attributes

Inherited from:
Node
def viewOrder: DoubleProperty

Defines the rendering and picking order of this Node within its parent.

Defines the rendering and picking order of this Node within its parent.

This property is used to alter the rendering and picking order of a node within its parent without reordering the parent's children list. For example, this can be used as a more efficient way to implement transparency sorting. To do this, an application can assign the viewOrder value of each node to the computed distance between that node and the viewer.

The parent will traverse its children in decreasing viewOrder order. This means that a child with a lower viewOrder will be in front of a child with a higher viewOrder. If two children have the same viewOrder, the parent will traverse them in the order they appear in the parent's children list.

However, viewOrder does not alter the layout and focus traversal order of this Node within its parent. A parent always traverses its children list in order when doing layout or focus traversal.

Attributes

Returns

the view order for this Node

Since

9 Default value is 0.0

Inherited from:
Node
def viewOrder_(value: Double): Unit

Attributes

Inherited from:
Node
def visible: BooleanProperty

Specifies whether this Node and any subnodes should be rendered as part of the scene graph.

Specifies whether this Node and any subnodes should be rendered as part of the scene graph.

Attributes

Inherited from:
Node
def visible_=(v: Boolean): Unit

Attributes

Inherited from:
Node
def width: ReadOnlyDoubleProperty

The width of this resizable node.

The width of this resizable node.

Attributes

Inherited from:
Region

Concrete fields

override val delegate: TreeTableView[S]

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with