API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class SVGMask

Package | com.zavoo.svg.nodes.mask
Class | public class SVGMask
Inheritance | SVGMask SVGNode flash.display.Sprite

Class used internally to create a node mask. It is not the same as an SVG mask node

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | svgRoot : SVGRoot Recursively searches for the root node | SVGNode
|  | xml : XML SVG XML | SVGNode

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined by
--- | --- | ---
|  | _firstRendering : Boolean = true | SVGNode
|  | _graphicsCommands : Array List of graphics commands to draw node. | SVGNode
|  | _invalidDisplay : Boolean = false If true, redraw sprite graphics Set to true on any change to xml | SVGNode
|  | _style : Object Used for caching node attribute style values. | SVGNode
|  | _xml : XML SVG XML for this node | SVGNode

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | SVGMask(clipPathNode:SVGClipPathNode) | SVGMask
|  | addChild(child:DisplayObject):DisplayObject Track nodes as they are added so we know when to send the RENDER_DONE event | SVGNode
|  | getAttribute(attribute:*, defaultValue:* = null):* | SVGNode
|  | getHeight():Number Get height calculated from _minY and _maxY | SVGNode
|  | getStyle(name:String):String Override default fill and stroke styles | SVGMask
|  | getWidth():Number Get width calculated from _minX and _maxX | SVGNode
|  | invalidateDisplay():void Force a redraw of a node and its children | SVGNode
|  | setStyle(name:String, value:String):void Set node style to new value Updates SVG XML and then calls refreshGraphis() | SVGNode

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined by
--- | --- | ---
|  | checkX(value:Number):void Check value of x against _minX and _maxX, Update values when appropriate | SVGNode
|  | checkY(value:Number):void Check value of y against _minY and _maxY, Update values when appropriate | SVGNode
|  | clearChildren():void Remove all child nodes | SVGNode
|  | draw():void | SVGMask
|  | generateGraphicsCommands():void Called to generate AS3 graphics commands from the SVG instructions | SVGNode
|  | loadAttribute(name:String, field:String = null):void Load an XML attribute into the current node | SVGNode
|  | loadStyle(name:String, field:String = null):void Load an SVG style into the current node | SVGNode
|  | nodeBeginFill():void | SVGMask
|  | nodeEndFill():void Called at the end of drawing an SVG element | SVGNode
|  | onMouseClick(event:MouseEvent):void | SVGNode
|  | onMouseDown(event:MouseEvent):void | SVGNode
|  | onMouseMove(event:MouseEvent):void | SVGNode
|  | onMouseOut(event:MouseEvent):void | SVGNode
|  | onMouseOver(event:MouseEvent):void | SVGNode
|  | onMouseUp(event:MouseEvent):void | SVGNode
|  | onNodeAdded(event:Event):void SVGMask is a copy, do not register | SVGMask
|  | onNodeRemoved(event:Event):void | SVGNode
|  | parse():void Parse the SVG XML. | SVGNode
|  | redrawNode(event:Event):void Triggers on ENTER_FRAME event Redraws node graphics if _invalidDisplay == true | SVGNode
|  | runGraphicsCommands():void Execute graphics commands contained in var _graphicsCommands | SVGNode
|  | setAttributes():void Load attributes/styling from the XML. | SVGNode
|  | setupEvents():void | SVGNode
|  | setupFilters():void Add any assigned filters to node | SVGNode
|  | transformNode():void Perform transformations defined by the transform attribute | SVGNode

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined by
--- | --- | ---
|  | attributeList : Array [static] | SVGNode

Constructor detail

SVGMask | () | constructor

`public function SVGMask(clipPathNode:SVGClipPathNode)`Parameters

| `clipPathNode:SVGClipPathNode`

Method detail

draw | () | method

`protected override function draw():void`

getStyle | () | method |

`public override function getStyle(name:String):String`

Override default fill and stroke styles

Parameters

| `name:String`

Returns

| `String`

nodeBeginFill | () | method |

`protected override function nodeBeginFill():void`

onNodeAdded | () | method |

`protected override function onNodeAdded(event:Event):void`

SVGMask is a copy, do not register

Parameters

| `event:Event`