Packagecom.gestureworks.cml.components
Classpublic class Component
InheritanceComponent Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite
Subclasses AlbumViewer, CollectionViewer, FlickrViewer, FlipBookViewer, GigapixelViewer, HTMLViewer, ImageViewer, LiveVideoViewer, MaskImageViewer, MediaViewer, ModestMapViewer, MP3Player, PaintViewer, SlideshowViewer, VideoViewer, WAVPlayer, YouTubeViewer

The Component manages a group of elements to create a high-level interactive touch container.

It is composed of the following:

     
            
     

See also

com.gestureworks.cml.elements.TouchContainer


Public Properties
 PropertyDefined By
  activity : Boolean
Current state of interaction
Component
  autoAlign : String
Set the autoAlign for the auto text layout feature if desired.
Component
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  autoTextLayout : Boolean
Specifies whether text fields will be automatically adjusted to the component's width
Component
  back : *
Sets the back element.
Component
  background : *
Sets the back background element.
Component
  backs : Array
Component
 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
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
  fadeoutDuration : Number
Set the fadeout time for an object that's timed out.
Component
  fontArray : Array
Component
  fontIncrement : Number
font increment
Component
  frame : *
Sets the frame element.
Component
  front : *
Sets the front element.
Component
  fronts : Array
Component
  glowColor : uint = 0xFFFFFF
Component
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
  hideFrontOnFlip : *
Specifies whether the front is hidden when the the back is shown
Component
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  menu : *
Sets the menu element.
Component
 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
  textFields : Array
Component
  timeout : Number
Set the timeout value for when the elements were automatically close.
Component
 InheritedtoBitmap : Boolean
TouchContainer
  visible : Boolean
[override] [write-only] Manages the timer and dispatches a state event
Component
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
  side : String
[read-only] Specifies the currently displayed side
Component
Public Methods
 MethodDefined By
  
component Constructor
Component
 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
  
clone():*
[override] Returns clone of self
Component
  
dispose():void
[override] Destructor
Component
  
fadeIn(dur:Number = 250):void
Component
  
fadeOut(dur:Number = 250):void
Component
 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
  
glowIn(dur:Number = 1):void
Component
  
glowOut(dur:Number = 1):void
Component
  
glowPulse():void
Component
  
init():void
[override] Initialisation method
Component
  
invertMatrix(displayObject:DisplayObject, newParent:DisplayObjectContainer):void
Component
 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
  
noActivity(e:GWGestureEvent):void
Component
  
onDown(event:* = null):void
handles touch event
Component
  
onUp(event:* = null):void
handles event
Component
 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
  
reset():void
Component
  
Component
  
Component
 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
 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
Protected Methods
 MethodDefined By
  
Component
  
onTimer(e:TimerEvent):void
Component
  
updateLayout(event:* = null):void
Component
Property Detail
activityproperty
activity:Boolean

Current state of interaction


Implementation
    public function get activity():Boolean
    public function set activity(value:Boolean):void
autoAlignproperty 
autoAlign:String

Set the autoAlign for the auto text layout feature if desired. Options are "left", "center", "right".

The default value is "center".


Implementation
    public function get autoAlign():String
    public function set autoAlign(value:String):void
autoTextLayoutproperty 
autoTextLayout:Boolean

Specifies whether text fields will be automatically adjusted to the component's width

The default value is false.


Implementation
    public function get autoTextLayout():Boolean
    public function set autoTextLayout(value:Boolean):void
backproperty 
back:*

Sets the back element. This can be set using a simple CSS selector (id or class) or directly to a display object. Regardless of how this set, a corresponding display object is always returned.


Implementation
    public function get back():*
    public function set back(value:any):void
backgroundproperty 
background:*

Sets the back background element. This can be set using a simple CSS selector (id or class) or directly to a display object. Regardless of how this set, a corresponding display object is always returned.


Implementation
    public function get background():*
    public function set background(value:any):void
backsproperty 
public var backs:Array

fadeoutDurationproperty 
fadeoutDuration:Number

Set the fadeout time for an object that's timed out.


Implementation
    public function get fadeoutDuration():Number
    public function set fadeoutDuration(value:Number):void
fontArrayproperty 
public var fontArray:Array

fontIncrementproperty 
fontIncrement:Number

font increment

The default value is 2;.


Implementation
    public function get fontIncrement():Number
    public function set fontIncrement(value:Number):void
frameproperty 
frame:*

Sets the frame element. This can be set using a simple CSS selector (id or class) or directly to a display object. Regardless of how this set, a corresponding display object is always returned.


Implementation
    public function get frame():*
    public function set frame(value:any):void
frontproperty 
front:*

Sets the front element. This can be set using a simple CSS selector (id or class) or directly to a display object. Regardless of how this set, a corresponding display object is always returned.


Implementation
    public function get front():*
    public function set front(value:any):void
frontsproperty 
public var fronts:Array

glowColorproperty 
public var glowColor:uint = 0xFFFFFF

hideFrontOnFlipproperty 
hideFrontOnFlip:*

Specifies whether the front is hidden when the the back is shown

The default value is false.


Implementation
    public function get hideFrontOnFlip():*
    public function set hideFrontOnFlip(value:any):void
menuproperty 
menu:*

Sets the menu element. This can be set using a simple CSS selector (id or class) or directly to a display object. Regardless of how this set, a corresponding display object is always returned.


Implementation
    public function get menu():*
    public function set menu(value:any):void
sideproperty 
side:String  [read-only]

Specifies the currently displayed side

The default value is "front".


Implementation
    protected function get side():String
textFieldsproperty 
public var textFields:Array

timeoutproperty 
timeout:Number

Set the timeout value for when the elements were automatically close.


Implementation
    public function get timeout():Number
    public function set timeout(value:Number):void
visibleproperty 
visible:Boolean  [write-only] [override]

Manages the timer and dispatches a state event


Implementation
    public function set visible(value:Boolean):void
Constructor Detail
Component()Constructor
public function Component()

component Constructor

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

Returns clone of self

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

Destructor

fadeIn()method 
public function fadeIn(dur:Number = 250):void

Parameters

dur:Number (default = 250)

fadeOut()method 
public function fadeOut(dur:Number = 250):void

Parameters

dur:Number (default = 250)

glowIn()method 
public function glowIn(dur:Number = 1):void

Parameters

dur:Number (default = 1)

glowOut()method 
public function glowOut(dur:Number = 1):void

Parameters

dur:Number (default = 1)

glowPulse()method 
public function glowPulse():void

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

Initialisation method

invertMatrix()method 
public function invertMatrix(displayObject:DisplayObject, newParent:DisplayObjectContainer):void

Parameters

displayObject:DisplayObject
 
newParent:DisplayObjectContainer

noActivity()method 
public function noActivity(e:GWGestureEvent):void

Parameters

e:GWGestureEvent

onDown()method 
public function onDown(event:* = null):void

handles touch event

Parameters

event:* (default = null)

onStateEvent()method 
protected function onStateEvent(event:StateEvent):void

Parameters

event:StateEvent

onTimer()method 
protected function onTimer(e:TimerEvent):void

Parameters

e:TimerEvent

onUp()method 
public function onUp(event:* = null):void

handles event

Parameters

event:* (default = null)

reset()method 
public function reset():void

resetMatrix()method 
public function resetMatrix():void

restartTimer()method 
public function restartTimer():void

updateLayout()method 
protected function updateLayout(event:* = null):void

Parameters

event:* (default = null)