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 static Logger	logger
protected RegExp	newLineRegExp
protected <any>	pool
protected boolean	poolingEnabled Flag to cache unused VML elements since they can leak if excessively created and deleted.
protected Map<Sprite,PreciseRectangle>	textBBoxCache
protected Map<Sprite,TextSprite.TextBaseline>	textRenderedBaseline
protected Map<Sprite,PrecisePoint>	textRenderedPoints
protected Scaling	viewBoxShift
protected int	zoom

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
protected void	addNamespace(String namespace, String urn) Adds the passed namespace and URN to the document.
protected void	applyAttributes(Sprite sprite) Applies pending attributes to the DOM element of a Sprite.
protected void	applyClip(Sprite sprite) Applies the clip rectangle of the given sprite to its DOM element.
protected void	applyZIndex(Sprite sprite, XElement element) Applies the z-index of the given sprite to its DOM element.
protected boolean	containsNonVMLCommands(PathSprite sprite) Determines whether a PathSprite contains a command not supported by VML.
static Surface	create(DrawComponent component, int width, int height) Instantiates a surface instance with VML.
protected XElement	createNode(String tagName) Creates a VML DOM node.
protected XElement	createSpriteElement(Sprite sprite) Creates the DOM element of the passed Sprite.
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 String	ellipticalArc(Sprite sprite) Generates a path sprite made up of an elliptical arc based on the given CircleSprite or EllipseSprite.
protected PreciseRectangle	getBBoxText(TextSprite sprite) Calculates the bounding box of the given text sprite.
protected String	path2vml(PathSprite sprite) Returns a string representing a VML path using the the passed PathSprite.
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.
protected void	setFill(Sprite sprite, Element element) Applies the fill attribute of a sprite to its VML DOM element.
protected void	setStroke(Sprite sprite, XElement element) Applies the stroke attribute of a sprite to its VML dom element.
protected void	setTextAlign(Style style, String align) Sets the text alignment on the given Style.
protected void	setTextAttributes(TextSprite sprite, XElement element) Applies the attributes of the passed TextSprite to its VML element.
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.
protected void	transform(Sprite sprite) Applies transformation to passed sprite

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, getBackgroundSprite, getBBox, getComponent, getContainer, getHeight, getSprites, getSurfaceElement, getWidth, renderAll, setBackground, setBackgroundSprite, setComponent, setContainer, setHeight, setSprites, setSurfaceElement, setWidth

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

zoom

protected int zoom

viewBoxShift

protected Scaling viewBoxShift

newLineRegExp

protected RegExp newLineRegExp

textBBoxCache

protected Map<Sprite,PreciseRectangle> textBBoxCache

textRenderedPoints

protected Map<Sprite,PrecisePoint> textRenderedPoints

textRenderedBaseline

protected Map<Sprite,TextSprite.TextBaseline> textRenderedBaseline

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

create

public static Surface create(DrawComponent component,
                             int width,
                             int height)

Instantiates a surface instance with VML. Deferred binding doesn't have to be used with this.

Parameters:

component - the element that the surface will be attached

width - the width of the surface

height - the height of the surface

Returns:

the instantiated surface

Since:

4.0.3

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

addNamespace

protected void addNamespace(String namespace,
                            String urn)

Adds the passed namespace and URN to the document.

Parameters:

namespace - the namespace to be added

urn - the schema URN of the namespace

applyAttributes

protected void applyAttributes(Sprite sprite)

Applies pending attributes to the DOM element of a Sprite.

Parameters:

sprite - the sprite in need of attributes to be set.

applyClip

protected void applyClip(Sprite sprite)

Applies the clip rectangle of the given sprite to its DOM element.

Parameters:

sprite - the sprite to have its clip rectangle applied

applyZIndex

protected void applyZIndex(Sprite sprite,
                           XElement element)

Applies the z-index of the given sprite to its DOM element.

Parameters:

sprite - the sprite to have its z-index applied

containsNonVMLCommands

protected boolean containsNonVMLCommands(PathSprite sprite)

Determines whether a PathSprite contains a command not supported by VML.

Parameters:

sprite - the sprite to be inspected

Returns:

true if the sprite contains an unsupported command

createNode

protected XElement createNode(String tagName)

Creates a VML DOM node.

Parameters:

tagName - the type of node to create.

Returns:

the created VML DOM node.

createSpriteElement

protected XElement createSpriteElement(Sprite sprite)

Creates the DOM element of the passed Sprite.

Parameters:

sprite - the sprite in need of element creation

ellipticalArc

protected String ellipticalArc(Sprite sprite)

Generates a path sprite made up of an elliptical arc based on the given CircleSprite or EllipseSprite. Returns null if not an Circle

Parameters:

sprite - the circle or ellipse to be converted to an elliptical arc

Returns:

the generated elliptical arc

path2vml

protected String path2vml(PathSprite sprite)

Returns a string representing a VML path using the the passed PathSprite.

Parameters:

sprite - the sprite to be converted

Returns:

the converted path

setFill

protected void setFill(Sprite sprite,
                       Element element)

Applies the fill attribute of a sprite to its VML DOM element.

Parameters:

sprite - the sprite to have its fill set

setStroke

protected void setStroke(Sprite sprite,
                         XElement element)

Applies the stroke attribute of a sprite to its VML dom element.

Parameters:

sprite - the sprite to have its stroke set

setTextAlign

protected void setTextAlign(Style style,
                            String align)

Sets the text alignment on the given Style.

Parameters:

style - the style

align - the text alignment

setTextAttributes

protected void setTextAttributes(TextSprite sprite,
                                 XElement element)

Applies the attributes of the passed TextSprite to its VML element.

Parameters:

sprite - the sprite whose attributes to use

transform

protected void transform(Sprite sprite)

Applies transformation to passed sprite

Parameters:

sprite - the sprite to be transformed