javafx.scene.canvas

Class Canvas

java.lang.Object

javafx.scene.Node

javafx.scene.canvas.Canvas

All Implemented Interfaces:

Styleable, EventTarget

public class Canvas
extends Node

Canvas is an image that can be drawn on using a set of graphics commands provided by a GraphicsContext.

A Canvas node is constructed with a width and height that specifies the size of the image into which the canvas drawing commands are rendered. All drawing operations are clipped to the bounds of that image.

Example:

import javafx.scene.*;
import javafx.scene.paint.*;
import javafx.scene.canvas.*;

Group root = new Group();
Scene s = new Scene(root, 300, 300, Color.BLACK);

final Canvas canvas = new Canvas(250,250);
GraphicsContext gc = canvas.getGraphicsContext2D();

gc.setFill(Color.BLUE);
gc.fillRect(75,75,100,100);

root.getChildren().add(canvas);
 

Since:

JavaFX 2.2

Field Summary

Fields

Modifier and Type	Field and Description
private GrowableDataBuffer	current
(package private) static int	DEFAULT_OBJ_BUF_SIZE
(package private) static int	DEFAULT_VAL_BUF_SIZE
private DoubleProperty	height Defines the height of the canvas.
private int	lastsizeindex
private int[]	recentobjsizes
private int[]	recentvalsizes
private boolean	rendererBehind
private static int	SIZE_HISTORY
private GraphicsContext	theContext
private DoubleProperty	width Defines the width of the canvas.

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
Canvas() Creates an empty instance of Canvas.
Canvas(double width, double height) Creates a new instance of Canvas with the given size.

Method Summary

Modifier and Type	Method and Description
(package private) GrowableDataBuffer	getBuffer()
GraphicsContext	getGraphicsContext2D() returns the GraphicsContext associated with this Canvas.
double	getHeight()
double	getWidth()
DoubleProperty	heightProperty()
protected boolean	impl_computeContains(double localX, double localY) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
BaseBounds	impl_computeGeomBounds(BaseBounds bounds, BaseTransform tx) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
protected NGNode	impl_createPeer() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
java.lang.Object	impl_processMXNode(MXNodeAlgorithm alg, MXNodeAlgorithmContext ctx) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
void	impl_updatePeer() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
(package private) boolean	isRendererFallingBehind()
private static int	max(int[] sizes, int defsize)
void	setHeight(double value)
void	setWidth(double value)
DoubleProperty	widthProperty()

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBaselineOffset, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClassCssMetaData, getClip, getContentBias, getCssMetaData, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_computeLayoutBounds, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_notifyLayoutBoundsChanged, impl_pickNode, impl_pickNodeLocal, impl_processCSS, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookup, lookupAll, managedProperty, maxHeight, maxWidth, minHeight, minWidth, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, prefHeight, prefWidth, pressedProperty, pseudoClassStateChanged, queryAccessibleAttribute, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_VAL_BUF_SIZE

static final int DEFAULT_VAL_BUF_SIZE

See Also:

Constant Field Values

DEFAULT_OBJ_BUF_SIZE

static final int DEFAULT_OBJ_BUF_SIZE

See Also:

Constant Field Values

SIZE_HISTORY

private static final int SIZE_HISTORY

See Also:

Constant Field Values

current

private GrowableDataBuffer current

rendererBehind

private boolean rendererBehind

recentvalsizes

private int[] recentvalsizes

recentobjsizes

private int[] recentobjsizes

lastsizeindex

private int lastsizeindex

theContext

private GraphicsContext theContext

width

private DoubleProperty width

Defines the width of the canvas.

height

private DoubleProperty height

Defines the height of the canvas.

Constructor Detail

Canvas

public Canvas()

Creates an empty instance of Canvas.

Canvas

public Canvas(double width,
              double height)

Creates a new instance of Canvas with the given size.

Parameters:

width - width of the canvas

height - height of the canvas

Method Detail

max

private static int max(int[] sizes,
                       int defsize)

getBuffer

GrowableDataBuffer getBuffer()

isRendererFallingBehind

boolean isRendererFallingBehind()

getGraphicsContext2D

public GraphicsContext getGraphicsContext2D()

returns the GraphicsContext associated with this Canvas.

setWidth

public final void setWidth(double value)

getWidth

public final double getWidth()

widthProperty

public final DoubleProperty widthProperty()

setHeight

public final void setHeight(double value)

getHeight

public final double getHeight()

heightProperty

public final DoubleProperty heightProperty()

impl_createPeer

@Deprecated
protected NGNode impl_createPeer()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Specified by:

impl_createPeer in class Node

impl_updatePeer

@Deprecated
public void impl_updatePeer()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Node

This function is called during synchronization to update the state of the PG Node from the FX Node. Subclasses of Node should override this method and must call super.impl_updatePeer()

Overrides:

impl_updatePeer in class Node

impl_computeContains

@Deprecated
protected boolean impl_computeContains(double localX,
                                                   double localY)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Specified by:

impl_computeContains in class Node

impl_computeGeomBounds

@Deprecated
public BaseBounds impl_computeGeomBounds(BaseBounds bounds,
                                                     BaseTransform tx)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Node

Computes the geometric bounds for this Node. This method is abstract and must be implemented by each Node subclass.

Specified by:

impl_computeGeomBounds in class Node

impl_processMXNode

@Deprecated
public java.lang.Object impl_processMXNode(MXNodeAlgorithm alg,
                                                       MXNodeAlgorithmContext ctx)

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Description copied from class: Node

This method is used by Scene-graph JMX bean to obtain the Scene-graph structure.

Specified by:

impl_processMXNode in class Node

Parameters:

alg - current algorithm to process this node

ctx - current context

Returns:

the algorithm specific result for this node