Node

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

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

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

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

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

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.

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 '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 rectangular bounds of this Node in the node's untransformed local coordinate space.

The rectangular bounds of this Node which include its transforms.

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

Additional hint for controlling bitmap caching.

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.

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.

Specifies the event dispatcher for this node.

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.

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.

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 rectangle (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 bounds 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 point 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 bounds 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 point 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.

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

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

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

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.

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.

The parent of this Node.

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

Whether or not the Node is pressed.

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

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

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.

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

Defines the axis of rotation of this Node.

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 rectangle 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 point from the coordinate space of the Scene into the local coordinate space of this Node.

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

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.

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

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

A string representation of the CSS style associated with this specific Node.

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

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

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

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

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

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

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

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

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

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.

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.

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

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

Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.

Construct an event dispatch chain for this target.

The CssMetaData of this Styleable.

Verifies if a object is equals to this delegate.

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

Example of filtering mouse events

pane.filterEvent(MouseEvent.Any) {
  me: MouseEvent => {
    me.eventType match {
      case MouseEvent.MousePressed => {
        ...
      }
      case MouseEvent.MouseDragged => {
        ...
      }
      case _ => {
        ...
      }
    }
  }
}

or

pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }

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

Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.

Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

A list of String identifiers which can be used to logically group Nodes, specifically for an external style engine.

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

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

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