dojox/gfx/vml_attach.Group (version 1.10)

Summary

a group shape (VML), which can be used to logically group shapes (e.g, to propagate matricies)

Usage

var foo = new vml_attach.Group();
dojox/gfx/vml

See the dojox/gfx/vml_attach.Group reference documentation for more information.

Property Summary

Method Summary

  • _applyTransform() applies a transformation matrix to a group
  • _getRealMatrix() returns the cumulative ("real") transformation matrix by combining the shape's matrix with its parent's matrix
  • _moveChildToBack(shape) moves a shape to back of the list of shapes
  • _moveChildToFront(shape) moves a shape to front of the list of shapes
  • _moveToBack() moves a shape to back of its parent's list of shapes (VML)
  • _moveToFront() moves a shape to front of its parent's list of shapes (VML)
  • _overrideSize(node)
  • _setDimensions(width,height) sets the width and height of the rawNode, if the surface size has been changed
  • _setParent(parent,matrix) sets a parent
  • _translate(dict,value)
  • _updateParentMatrix(matrix) updates the parent matrix with new matrix
  • add(shape)
  • applyLeftTransform(matrix) multiplies the existing matrix with an argument on left side (matrix * this.matrix)
  • applyRightTransform(matrix) multiplies the existing matrix with an argument on right side (this.matrix * matrix)
  • applyTransform(matrix) a shortcut for dojox/gfx/shape.Shape.applyRightTransform
  • clear() removes all shapes from a group/surface
  • connect(name,object,method) connects a handler to an event on this shape
  • createCircle(circle) creates a circle shape
  • createEllipse(ellipse) creates an ellipse shape
  • createGroup() creates a VML group shape
  • createImage(image) creates a VML image shape
  • createLine(line) creates a line shape
  • createObject(shapeType,rawShape) creates an instance of the passed shapeType class
  • createPath(path) creates a path shape
  • createPolyline(points) creates a polyline/polygon shape
  • createRect(rect) creates a rectangle shape
  • createShape(shape) creates a shape object based on its type; it is meant to be used by group-like objects
  • createText(text) creates a text shape
  • createTextPath(text) creates a text shape
  • destroy() Releases all internal resources owned by this shape.
  • disconnect(token) connects a handler by token from an event on this shape
  • getBoundingBox() Returns the bounding box Rectangle for this shape.
  • getClip()
  • getEventSource() returns a Node, which is used as a source of events for this shape
  • getFill() Returns the current fill object or null (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/Color)
  • getNode() Different graphics rendering subsystems implement shapes in different ways.
  • getParent() Returns the parent Shape, Group or null if this Shape is unparented. (see dojox/gfx/shape.Surface, or dojox/gfx.Group)
  • getShape() returns the current Shape object or null (see dojox/gfx.defaultPath, dojox/gfx.defaultPolyline, dojox/gfx.defaultRect, dojox/gfx.defaultEllipse, dojox/gfx.defaultCircle, dojox/gfx.defaultLine, or dojox/gfx.defaultImage)
  • getStroke() Returns the current stroke object or null (see dojox/gfx.defaultStroke)
  • getTransform() Returns the current transformation matrix applied to this Shape or null
  • getTransformedBoundingBox() returns an array of four points or null four points represent four corners of the untransformed bounding box
  • moveToBack() moves a shape to back of its parent's list of shapes
  • moveToFront() moves a shape to front of its parent's list of shapes
  • on(type,listener) Connects an event to this shape.
  • remove(shape,silently) remove a shape from a group/surface
  • removeShape(silently) removes the shape from its parent's list of shapes
  • setClip(clip) sets the clipping area of this shape.
  • setFill(fill) sets a fill object (VML)
  • setRawNode(rawNode) assigns and clears the underlying node that will represent this shape.
  • setShape(shape) sets a shape object (the default implementation simply ignores it)
  • setStroke(stroke) sets a stroke object (VML)
  • setTransform(matrix) sets a transformation matrix

Properties

_capMap
Defined by: dojox/gfx/vml
_capMapReversed
Defined by: dojox/gfx/vml
nodeType
Defined by: dojox/gfx/vml

Methods

_applyTransform()
Defined by dojox/gfx/vml

applies a transformation matrix to a group

Returns:function

applies a transformation matrix to a group

_getRealMatrix()
Defined by dojox/gfx/vml

returns the cumulative ("real") transformation matrix by combining the shape's matrix with its parent's matrix

Returns:undefined
_moveChildToBack(shape)
Defined by dojox/gfx/vml

moves a shape to back of the list of shapes

Parameter Type Description
shape dojox/gfx/shape.Shape

one of the child shapes to move to the front
Returns:function

moves a shape to back of the list of shapes

_moveChildToFront(shape)
Defined by dojox/gfx/vml

moves a shape to front of the list of shapes

Parameter Type Description
shape dojox/gfx/shape.Shape

one of the child shapes to move to the front
Returns:function

moves a shape to front of the list of shapes

_moveToBack()
Defined by dojox/gfx/vml

moves a shape to back of its parent's list of shapes (VML)

Returns:function

moves a shape to back of its parent's list of shapes (VML)

_moveToFront()
Defined by dojox/gfx/vml

moves a shape to front of its parent's list of shapes (VML)

Returns:function

moves a shape to front of its parent's list of shapes (VML)

_overrideSize(node)
Defined by dojox/gfx/vml
Parameter Type Description
node undefined
_setDimensions(width,height)
Defined by dojox/gfx/vml

sets the width and height of the rawNode, if the surface size has been changed

Parameter Type Description
width String

width in pixels
height String

height in pixels
Returns:function

sets the width and height of the rawNode, if the surface size has been changed

_setParent(parent,matrix)
Defined by dojox/gfx/shape

sets a parent

Parameter Type Description
parent Object

a parent or null (see dojox/gfx/shape.Surface, or dojox/gfx.Group)
matrix dojox/gfx/matrix.Matrix2D

a 2D matrix or a matrix-like object
Returns:undefined
_translate(dict,value)
Defined by dojox/gfx/vml
Parameter Type Description
dict undefined
value undefined
Returns:undefined
_updateParentMatrix(matrix)
Defined by dojox/gfx/shape

updates the parent matrix with new matrix

Parameter Type Description
matrix dojox/gfx/Matrix2D

a 2D matrix or a matrix-like object
Returns:undefined
add(shape)
Defined by dojox/gfx/vml
Parameter Type Description
shape undefined
Returns:function
applyLeftTransform(matrix)
Defined by dojox/gfx/shape

multiplies the existing matrix with an argument on left side (matrix * this.matrix)

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)
Returns:function

multiplies the existing matrix with an argument on left side (matrix * this.matrix)

applyRightTransform(matrix)
Defined by dojox/gfx/shape

multiplies the existing matrix with an argument on right side (this.matrix * matrix)

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)
Returns:function

multiplies the existing matrix with an argument on right side (this.matrix * matrix)

applyTransform(matrix)
Defined by dojox/gfx/shape

a shortcut for dojox/gfx/shape.Shape.applyRightTransform

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)
Returns:function

a shortcut for dojox/gfx/shape.Shape.applyRightTransform

clear()
Defined by dojox/gfx/vml

removes all shapes from a group/surface

Returns:undefined
connect(name,object,method)
Defined by dojox/gfx/shape

connects a handler to an event on this shape

Parameter Type Description
name undefined
object undefined
method undefined
Returns:undefined
createCircle(circle)
Defined by dojox/gfx/shape

creates a circle shape

Parameter Type Description
circle Object

a circle object (see dojox/gfx.defaultCircle)
Returns:undefined
createEllipse(ellipse)
Defined by dojox/gfx/shape

creates an ellipse shape

Parameter Type Description
ellipse Object

an ellipse object (see dojox/gfx.defaultEllipse)
Returns:undefined
createGroup()
Defined by dojox/gfx/vml

creates a VML group shape

Returns:undefined
createImage(image)
Defined by dojox/gfx/vml

creates a VML image shape

Parameter Type Description
image Object

an image object (see dojox/gfx.defaultImage)
Returns:null | instance
createLine(line)
Defined by dojox/gfx/shape

creates a line shape

Parameter Type Description
line Object

a line object (see dojox/gfx.defaultLine)
Returns:undefined
createObject(shapeType,rawShape)
Defined by dojox/gfx/vml

creates an instance of the passed shapeType class

Parameter Type Description
shapeType Function

a class constructor to create an instance of
rawShape Object

properties to be passed in to the classes "setShape" method
Returns:null | instance
createPath(path)
Defined by dojox/gfx/shape

creates a path shape

Parameter Type Description
path Object

a path object (see dojox/gfx.defaultPath)
Returns:undefined
createPolyline(points)
Defined by dojox/gfx/shape

creates a polyline/polygon shape

Parameter Type Description
points Object

a points object (see dojox/gfx.defaultPolyline) or an Array of points
Returns:undefined
createRect(rect)
Defined by dojox/gfx/vml

creates a rectangle shape

Parameter Type Description
rect Object

a path object (see dojox/gfx.defaultRect)
Returns:null | instance
createShape(shape)
Defined by dojox/gfx/shape

creates a shape object based on its type; it is meant to be used by group-like objects

Parameter Type Description
shape Object

a shape descriptor object
Returns:any | undefined | null

dojox/gfx/shape.Shape | Null a fully instantiated surface-specific Shape object

createText(text)
Defined by dojox/gfx/shape

creates a text shape

Parameter Type Description
text Object

a text object (see dojox/gfx.defaultText)
Returns:undefined
createTextPath(text)
Defined by dojox/gfx/shape

creates a text shape

Parameter Type Description
text Object

a textpath object (see dojox/gfx.defaultTextPath)
Returns:undefined
destroy()
Defined by dojox/gfx/vml

Releases all internal resources owned by this shape. Once this method has been called, the instance is considered disposed and should not be used anymore.

disconnect(token)
Defined by dojox/gfx/shape

connects a handler by token from an event on this shape

Parameter Type Description
token undefined
Returns:undefined
getBoundingBox()
Defined by dojox/gfx/vml

Returns the bounding box Rectangle for this shape.

Returns:null
getClip()
Defined by dojox/gfx/shape
Returns:undefined
getEventSource()
Defined by dojox/gfx/shape

returns a Node, which is used as a source of events for this shape

Returns:undefined
getFill()
Defined by dojox/gfx/shape

Returns the current fill object or null (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/Color)

Returns:undefined
getNode()
Defined by dojox/gfx/shape

Different graphics rendering subsystems implement shapes in different ways. This method provides access to the underlying graphics subsystem object. Clients calling this method and using the return value must be careful not to try sharing or using the underlying node in a general way across renderer implementation. Returns the underlying graphics Node, or null if no underlying graphics node is used by this shape.

Returns:undefined
getParent()
Defined by dojox/gfx/shape

Returns the parent Shape, Group or null if this Shape is unparented. (see dojox/gfx/shape.Surface, or dojox/gfx.Group)

Returns:undefined
getShape()
Defined by dojox/gfx/shape

returns the current Shape object or null (see dojox/gfx.defaultPath, dojox/gfx.defaultPolyline, dojox/gfx.defaultRect, dojox/gfx.defaultEllipse, dojox/gfx.defaultCircle, dojox/gfx.defaultLine, or dojox/gfx.defaultImage)

Returns:undefined
getStroke()
Defined by dojox/gfx/shape

Returns the current stroke object or null (see dojox/gfx.defaultStroke)

Returns:undefined
getTransform()
Defined by dojox/gfx/shape

Returns the current transformation matrix applied to this Shape or null

Returns:undefined
getTransformedBoundingBox()
Defined by dojox/gfx/shape

returns an array of four points or null four points represent four corners of the untransformed bounding box

Returns:null | Array
moveToBack()
Defined by dojox/gfx/shape

moves a shape to back of its parent's list of shapes

Returns:function

moves a shape to back of its parent's list of shapes

moveToFront()
Defined by dojox/gfx/shape

moves a shape to front of its parent's list of shapes

Returns:function

moves a shape to front of its parent's list of shapes

on(type,listener)
Defined by dojox/gfx/shape

Connects an event to this shape.

Parameter Type Description
type undefined
listener undefined
Returns:undefined
remove(shape,silently)
Defined by dojox/gfx/vml

remove a shape from a group/surface

Parameter Type Description
shape dojox/gfx/shape.Shape

a VML shape object
silently Boolean
Optional

if true, regenerate a picture
Returns:function

remove a shape from a group/surface

removeShape(silently)
Defined by dojox/gfx/shape

removes the shape from its parent's list of shapes

Parameter Type Description
silently Boolean

if true, do not redraw a picture yet
Returns:function

removes the shape from its parent's list of shapes

setClip(clip)
Defined by dojox/gfx/vml

sets the clipping area of this shape.

This method overrides the dojox/gfx/shape.Shape.setClip() method.

Parameter Type Description
clip Object

an object that defines the clipping geometry, or null to remove clip.
Returns:function

sets the clipping area of this shape.

setFill(fill)
Defined by dojox/gfx/vml

sets a fill object (VML)

Parameter Type Description
fill Object

a fill object (see dojox/gfx.defaultLinearGradient, dojox/gfx.defaultRadialGradient, dojox/gfx.defaultPattern, or dojo/_base/Color)
Returns:function

sets a fill object (VML)

setRawNode(rawNode)
Defined by dojox/gfx/vml

assigns and clears the underlying node that will represent this shape. Once set, transforms, gradients, etc, can be applied. (no fill & stroke by default)

Parameter Type Description
rawNode undefined
setShape(shape)
Defined by dojox/gfx/shape

sets a shape object (the default implementation simply ignores it)

Parameter Type Description
shape Object

a shape object (see dojox/gfx.defaultPath, dojox/gfx.defaultPolyline, dojox/gfx.defaultRect, dojox/gfx.defaultEllipse, dojox/gfx.defaultCircle, dojox/gfx.defaultLine, or dojox/gfx.defaultImage)
Returns:function

sets a shape object (the default implementation simply ignores it)

setStroke(stroke)
Defined by dojox/gfx/vml

sets a stroke object (VML)

Parameter Type Description
stroke Object

a stroke object (see dojox/gfx.defaultStroke)
Returns:function

sets a stroke object (VML)

setTransform(matrix)
Defined by dojox/gfx/shape

sets a transformation matrix

Parameter Type Description
matrix dojox/gfx/matrix.Matrix2D

a matrix or a matrix-like object (see an argument of dojox/gfx/matrix.Matrix2D constructor for a list of acceptable arguments)
Returns:undefined
Error in the documentation? Can’t find what you are looking for? Let us know!