com.gargoylesoftware.htmlunit.javascript.host.canvas

Class CanvasRenderingContext2D

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.canvas.CanvasRenderingContext2D

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class CanvasRenderingContext2D
extends SimpleScriptable

A JavaScript object for CanvasRenderingContext2D.

Version:

$Revision: 10538 $

Author:

Ahmed Ashour, Marc Guillemot, Frank Danek, Ronald Brill

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
CanvasRenderingContext2D() Default constructor.
CanvasRenderingContext2D(HTMLCanvasElement canvas) Constructs in association with HTMLCanvasElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	arc(double x, double y, double radius, double startAngle, double endAngle, boolean anticlockwise) Draws an arc.
void	arcTo(double x1, double y1, double x2, double y2, double radius) Draws an arc.
void	beginPath() Begins the subpaths.
void	bezierCurveTo(double cp1x, double cp1y, double cp2x, double cp2y, double x, double y) Draws a cubic Bézier curve.
void	clearRect(double x, double y, double w, double h) Clears the specified rectangular area.
void	clip() Creates a new clipping region.
void	closePath() Closes the subpaths.
void	createImageData() Creates a new, blank ImageData object with the specified dimensions.
void	createLinearGradient(double x0, double y0, double r0, double x1, Object y1, Object r1) Creates linear gradient.
void	createPattern() Creates a pattern.
void	createRadialGradient() Creates a gradient.
void	drawImage(Object image, int sx, int sy, Object sWidth, Object sHeight, Object dx, Object dy, Object dWidth, Object dHeight) Draws images onto the canvas.
void	ellipse(double x, double y, double radiusX, double radiusY, double rotation, double startAngle, double endAngle, boolean anticlockwise) Paints the specified ellipse.
void	fill() Fills the shape.
void	fillRect(int x, int y, int w, int h) Paints the specified rectangular area.
void	fillText() Dummy placeholder.
HTMLCanvasElement	getCanvas() Returns the associated HTMLCanvasElement.
Object	getFillStyle() Returns the "fillStyle" property.
double	getGlobalAlpha() Returns the "globalAlpha" property.
ImageData	getImageData(int sx, int sy, int sw, int sh) Returns the ImageData object.
void	getLineDash() Dummy placeholder.
void	getLineData() Dummy placeholder.
double	getLineWidth() Returns the "lineWidth" property.
Object	getStrokeStyle() Returns the "strokeStyle" property.
void	isPointInPath() Dummy placeholder.
void	lineTo(double x, double y) Connect the last point to the given point.
void	measureText() Dummy placeholder.
void	moveTo(double x, double y) Creates a new subpath.
void	putImageData() Dummy placeholder.
void	quadraticCurveTo(double controlPointX, double controlPointY, double endPointX, double endPointY) Draws a quadratic Bézier curve.
void	rect() Dummy placeholder.
void	restore() Pops state stack and restore state.
void	rotate() Dummy placeholder.
void	save() Pushes state on state stack.
void	scale(Object x, Object y) Changes the transformation matrix to apply a scaling transformation with the given characteristics.
void	setFillStyle(String fillStyle) Sets the "fillStyle" property.
void	setGlobalAlpha(Object globalAlpha) Sets the "globalAlpha" property.
void	setLineDash() Dummy placeholder.
void	setLineWidth(Object lineWidth) Sets the "lineWidth" property.
void	setStrokeStyle(Object strokeStyle) Sets the "strokeStyle" property.
void	setTransform() Dummy placeholder.
void	stroke() Calculates the strokes of all the subpaths of the current path.
void	strokeRect(double x, double y, double w, double h) Strokes the specified rectangular area.
void	strokeText() Dummy placeholder.
String	toDataURL(String type) Returns the Data URL.
void	transform() Dummy placeholder.
void	translate(Object x, Object y) Changes the transformation matrix to apply a translation transformation with the given characteristics.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, defineFunctionProperties, defineProperty, equivalentValues, get, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setClassName, setDomNode, setDomNode, setHtmlElement, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

CanvasRenderingContext2D

public CanvasRenderingContext2D()

Default constructor.

CanvasRenderingContext2D

public CanvasRenderingContext2D(HTMLCanvasElement canvas)

Constructs in association with HTMLCanvasElement.

Parameters:

canvas - the HTMLCanvasElement

Method Detail

getFillStyle

public Object getFillStyle()

Returns the "fillStyle" property.

Returns:

the "fillStyle" property

setFillStyle

public void setFillStyle(String fillStyle)

Sets the "fillStyle" property.

Parameters:

fillStyle - the "fillStyle" property

getStrokeStyle

public Object getStrokeStyle()

Returns the "strokeStyle" property.

Returns:

the "strokeStyle" property

setStrokeStyle

public void setStrokeStyle(Object strokeStyle)

Sets the "strokeStyle" property.

Parameters:

strokeStyle - the "strokeStyle" property

getLineWidth

public double getLineWidth()

Returns the "lineWidth" property.

Returns:

the "lineWidth" property

setLineWidth

public void setLineWidth(Object lineWidth)

Sets the "lineWidth" property.

Parameters:

lineWidth - the "lineWidth" property

getGlobalAlpha

public double getGlobalAlpha()

Returns the "globalAlpha" property.

Returns:

the "globalAlpha" property

setGlobalAlpha

public void setGlobalAlpha(Object globalAlpha)

Sets the "globalAlpha" property.

Parameters:

globalAlpha - the "globalAlpha" property

arc

public void arc(double x,
       double y,
       double radius,
       double startAngle,
       double endAngle,
       boolean anticlockwise)

Draws an arc.

Parameters:

x - the x

y - the y

radius - the radius

startAngle - the start angle

endAngle - the end angle

anticlockwise - is anti-clockwise

arcTo

public void arcTo(double x1,
         double y1,
         double x2,
         double y2,
         double radius)

Draws an arc.

Parameters:

x1 - the x1

y1 - the y1

x2 - the x2

y2 - the y2

radius - the radius

beginPath

public void beginPath()

Begins the subpaths.

bezierCurveTo

public void bezierCurveTo(double cp1x,
                 double cp1y,
                 double cp2x,
                 double cp2y,
                 double x,
                 double y)

Draws a cubic Bézier curve.

Parameters:

cp1x - the cp1x

cp1y - the cp1y

cp2x - the cp2x

cp2y - the cp2y

x - the x

y - the y

clearRect

public void clearRect(double x,
             double y,
             double w,
             double h)

Clears the specified rectangular area.

Parameters:

x - the x

y - the y

w - the width

h - the height

clip

public void clip()

Creates a new clipping region.

closePath

public void closePath()

Closes the subpaths.

createImageData

public void createImageData()

Creates a new, blank ImageData object with the specified dimensions.

createLinearGradient

public void createLinearGradient(double x0,
                        double y0,
                        double r0,
                        double x1,
                        Object y1,
                        Object r1)

Creates linear gradient.

Parameters:

x0 - the x0

y0 - the y0

r0 - the r0

x1 - the x1

y1 - the y1

r1 - the r1

createPattern

public void createPattern()

Creates a pattern.

createRadialGradient

public void createRadialGradient()

Creates a gradient.

drawImage

public void drawImage(Object image,
             int sx,
             int sy,
             Object sWidth,
             Object sHeight,
             Object dx,
             Object dy,
             Object dWidth,
             Object dHeight)

Draws images onto the canvas.

Parameters:

image - an element to draw into the context

sx - the X coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context

sy - the Y coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context

sWidth - the width of the sub-rectangle of the source image to draw into the destination context

sHeight - the height of the sub-rectangle of the source image to draw into the destination context

dx - the X coordinate in the destination canvas at which to place the top-left corner of the source image

dy - the Y coordinate in the destination canvas at which to place the top-left corner of the source image

dWidth - the width to draw the image in the destination canvas. This allows scaling of the drawn image

dHeight - the height to draw the image in the destination canvas. This allows scaling of the drawn image

toDataURL

public String toDataURL(String type)

Returns the Data URL.

Parameters:

type - an optional type

Returns:

the dataURL

ellipse

public void ellipse(double x,
           double y,
           double radiusX,
           double radiusY,
           double rotation,
           double startAngle,
           double endAngle,
           boolean anticlockwise)

Paints the specified ellipse.

Parameters:

x - the x

y - the y

radiusX - the radiusX

radiusY - the radiusY

rotation - the rotation

startAngle - the startAngle

endAngle - the endAngle

anticlockwise - the anticlockwise

fill

public void fill()

Fills the shape.

fillRect

public void fillRect(int x,
            int y,
            int w,
            int h)

Paints the specified rectangular area.

Parameters:

x - the x

y - the y

w - the width

h - the height

fillText

public void fillText()

Dummy placeholder.

getImageData

public ImageData getImageData(int sx,
                     int sy,
                     int sw,
                     int sh)

Returns the ImageData object.

Parameters:

sx - x

sy - y

sw - width

sh - height

Returns:

the ImageData object

getLineDash

public void getLineDash()

Dummy placeholder.

getLineData

public void getLineData()

Dummy placeholder.

isPointInPath

public void isPointInPath()

Dummy placeholder.

lineTo

public void lineTo(double x,
          double y)

Connect the last point to the given point.

Parameters:

x - the x

y - the y

measureText

public void measureText()

Dummy placeholder.

moveTo

public void moveTo(double x,
          double y)

Creates a new subpath.

Parameters:

x - the x

y - the y

putImageData

public void putImageData()

Dummy placeholder.

quadraticCurveTo

public void quadraticCurveTo(double controlPointX,
                    double controlPointY,
                    double endPointX,
                    double endPointY)

Draws a quadratic Bézier curve.

Parameters:

controlPointX - the x-coordinate of the control point

controlPointY - the y-coordinate of the control point

endPointX - the x-coordinate of the end point

endPointY - the y-coordinate of the end point

rect

public void rect()

Dummy placeholder.

restore

public void restore()

Pops state stack and restore state.

rotate

public void rotate()

Dummy placeholder.

save

public void save()

Pushes state on state stack.

scale

public void scale(Object x,
         Object y)

Changes the transformation matrix to apply a scaling transformation with the given characteristics.

Parameters:

x - the scale factor in the horizontal direction

y - the scale factor in the vertical direction

setLineDash

public void setLineDash()

Dummy placeholder.

setTransform

public void setTransform()

Dummy placeholder.

stroke

public void stroke()

Calculates the strokes of all the subpaths of the current path.

strokeRect

public void strokeRect(double x,
              double y,
              double w,
              double h)

Strokes the specified rectangular area.

Parameters:

x - the x

y - the y

w - the width

h - the height

strokeText

public void strokeText()

Dummy placeholder.

transform

public void transform()

Dummy placeholder.

translate

public void translate(Object x,
             Object y)

Changes the transformation matrix to apply a translation transformation with the given characteristics.

Parameters:

x - the translation distance in the horizontal direction

y - the translation distance in the vertical direction

getCanvas

public HTMLCanvasElement getCanvas()

Returns the associated HTMLCanvasElement.

Returns:

the associated HTMLCanvasElement