com.sencha.gxt.chart.client.draw.engine

Class VML

java.lang.Object

com.sencha.gxt.chart.client.draw.Surface

com.sencha.gxt.chart.client.draw.engine.DomSurface

com.sencha.gxt.chart.client.draw.engine.VML

public class VML
extends DomSurface

Provides specific methods to draw with VML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VML.SpritePooling
static interface	VML.VmlBundle
static interface	VML.VmlCss

Field Summary

Fields

Modifier and Type	Field and Description
protected VML.VmlCss	css
protected boolean	ignoreOptimizations
protected <any>	pool
protected boolean	poolingEnabled Flag to cache unused VML elements since they can leak if excessively created and deleted.

Fields inherited from class com.sencha.gxt.chart.client.draw.engine.DomSurface

elements, spriteIds

Fields inherited from class com.sencha.gxt.chart.client.draw.Surface

backgroundSprite, component, container, height, sprites, surfaceElement, width

Constructor Summary

Constructors

Constructor and Description
VML()

Method Summary

Modifier and Type	Method and Description
void	deleteSprite(Sprite sprite) Deletes the given sprite from the surface.
void	draw() Renders the surface to the DOM as well as any sprites already added.
void	drawIgnoreOptimizations() Draws the surface ignoring whether or not sprites are dirty.
protected PreciseRectangle	getBBoxText(TextSprite sprite) Calculates the bounding box of the given text sprite.
void	renderSprite(Sprite sprite) Renders the given sprite to the DOM.
void	setCursor(Sprite sprite, String property) Sets the cursor property for the given sprite.
void	setViewBox(double x, double y, double width, double height) Sets the view box of the surface.
protected static String	toFixed(double number, double place) Returns the given number rounded to the given precision.

Methods inherited from class com.sencha.gxt.chart.client.draw.engine.DomSurface

getElement, setElement, setId

Methods inherited from class com.sencha.gxt.chart.client.draw.Surface

add, addGradient, clear, create, create, getBBox, getComponent, getHeight, getSprites, getSurfaceElement, getWidth, renderAll, setBackground, setHeight, setWidth

Methods inherited from class java.lang.Object

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

Field Detail

ignoreOptimizations

protected boolean ignoreOptimizations

css

protected VML.VmlCss css

poolingEnabled

protected boolean poolingEnabled

Flag to cache unused VML elements since they can leak if excessively created and deleted. Defaults to false, and designed to be set from a set-property decl in a module file. For example, this line could turn on pooling across all VML instances:

   <set-property name="gxt.vml.enableSpritePooling" value="true" />
 

This protected field can also be configured programmatically, but must be set before any sprites are added to the surface (including before any axis/series/legend is added to a chart, and before it is attached).

pool

protected <any> pool

Constructor Detail

VML

public VML()

Method Detail

toFixed

protected static String toFixed(double number,
                                double place)

Returns the given number rounded to the given precision.

Parameters:

number - the number to be rounded

place - the decimal place

Returns:

the rounded number

deleteSprite

public void deleteSprite(Sprite sprite)

Description copied from class: Surface

Deletes the given sprite from the surface.

Overrides:

deleteSprite in class DomSurface

Parameters:

sprite - the sprite to be deleted

draw

public void draw()

Description copied from class: Surface

Renders the surface to the DOM as well as any sprites already added.

Overrides:

draw in class Surface

drawIgnoreOptimizations

public void drawIgnoreOptimizations()

Draws the surface ignoring whether or not sprites are dirty.

renderSprite

public void renderSprite(Sprite sprite)

Description copied from class: Surface

Renders the given sprite to the DOM.

Specified by:

renderSprite in class Surface

Parameters:

sprite - the sprite to be rendered

setCursor

public void setCursor(Sprite sprite,
                      String property)

Description copied from class: Surface

Sets the cursor property for the given sprite.

Specified by:

setCursor in class Surface

Parameters:

sprite - the sprite to be set

property - the property to use

setViewBox

public void setViewBox(double x,
                       double y,
                       double width,
                       double height)

Description copied from class: Surface

Sets the view box of the surface. The view box scales the sprites in the surface.

Specified by:

setViewBox in class Surface

Parameters:

x - the x coordinate of the viewbox

y - the y coordinate of the viewbox

width - the width of the viewbox

height - the height of the viewbox

getBBoxText

protected PreciseRectangle getBBoxText(TextSprite sprite)

Description copied from class: Surface

Calculates the bounding box of the given text sprite.

Specified by:

getBBoxText in class Surface

Parameters:

sprite - the text sprite to be used in the calculation

Returns:

bounding box of the text sprite