Package | com.gestureworks.cml.elements |
Class | public class MaskContainer |
Inheritance | MaskContainer ![]() ![]() |
var maskContainer:MaskContainer = new MaskContainer(); maskContainer.maskShape = "rectangle"; maskContainer.maskWidth = 100; maskContainer.maskHeight = 64; maskContainer.maskBorderColor = 0xff0000; maskContainer.maskBorderStroke = 2; maskContainer.maskBorderAlpha = 0.75; maskContainer.addChild(img); maskContainer.childToList("image", img); maskContainer.init();
See also
Property | Defined By | ||
---|---|---|---|
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
counter : Number [read-only] | MaskContainer | ||
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
dragAngle : Number | MaskContainer | ||
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
sets the height of the container
| TouchContainer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
maskBorderAlpha : Number
Alpha for the border of the mask if desired. | MaskContainer | ||
maskBorderColor : uint
Mask border color, if a border is desired around the mask element. | MaskContainer | ||
maskBorderStroke : Number
The thickness of the border in pixels. | MaskContainer | ||
maskHeight : Number
Mask height for rectangles. | MaskContainer | ||
maskRadius : Number
The property for the mask radius if the shape is a circle. | MaskContainer | ||
maskRotation : Number
Set the starting rotation of the mask. | MaskContainer | ||
maskShape : String
The string property to designate the shape the mask will be. | MaskContainer | ||
maskWidth : Number
Mask width for rectangles. | MaskContainer | ||
maskX : Number
Set the mask's starting X position. | MaskContainer | ||
maskY : Number
Set the mask's starting Y position. | MaskContainer | ||
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
mShape : Graphic [read-only] | MaskContainer | ||
![]() | paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | TouchContainer | |
![]() | paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | TouchContainer | |
![]() | paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | TouchContainer | |
![]() | paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | TouchContainer | |
![]() | position : *
Sets the position
| TouchContainer | |
![]() | relativeX : Boolean
When set true this containers children's x position will be laid out relatively
to each other. | TouchContainer | |
![]() | relativeY : Boolean
When set true this containers children's y position will be laid out relatively
to each other. | TouchContainer | |
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | toBitmap : Boolean | TouchContainer | |
touchScreen : TouchContainer [read-only] | MaskContainer | ||
![]() | width : Number [override]
sets the width of the container
| TouchContainer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
borderShape : Graphic | MaskContainer | ||
![]() | cmlGestureList : Object | TouchContainer | |
graphicArray : List | MaskContainer | ||
hitShape : Graphic | MaskContainer | ||
_mShape : Graphic | MaskContainer | ||
overallMask : Graphic | MaskContainer | ||
_touchScreen : TouchContainer | MaskContainer | ||
wShape : Graphic | MaskContainer |
Method | Defined By | ||
---|---|---|---|
Constructor
| MaskContainer | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
alphaHandler(e:GWGestureEvent):void | MaskContainer | ||
alphaShift(n:Number):void | MaskContainer | ||
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
![]() | clone():*
Clone method
| TouchContainer | |
cycleMasks(e:GWGestureEvent = null):void
cycles through multiple images
| MaskContainer | ||
dispose():void [override]
Destructor
| MaskContainer | ||
![]() | getElementById(id:String):*
Searches CML childList by id. | TouchContainer | |
![]() | getElementsByClassName(className:String):Array
Searches the CML childList by className. | TouchContainer | |
![]() | getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class. | TouchContainer | |
init():void [override]
Initialisation method
| MaskContainer | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | parseCML(cml:XMLList):XMLList
Parse cml for local layouts. | TouchContainer | |
![]() | postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine. | TouchContainer | |
![]() | querySelector(selector:String):*
Searches the CML childList by selector. | TouchContainer | |
![]() | querySelectorAll(selector:*):Array
Search the CML childList by selector. | TouchContainer | |
![]() | removeChild(child:DisplayObject):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildAt(index:int):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void [override]
Removes children from display list and, if not already removed, the child list
| TouchContainer | |
reset():void | MaskContainer | ||
![]() | saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number. | TouchContainer | |
![]() | searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
![]() | updatePadding():void
Updates child padding within this container
| TouchContainer | |
![]() | updatePercentDim():void
Updates child percent dimensions within this container
| TouchContainer | |
![]() | updateProperties(state:* = 0):void
Updates properties from state. | TouchContainer | |
![]() | updateRelativePos():void
Updates child relative positions within this container
| TouchContainer |
_mShape | property |
protected var _mShape:Graphic
_touchScreen | property |
protected var _touchScreen:TouchContainer
borderShape | property |
protected var borderShape:Graphic
counter | property |
counter:Number
[read-only] public function get counter():Number
dragAngle | property |
dragAngle:Number
public function get dragAngle():Number
public function set dragAngle(value:Number):void
graphicArray | property |
protected var graphicArray:List
hitShape | property |
protected var hitShape:Graphic
maskBorderAlpha | property |
maskBorderAlpha:Number
Alpha for the border of the mask if desired. Must be set between 0 and 1 to be visible.
The default value is 0;
.
public function get maskBorderAlpha():Number
public function set maskBorderAlpha(value:Number):void
maskBorderColor | property |
maskBorderColor:uint
Mask border color, if a border is desired around the mask element.
The default value is 0x000000;
.
public function get maskBorderColor():uint
public function set maskBorderColor(value:uint):void
maskBorderStroke | property |
maskBorderStroke:Number
The thickness of the border in pixels.
The default value is 0;
.
public function get maskBorderStroke():Number
public function set maskBorderStroke(value:Number):void
maskHeight | property |
maskHeight:Number
Mask height for rectangles.
public function get maskHeight():Number
public function set maskHeight(value:Number):void
maskRadius | property |
maskRadius:Number
The property for the mask radius if the shape is a circle.
public function get maskRadius():Number
public function set maskRadius(value:Number):void
maskRotation | property |
maskRotation:Number
Set the starting rotation of the mask.
public function get maskRotation():Number
public function set maskRotation(value:Number):void
maskShape | property |
maskShape:String
The string property to designate the shape the mask will be. "rectangle" or "circle" are options.
public function get maskShape():String
public function set maskShape(value:String):void
maskWidth | property |
maskWidth:Number
Mask width for rectangles.
public function get maskWidth():Number
public function set maskWidth(value:Number):void
maskX | property |
maskX:Number
Set the mask's starting X position.
public function get maskX():Number
public function set maskX(value:Number):void
maskY | property |
maskY:Number
Set the mask's starting Y position.
public function get maskY():Number
public function set maskY(value:Number):void
mShape | property |
overallMask | property |
protected var overallMask:Graphic
touchScreen | property |
touchScreen:TouchContainer
[read-only] public function get touchScreen():TouchContainer
wShape | property |
protected var wShape:Graphic
MaskContainer | () | Constructor |
public function MaskContainer()
Constructor
alphaHandler | () | method |
public function alphaHandler(e:GWGestureEvent):void
Parameters
e:GWGestureEvent |
alphaShift | () | method |
public function alphaShift(n:Number):void
Parameters
n:Number |
cycleMasks | () | method |
public function cycleMasks(e:GWGestureEvent = null):void
cycles through multiple images
Parameters
e:GWGestureEvent (default = null )
|
dispose | () | method |
override public function dispose():void
Destructor
init | () | method |
override public function init():void
Initialisation method
reset | () | method |
public function reset():void