Overview

Common base class for all objects that appear in a Canvas.

Attribute Summary

nametypedescription
Public
boundsRectangle2D
canAcceptDropfunction(:CanvasDropEvent):boolean
clipClip
currentHeightNumber

Read-only attribute returning the current height of this node.

currentWidthNumber

Read-only attribute returning the current width of this node.

currentXNumber

Read-only attribute returning the current x coordinate of this node relative to its parent.

currentYNumber

Read-only attribute returning the current y coordinate of this node relative to its parent.

cursorCursor

Optional cursor to use when the mouse is over this node.

exportAsDragfunction():CanvasDragEvent
exportDragBoolean
filterFilter

An optional Filter chain that will be applied to this node.

focusableBoolean

Sets the focusable state of this Node to the specified value.

focusedBoolean
halignHorizontalAlignment

Determines the horizontal alignment of this node relative to its origin.

hoverBoolean
idString
isSelectionRootBoolean
LISTENERFXNodeListener
MOUSE_DRAGMouseEvent
MOUSE_DRAG_SCREENPoint
MOUSE_PRESSMouseEvent
onDragEnterfunction(:CanvasDropEvent):Void
onDragExitfunction(:CanvasDropEvent):Void
onDropfunction(:CanvasDropEvent):Void
onKeyDownfunction(:KeyEvent):Void
onKeyTypedfunction(:KeyEvent):Void
onKeyUpfunction(:KeyEvent):Void
onMouseClickedfunction(:CanvasMouseEvent):Void

attribute onMouseClicked: function(e:CanvasMouseEvent)

Optional handler for mouse click events

onMouseDraggedfunction(:CanvasMouseEvent):Void

attribute onMouseDragged: function(e:CanvasMouseEvent)

Optional handler for mouse drag events.

onMouseEnteredfunction(:CanvasMouseEvent):Void

attribute onMouseEntered: function(e:CanvasMouseEvent)

Optional handler for mouse enter events.

onMouseExitedfunction(:CanvasMouseEvent):Void

attribute onMouseExited: function(e:CanvasMouseEvent)

Optional handler for mouse exit events.

onMouseMovedfunction(:CanvasMouseEvent):Void

attribute onMouseMoved: function(e:CanvasMouseEvent)

Optional handler for mouse motion events.

onMousePressedfunction(:CanvasMouseEvent):Void

attribute onMousePressed: function(e:CanvasMouseEvent)

Optional handler for mouse press events.

onMouseReleasedfunction(:CanvasMouseEvent):Void

attribute onMouseReleased: function(e:CanvasMouseEvent)

Optional handler for mouse release events.

opacityNumber

A number between 0 and 1, 0 being transparent and 1 opaque.

opacitySetBoolean
scaleToFitCanvasBoolean

If true this node will be scaled to the size of its containing canvas.

selectableBoolean

Determines whether this node responds to mouse events, or other picking functions.

toolTipTextString
valignVerticalAlignment

Determines the vertical alignment of this node relative to its origin.

visibleBoolean

Determines whether this node is visible in the canvas.

Protected
keyListenerSGKeyListener
mouseListenerSGMouseListener

Inherited Attributes

javafx.ui.canvas.CanvasElement

publicnametype
parentCanvasElementCanvasElement

The containing element of this element.

javafx.ui.canvas.Transformable

publicnametype
affineTransformAffineTransform
onTransformChangedfunction(:AffineTransform):Void
transformTransform[]

A list of transformation functions that will be performed on this object.

Function Summary

protected abstract createNode() : SGNode
public getGlobalBounds() : Rectangle2D
public getNode() : SGNode
public handleAcceptDrop(e: CanvasDropEvent, ) : Boolean
public handleDragEnter(e: CanvasDropEvent, ) : Boolean
public handleDragExit(e: CanvasDropEvent, ) : Boolean
public handleDrop(e: CanvasDropEvent, ) : Boolean
protected installFocusListener() : Void
public installKeyListener() : Void
protected installMouseListener() : Void
protected makeCanvasMouseEvent(e: MouseEvent, ) : CanvasMouseEvent
protected makeKeyEvent(e: KeyEvent, ) : KeyEvent
public requestFocus() : Void

Inherited Functions

javafx.ui.canvas.CanvasElement

public getCanvas() : Canvas

Convenience method to obtain the containing canvas.

public bound getContainer() : Container

Returns the canvas element that contains this element

public bound hasParent() : Boolean
public lower() : Void

raise this element below its previous sibling

protected onSetCanvas(canvas: Canvas, ) : Void
public raise() : Void

raise this element above its next sibling

public toBack() : Void

move this element before all of its previous siblings

public toFront() : Void

move this element after all of its following siblings

javafx.ui.canvas.Transformable

protected updateTransform() : Void

Attributes

public currentHeight: Number

Read-only attribute returning the current height of this node.

public currentWidth: Number

Read-only attribute returning the current width of this node.

public currentX: Number

Read-only attribute returning the current x coordinate of this node relative to its parent.

public currentY: Number

Read-only attribute returning the current y coordinate of this node relative to its parent.

public cursor: Cursor

Optional cursor to use when the mouse is over this node.

public filter: Filter

An optional Filter chain that will be applied to this node.

public focusable: Boolean

Sets the focusable state of this Node to the specified value. This value overrides the Node's default focusability, wich is false.

public halign: HorizontalAlignment

Determines the horizontal alignment of this node relative to its origin.

public onMouseClicked: function(:CanvasMouseEvent):Void

attribute onMouseClicked: function(e:CanvasMouseEvent)

Optional handler for mouse click events

public onMouseDragged: function(:CanvasMouseEvent):Void

attribute onMouseDragged: function(e:CanvasMouseEvent)

Optional handler for mouse drag events.

public onMouseEntered: function(:CanvasMouseEvent):Void

attribute onMouseEntered: function(e:CanvasMouseEvent)

Optional handler for mouse enter events.

public onMouseExited: function(:CanvasMouseEvent):Void

attribute onMouseExited: function(e:CanvasMouseEvent)

Optional handler for mouse exit events.

public onMouseMoved: function(:CanvasMouseEvent):Void

attribute onMouseMoved: function(e:CanvasMouseEvent)

Optional handler for mouse motion events.

public onMousePressed: function(:CanvasMouseEvent):Void

attribute onMousePressed: function(e:CanvasMouseEvent)

Optional handler for mouse press events.

public onMouseReleased: function(:CanvasMouseEvent):Void

attribute onMouseReleased: function(e:CanvasMouseEvent)

Optional handler for mouse release events.

public opacity: Number

A number between 0 and 1, 0 being transparent and 1 opaque.

public scaleToFitCanvas: Boolean

If true this node will be scaled to the size of its containing canvas.

public selectable: Boolean

Determines whether this node responds to mouse events, or other picking functions.

public valign: VerticalAlignment

Determines the vertical alignment of this node relative to its origin.

public visible: Boolean

Determines whether this node is visible in the canvas. If set to false, this node and anything it contains will not be painted and will not receive events.

Functions

public handleDragExit(e: CanvasDropEvent, ):Boolean

Parameters
e
Returns
Boolean

public handleDrop(e: CanvasDropEvent, ):Boolean

Parameters
e
Returns
Boolean

protected makeCanvasMouseEvent(e: MouseEvent, ):CanvasMouseEvent

Parameters
e
Returns
CanvasMouseEvent

protected makeKeyEvent(e: KeyEvent, ):KeyEvent

Parameters
e
Returns
KeyEvent