Packagecom.gestureworks.cml.elements
Classpublic class Frame
InheritanceFrame Inheritance Graphic Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The Frame element create display object frames. It is designed to be used as an element of components.
     
        var frame:Frame = new Frame();
        frame.width = 300;
        frame.height = 300;
        frame.x = 700;
        frame.y = 200;
        frame.frameAlpha = .7;
        frame.frameColor = 0xAAAABB;
        frame.frameThickness = 20;
        frame.init();
        addChild(frame);
        
     



Public Properties
 PropertyDefined By
 InheritedanchorX : Number
Sets the anchor X of curve.
Graphic
 InheritedanchorY : Number
Sets the anchor Y of curve.
Graphic
 InheritedangleLength : Number
Set the angle length of the circle segment in degrees.
Graphic
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedbottomLeftRadius : Number
sets the bottom left radius of the graphic object
Graphic
 InheritedbottomRightRadius : Number
sets the bottom right radius of the graphic object
Graphic
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 Inheritedclockwise : Boolean
Set if the circle segment should go clockwise/ Shape must be circleSegment.
Graphic
 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
 Inheritedcolor : uint
Sets fill color when fill type is color
Graphic
 InheritedcontrolX : Number
Sets the control X of curve.
Graphic
 InheritedcontrolY : Number
Sets the control y value of curve.
Graphic
 InheritedcornerHeight : Number
Sets the height of the ellipse that is used to round the rectangle.
Graphic
 InheritedcornerWidth : Number
Sets the width of the ellipse that is used to round the rectangle.
Graphic
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedfill : String
Sets fill type, choose: color, gradient todo: implement shader and bitmap fills
Graphic
 InheritedfillAlpha : Number
Sets fill alpha when fill type is color
Graphic
  frameAlpha : Number
Sets frame thickness
Frame
  frameColor : Number
Sets frame thickness
Frame
  frameShape : String
Sets frame shape
Frame
  frameThickness : Number
Sets frame thickness
Frame
 InheritedgradientAlphas : String
Sets gradient alphas when fill type is gradient Alpha values corespond to the colors in the gradientColors array Ordered list, max 12 (ex: 1, 1, 1)
Graphic
 InheritedgradientColors : String
Sets gradient colors when fill type is gradient Ordered list, max 12 (ex: 0x000000, 0x555555, 0xFFFFFF)
Graphic
 InheritedgradientFocalPointRatio : Number
A number that controls the location of the focal point of the gradient.
Graphic
 InheritedgradientHeight : Number
The height (in pixels) to which the gradient will spread.
Graphic
 InheritedgradientInterpolation : String
Specifies which interpolation value to use: RGB or linearRGB
Graphic
 InheritedgradientRatios : String
Color distribution ratios; valid values are 0-255.
Graphic
 InheritedgradientRotation : Number
Sets the rotation (in degrees) that will be applied to the gradient.
Graphic
 InheritedgradientSpread : String
Specifies which gradient spread method to use.
Graphic
 InheritedgradientType : String
Sets gradient type when fill type is gradient.
Graphic
 InheritedgradientWidth : Number
Sets the width (in pixels) to which the gradient will spread.
Graphic
 InheritedgradientX : Number
Sets how far (in pixels) the gradient is shifted horizontally.
Graphic
 InheritedgradientY : Number
Sets how far (in pixels) the gradient is shifted vertically.
Graphic
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] Sets graphics height.
Graphic
 InheritedheightPercent : Number
[override] Sets the height relative to the parent container.
Graphic
 Inheritedid : String
Returns the object's id.
TouchContainer
 InheritedinnerRadius : Number
Set the inner radius of the circle segment in pixels.
Graphic
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 Inheritedline : String
Sets line type, choose: color, gradient todo: implement shader and bitmap lines
Graphic
 InheritedlineAlpha : Number
Sets the alpha of the line
Graphic
 InheritedlineCaps : String
Specifies the type of cap on the line ends Choose: none, round, or square
Graphic
 InheritedlineColor : uint
Sets the color of the line Line type must be color
Graphic
 InheritedlineGradientAlphas : String
Sets lineGradient alphas when line type is gradient Alpha values corespond to the colors in the gradient color list Ordered list, max 12 (ex: 1, 1, 1)
Graphic
 InheritedlineGradientColors : String
Sets lineGradient colors when line type is gradient Ordered list, max 12 (ex: 0x000000, 0x555555, 0xFFFFFF)
Graphic
 InheritedlineGradientFocalPointRatio : Number
A number that controls the location of the focal point of the lineGradient.
Graphic
 InheritedlineGradientHeight : Number
The height (in pixels) to which the gradient will spread.
Graphic
 InheritedlineGradientInterpolation : String
Specifies which interpolation value to use: RGB or linearRGB
Graphic
 InheritedlineGradientRatios : String
Color distribution ratios; valid values are 0-255.
Graphic
 InheritedlineGradientRotation : Number
Sets the rotation (in degrees) that will be applied to the gradient.
Graphic
 InheritedlineGradientSpread : String
Specifies which gradient spread method to use.
Graphic
 InheritedlineGradientType : String
Sets lineGradient type when line type is gradient.
Graphic
 InheritedlineGradientWidth : Number
Sets the width (in pixels) to which the gradient will spread.
Graphic
 InheritedlineGradientX : Number
Sets how far (in pixels) the gradient is shifted horizontally.
Graphic
 InheritedlineGradientY : Number
Sets how far (in pixels) the gradient is shifted vertically.
Graphic
 InheritedlineJoints : String
Specifies the type of joint on the line ends Choose: miter, round, or bevel
Graphic
 InheritedlineMiterLimit : Number
Specifies the limit at which the miter is cut off
Graphic
 InheritedlinePixelHinting : Boolean
Specifies whether to hint strokes to full pixels.
Graphic
 InheritedlineScaleMode : String
Specifies how the line stroke size changes when graphic is scaled Choose: normal, none, or vertical normal - Always scale the line thickness when the object is scaled (the default).
Graphic
 InheritedlineStroke : Number
Sets the width of the line stroke (in pixels)
Graphic
 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
 InheritedpathCommands : String
Sets the path moveTo and lineTo values
Graphic
 InheritedpathCommandsVector : Vector.<int>
Graphic
 InheritedpathCoordinates : String
Sets the path coordinates
Graphic
 InheritedpathCoordinatesVector : Vector.<Number>
Graphic
 Inheritedposition : *
Sets the position
TouchContainer
 Inheritedradius : Number
Sets radius (in pixels) of circle.
Graphic
 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
 Inheritedshape : String
Sets predefined shape type.
Graphic
 Inheritedsound : String
TouchContainer
 InheritedstartAngle : Number
Set the start angle of the circle segment in degrees, clockwise from X axis.
Graphic
 InheritedstartX : Number
Sets starting X position for curve
Graphic
 InheritedstartY : Number
Sets starting Y position for curve
Graphic
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
 InheritedtopLeftRadius : Number
sets the top left radius of the graphic object
Graphic
 InheritedtopRightRadius : Number
sets the top right radius of the grpahic object
Graphic
 Inheritedwidth : Number
[override] Sets graphics width.
Graphic
 InheritedwidthPercent : Number
[override] Sets the width relative to the parent container.
Graphic
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
 InheritedgradientAlphaArray : Array
Graphic
 InheritedgradientColorArray : Array
Graphic
 Inherited_gradientInterpolation : String = rgb
Graphic
 InheritedgradientRatioArray : Array
Graphic
 Inherited_gradientRotation : Number = 0
Graphic
 Inherited_gradientSpread : String = pad
Graphic
 Inherited_gradientType : String = linear
Graphic
 Inherited_height : Number = 0
Graphic
 Inherited_lineCaps : String = none
Graphic
 InheritedlineGradientAlphaArray : Array
Graphic
 InheritedlineGradientColorArray : Array
Graphic
 Inherited_lineGradientInterpolation : String = rgb
Graphic
 InheritedlineGradientRatioArray : Array
Graphic
 Inherited_lineGradientRotation : Number = 0
Graphic
 Inherited_lineGradientSpread : String = pad
Graphic
 Inherited_lineGradientType : String = linear
Graphic
 Inherited_lineJoints : String = miter
Graphic
 Inherited_lineMiterLimit : Number = 3
Graphic
 Inherited_lineScaleMode : String = normal
Graphic
 Inheritedmatrix : Matrix
Graphic
 Inherited_width : Number = 0
Graphic
Public Methods
 MethodDefined By
  
Constructor
Frame
 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
clear():void
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
Graphic
  
clone():*
[override] Returns a clone of self
Frame
 Inherited
copyFrom(source:Graphic):void
Copies all of drawing commands from the source Graphics object into the calling Graphics object.
Graphic
  
dispose():void
[override] Destructor
Frame
 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
  
init():void
[override] Initialization method
Frame
 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
 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
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
  
[override] Update frame graphics
Frame
 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
frameAlphaproperty
frameAlpha:Number

Sets frame thickness

The default value is 100.


Implementation
    public function get frameAlpha():Number
    public function set frameAlpha(value:Number):void
frameColorproperty 
frameColor:Number

Sets frame thickness

The default value is 100.


Implementation
    public function get frameColor():Number
    public function set frameColor(value:Number):void
frameShapeproperty 
frameShape:String

Sets frame shape

The default value is "rectangle".


Implementation
    public function get frameShape():String
    public function set frameShape(value:String):void
frameThicknessproperty 
frameThickness:Number

Sets frame thickness

The default value is 100.


Implementation
    public function get frameThickness():Number
    public function set frameThickness(value:Number):void
Constructor Detail
Frame()Constructor
public function Frame()

Constructor

Method Detail
clone()method
override public function clone():*

Returns a clone of self

Returns
*
dispose()method 
override public function dispose():void

Destructor

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

Initialization method

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

Update frame graphics