Package | com.gestureworks.cml.components |
Class | public class Component |
Inheritance | Component ![]() ![]() |
Subclasses | AlbumViewer, CollectionViewer, FlickrViewer, FlipBookViewer, GigapixelViewer, HTMLViewer, ImageViewer, LiveVideoViewer, MaskImageViewer, MediaViewer, ModestMapViewer, MP3Player, PaintViewer, SlideshowViewer, VideoViewer, WAVPlayer, YouTubeViewer |
It is composed of the following:
See also
Property | Defined By | ||
---|---|---|---|
activity : Boolean
Current state of interaction
| Component | ||
autoAlign : String
Set the autoAlign for the auto text layout feature if desired. | Component | ||
![]() | autoShuffle : 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 | ||
![]() | 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 | |
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dropShadow : 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 | ||
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
sets the height of the container
| TouchContainer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
hideFrontOnFlip : *
Specifies whether the front is hidden when the the back is shown
| Component | ||
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
menu : *
Sets the menu element. | Component | ||
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | 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 | |
textFields : Array | Component | ||
timeout : Number
Set the timeout value for when the elements were automatically close. | Component | ||
![]() | toBitmap : Boolean | TouchContainer | |
visible : Boolean [override] [write-only]
Manages the timer and dispatches a state event
| Component | ||
![]() | width : Number [override]
sets the width of the container
| TouchContainer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
![]() | cmlGestureList : Object | TouchContainer | |
side : String [read-only]
Specifies the currently displayed side
| Component |
Method | Defined By | ||
---|---|---|---|
component Constructor
| Component | ||
![]() | 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 | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | 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 | ||
![]() | 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 | |
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 | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | 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 | ||
![]() | 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 | Component | ||
resetMatrix():void | Component | ||
restartTimer():void | Component | ||
![]() | 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 |
Method | Defined By | ||
---|---|---|---|
onStateEvent(event:StateEvent):void | Component | ||
onTimer(e:TimerEvent):void | Component | ||
updateLayout(event:* = null):void | Component |
activity | property |
activity:Boolean
Current state of interaction
public function get activity():Boolean
public function set activity(value:Boolean):void
autoAlign | property |
autoAlign:String
Set the autoAlign for the auto text layout feature if desired. Options are "left", "center", "right".
The default value is "center"
.
public function get autoAlign():String
public function set autoAlign(value:String):void
autoTextLayout | property |
autoTextLayout:Boolean
Specifies whether text fields will be automatically adjusted to the component's width
The default value is false
.
public function get autoTextLayout():Boolean
public function set autoTextLayout(value:Boolean):void
back | property |
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.
public function get back():*
public function set back(value:any):void
background | property |
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.
public function get background():*
public function set background(value:any):void
backs | property |
public var backs:Array
fadeoutDuration | property |
fadeoutDuration:Number
Set the fadeout time for an object that's timed out.
public function get fadeoutDuration():Number
public function set fadeoutDuration(value:Number):void
fontArray | property |
public var fontArray:Array
fontIncrement | property |
fontIncrement:Number
font increment
The default value is 2;
.
public function get fontIncrement():Number
public function set fontIncrement(value:Number):void
frame | property |
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.
public function get frame():*
public function set frame(value:any):void
front | property |
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.
public function get front():*
public function set front(value:any):void
fronts | property |
public var fronts:Array
glowColor | property |
public var glowColor:uint = 0xFFFFFF
hideFrontOnFlip | property |
hideFrontOnFlip:*
Specifies whether the front is hidden when the the back is shown
The default value is false
.
public function get hideFrontOnFlip():*
public function set hideFrontOnFlip(value:any):void
menu | property |
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.
public function get menu():*
public function set menu(value:any):void
side | property |
side:String
[read-only] Specifies the currently displayed side
The default value is "front"
.
protected function get side():String
textFields | property |
public var textFields:Array
timeout | property |
timeout:Number
Set the timeout value for when the elements were automatically close.
public function get timeout():Number
public function set timeout(value:Number):void
visible | property |
visible:Boolean
[write-only] [override] Manages the timer and dispatches a state event
public function set visible(value:Boolean):void
Component | () | Constructor |
public function Component()
component Constructor
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 |
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 )
|