public class

CanvasElement

extends Element

java.lang.Object
↳	com.google.gwt.core.client.JavaScriptObject
	↳	com.google.gwt.dom.client.Node
		↳	com.google.gwt.dom.client.Element
			↳	com.google.gwt.dom.client.CanvasElement

Class Overview

Canvas element.

Experimental API: This API is still under development and is subject to change.

Summary

Constants
String	TAG	The tag for this element.

[Expand]

Inherited Constants

From class com.google.gwt.dom.client.Node

Protected Constructors
	CanvasElement()

Public Methods
final Context	getContext(String contextId) Gets the rendering context that may be used to draw on this canvas.
final Context2d	getContext2d() Returns a 2D rendering context.
final int	getHeight() Gets the height of the canvas.
final int	getWidth() Gets the width of the canvas.
final void	setHeight(int height) Sets the height of the canvas.
final void	setWidth(int width) Sets the width of the canvas.
final String	toDataUrl() Returns a data URL for the current content of the canvas element.
final String	toDataUrl(String type) Returns a data URL for the current content of the canvas element, with a specified type.

[Expand]

Inherited Methods

From class com.google.gwt.dom.client.Element

final void	addClassName(String className) Adds a name to this element's class property.
static Element	as(JavaScriptObject o) Assert that the given `Node` is an `Element` and automatically typecast it.
static Element	as(Node node) Assert that the given `Node` is an `Element` and automatically typecast it.
final void	blur() Removes keyboard focus from this element.
final void	dispatchEvent(NativeEvent evt) Dispatched the given event with this element as its target.
final void	focus() Gives keyboard focus to this element.
final int	getAbsoluteBottom() Gets an element's absolute bottom coordinate in the document's coordinate system.
final int	getAbsoluteLeft() Gets an element's absolute left coordinate in the document's coordinate system.
final int	getAbsoluteRight() Gets an element's absolute right coordinate in the document's coordinate system.
final int	getAbsoluteTop() Gets an element's absolute top coordinate in the document's coordinate system.
final String	getAttribute(String name) Retrieves an attribute value by name.
final String	getClassName() The class attribute of the element.
final int	getClientHeight() Returns the inner height of an element in pixels, including padding but not the horizontal scrollbar height, border, or margin.
final int	getClientWidth() Returns the inner width of an element in pixels, including padding but not the vertical scrollbar width, border, or margin.
final String	getDir() Specifies the base direction of directionally neutral text and the directionality of tables.
final NodeList<Element>	getElementsByTagName(String name) Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a preorder traversal of this Element tree.
final Element	getFirstChildElement() The first child of element this element.
final String	getId() The element's identifier.
final String	getInnerHTML() All of the markup and content within a given element.
final String	getInnerText() The text between the start and end tags of the object.
final String	getLang() Language code defined in RFC 1766.
final Element	getNextSiblingElement() The element immediately following this element.
final int	getOffsetHeight() The height of an element relative to the layout.
final int	getOffsetLeft() The number of pixels that the upper left corner of the current element is offset to the left within the offsetParent node.
final Element	getOffsetParent() Returns a reference to the object which is the closest (nearest in the containment hierarchy) positioned containing element.
final int	getOffsetTop() The number of pixels that the upper top corner of the current element is offset to the top within the offsetParent node.
final int	getOffsetWidth() The width of an element relative to the layout.
final boolean	getPropertyBoolean(String name) Gets a boolean property from this element.
final double	getPropertyDouble(String name) Gets a double property from this element.
final int	getPropertyInt(String name) Gets an integer property from this element.
final JavaScriptObject	getPropertyJSO(String name) Gets a JSO property from this element.
final Object	getPropertyObject(String name) Gets an object property from this element.
final String	getPropertyString(String name) Gets a property from this element.
final int	getScrollHeight() The height of the scroll view of an element.
final int	getScrollLeft() The number of pixels that an element's content is scrolled from the left.
final int	getScrollTop() The number of pixels that an element's content is scrolled from the top.
final int	getScrollWidth() The width of the scroll view of an element.
final String	getString() Gets a string representation of this element (as outer HTML).
final Style	getStyle() Gets this element's `Style` object.
final int	getTabIndex() The index that represents the element's position in the tabbing order.
final String	getTagName() Gets the element's full tag name, including the namespace-prefix if present.
final String	getTitle() The element's advisory title.
final boolean	hasAttribute(String name) Determines whether an element has an attribute with a given name.
final boolean	hasTagName(String tagName) Determines whether this element has the given tag name.
static boolean	is(Node node) Determine whether the given `Node` can be cast to an `Element`.
static boolean	is(JavaScriptObject o) Determines whether the given `JavaScriptObject` can be cast to an `Element`.
final void	removeAttribute(String name) Removes an attribute by name.
final void	removeClassName(String className) Removes a name from this element's class property.
final void	replaceClassName(String oldClassName, String newClassName) Replace one class name with another.
final void	scrollIntoView() Scrolls this element into view.
final void	setAttribute(String name, String value) Adds a new attribute.
final void	setClassName(String className) The class attribute of the element.
final void	setDir(String dir) Specifies the base direction of directionally neutral text and the directionality of tables.
final void	setId(String id) The element's identifier.
final void	setInnerHTML(String html) All of the markup and content within a given element.
final void	setInnerText(String text) The text between the start and end tags of the object.
final void	setLang(String lang) Language code defined in RFC 1766.
final void	setPropertyBoolean(String name, boolean value) Sets a boolean property on this element.
final void	setPropertyDouble(String name, double value) Sets a double property on this element.
final void	setPropertyInt(String name, int value) Sets an integer property on this element.
final void	setPropertyJSO(String name, JavaScriptObject value) Sets a JSO property on this element.
final void	setPropertyObject(String name, Object value) Sets an object property on this element.
final void	setPropertyString(String name, String value) Sets a property on this element.
final void	setScrollLeft(int scrollLeft) The number of pixels that an element's content is scrolled to the left.
final void	setScrollTop(int scrollTop) The number of pixels that an element's content is scrolled to the top.
final void	setTabIndex(int tabIndex) The index that represents the element's position in the tabbing order.
final void	setTitle(String title) The element's advisory title.

From class com.google.gwt.dom.client.Node

final <T extends Node> T	appendChild(T newChild) Adds the node newChild to the end of the list of children of this node.
static Node	as(JavaScriptObject o) Assert that the given `JavaScriptObject` is a DOM node and automatically typecast it.
final Node	cloneNode(boolean deep) Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
final Node	getChild(int index) Gets the child node at the given index.
final int	getChildCount() Gets the number of child nodes contained within this node.
final NodeList<Node>	getChildNodes() A NodeList that contains all children of this node.
final Node	getFirstChild() The first child of this node.
final Node	getLastChild() The last child of this node.
final Node	getNextSibling() The node immediately following this node.
final String	getNodeName() The name of this node, depending on its type; see the table above.
final short	getNodeType() A code representing the type of the underlying object, as defined above.
final String	getNodeValue() The value of this node, depending on its type; see the table above.
final Document	getOwnerDocument() The Document object associated with this node.
final Element	getParentElement() Gets the parent element of this node.
final Node	getParentNode() The parent of this node.
final Node	getPreviousSibling() The node immediately preceding this node.
final boolean	hasChildNodes() Returns whether this node has any children.
final boolean	hasParentElement() Determines whether this node has a parent element.
final Node	insertAfter(Node newChild, Node refChild) Inserts the node newChild after the existing child node refChild.
final Node	insertBefore(Node newChild, Node refChild) Inserts the node newChild before the existing child node refChild.
final Node	insertFirst(Node child) Inserts the given child as the first child of this node.
static boolean	is(JavaScriptObject o) Determines whether the given `JavaScriptObject` is a DOM node.
final boolean	isOrHasChild(Node child) Determine whether a node is equal to, or the child of, this node.
final Node	removeChild(Node oldChild) Removes the child node indicated by oldChild from the list of children, and returns it.
final void	removeFromParent() Removes this node from its parent node if it is attached to one.
final Node	replaceChild(Node newChild, Node oldChild) Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
final void	setNodeValue(String nodeValue) The value of this node, depending on its type; see the table above.

From class com.google.gwt.core.client.JavaScriptObject

From class java.lang.Object

Constants

public static final String TAG

The tag for this element.

Constant Value: "canvas"

Protected Constructors

protected CanvasElement ()

Public Methods

public final Context getContext (String contextId)

Gets the rendering context that may be used to draw on this canvas.

Parameters

contextId	the context id as a String

Returns

the canvas rendering context

public final Context2d getContext2d ()

Returns a 2D rendering context. This is a convenience method, see getContext(String).

Returns

a 2D canvas rendering context

public final int getHeight ()

Gets the height of the canvas.

Returns

the height, in pixels

public final int getWidth ()

Gets the width of the canvas.

Returns

the width, in pixels

public final void setHeight (int height)

Sets the height of the canvas.

Parameters

height	the height, in pixels

public final void setWidth (int width)

Sets the width of the canvas.

Parameters

width	the width, in pixels

public final String toDataUrl ()

Returns a data URL for the current content of the canvas element.

Returns

a data URL for the current content of this element.

public final String toDataUrl (String type)

Returns a data URL for the current content of the canvas element, with a specified type.

Parameters

type	the type of the data url, e.g., image/jpeg or image/png.

Returns

a data URL for the current content of this element with the specified type.

Interfaces

Classes

Annotations

Enums

CanvasElement

Class Overview

See Also

Summary

Constants

public static final String TAG

Protected Constructors

protected CanvasElement ()

Public Methods

public final Context getContext (String contextId)

Parameters

Returns

public final Context2d getContext2d ()

Returns

public final int getHeight ()

Returns

See Also

public final int getWidth ()

Returns

See Also

public final void setHeight (int height)

Parameters

See Also

public final void setWidth (int width)

Parameters

See Also

public final String toDataUrl ()

Returns

public final String toDataUrl (String type)

Parameters

Returns