Packagecom.gestureworks.cml.elements
Classpublic class Paint
InheritancePaint Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

...



Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  backgroundAlpha : Number
Sets background alphas
Paint
  backgroundColor : uint
[write-only] Sets background color
Paint
  brushSize : int
Sets brush size, aka line width
Paint
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
  color : uint
[write-only] Sets paint color
Paint
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  height : Number
[override] Sets gets canvas height
Paint
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
  width : Number
[override] Sets gets canvas width
Paint
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
Paint(w:Number = 1280, h:Number = 720, bg:uint = 0x00efefef, bgAlpha:Number = 1.0)
Constructor
Paint
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
Paint
  
exportPNG(defaultFileName:String = painting.png):void
Exports drawing as PNG
Paint
  
exportSVG(defaultFileName:String = painting.svg):void
Exports drawing as SVG
Paint
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class.
TouchContainer
  
importSVG():void
Imports SVG file.
Paint
  
init():void
[override]
Paint
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
  
resetImage():void
Erases data and clears canvas
Paint
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
  
Turns on or off the eraser tool.
Paint
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Property Detail
backgroundAlphaproperty
backgroundAlpha:Number

Sets background alphas


Implementation
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundColorproperty 
backgroundColor:uint  [write-only]

Sets background color


Implementation
    public function set backgroundColor(value:uint):void
brushSizeproperty 
brushSize:int

Sets brush size, aka line width


Implementation
    public function get brushSize():int
    public function set brushSize(value:int):void
colorproperty 
color:uint  [write-only]

Sets paint color


Implementation
    public function set color(value:uint):void
heightproperty 
height:Number[override]

Sets gets canvas height


Implementation
    public function get height():Number
    public function set height(value:Number):void
widthproperty 
width:Number[override]

Sets gets canvas width


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
Paint()Constructor
public function Paint(w:Number = 1280, h:Number = 720, bg:uint = 0x00efefef, bgAlpha:Number = 1.0)

Constructor

Parameters
w:Number (default = 1280) — - width, 1280 by default
 
h:Number (default = 720) — - height, 720 by default
 
bg:uint (default = 0x00efefef) — - background color, an off white by default
 
bgAlpha:Number (default = 1.0) — - alpha for background, relevant in png or svg exporting.
Method Detail
dispose()method
override public function dispose():void

Destructor

exportPNG()method 
public function exportPNG(defaultFileName:String = painting.png):void

Exports drawing as PNG

Parameters

defaultFileName:String (default = painting.png)

exportSVG()method 
public function exportSVG(defaultFileName:String = painting.svg):void

Exports drawing as SVG

Parameters

defaultFileName:String (default = painting.svg)

importSVG()method 
public function importSVG():void

Imports SVG file.

init()method 
override public function init():void

resetImage()method 
public function resetImage():void

Erases data and clears canvas

toggleEraser()method 
public function toggleEraser():void

Turns on or off the eraser tool.