| Package | com.gestureworks.cml.components |
| Class | public class Component |
| Inheritance | Component  TouchContainer TouchContainerFactory TouchSprite flash.display.Sprite |
| Subclasses | AlbumViewer, CollectionViewer, FlickrViewer, GigapixelViewer, ImageViewer, LiveVideoViewer, MaskImageViewer, MediaViewer, ModestMapViewer, MP3Player, PanoramicViewer, SlideshowViewer, VideoViewer, WAVPlayer, YouTubeViewer |
It is composed of the following:
See also
| Property | Defined By | ||
|---|---|---|---|
 | _$height : Number = 0 | TouchSprite | |
| _$rotation : Number = 0 | TouchSprite | |
| $rotation : Number | TouchSprite | |
| _$scaleX : Number = 1 | TouchSprite | |
| $scaleX : Number | TouchSprite | |
| _$scaleY : Number = 1 | TouchSprite | |
| $scaleY : Number | TouchSprite | |
| $transformPoint : Point | TouchSprite | |
| _$width : Number = 0 | TouchSprite | |
| _$x : Number = 0 | TouchSprite | |
| $x : Number | TouchSprite | |
| _$y : Number = 0 | TouchSprite | |
| $y : Number | TouchSprite | |
| activity : Boolean [read-only] | Component | ||
| autoAlign : String
Set the autoAlign for the auto text layout feature if desired. | Component | ||
| autoShuffle : Boolean
autoshuffles
| TouchContainerFactory | |
| 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 | ||
| broadcastTarget : Boolean | TouchSprite | |
| childList : ChildList [read-only]
returns the childlist
| TouchContainerFactory | |
| class_ : String
Object's css class;
| TouchContainerFactory | |
| className : String
sets the class name of displayobject
| TouchContainerFactory | |
| cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
| clusterBubbling : Boolean
Allows touch points from a childclusters to copy into container touch objects
in the local parent child display list stack. | TouchSprite | |
| clusterEvents : Boolean
Determins whether clusterEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| clusterID : int | TouchSprite | |
| cmlIndex : int
sets the cml index
| TouchContainerFactory | |
| cml_item : Boolean | TouchSprite | |
| cO : ClusterObject | TouchSprite | |
| debugDisplay : Boolean | TouchSprite | |
| deltaFilterOn : Boolean
Determins whether filtering is applied to the delta values. | TouchSprite | |
| dimensionsTo : String
sets the dimensions of touchcontainer
| TouchContainerFactory | |
| disableAffineTransform : Boolean
Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite. | TouchSprite | |
| disableNativeTransform : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| dN : Number | TouchSprite | |
| dropShadow : Boolean
Sets the drop shadow effect
| TouchContainerFactory | |
| 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 | ||
| GESTRELIST_UPDATE : String = gestureList update [static] | TouchSprite | |
| gestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite. | TouchSprite | |
| gestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite. | TouchSprite | |
| gestureEvents : Boolean
Determins whether gestureEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| gestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite. | TouchSprite | |
| gestureFilters : Boolean | TouchSprite | |
| gestureList : Object | TouchSprite | |
| gestureReleaseInertia : Boolean
Determins whether release inertia is given to gestureEvents on the touchSprite. | TouchSprite | |
| gestureTouchInertia : Boolean
Determins whether touch inertia is processed on the touchSprite. | TouchSprite | |
| _gestureTweenOn : Boolean = false | TouchSprite | |
| gestureTweenOn : Boolean | TouchSprite | |
| glowColor : uint = 0xFFFFFF | Component | ||
| gO : GestureListObject | TouchSprite | |
| group : String | TouchContainerFactory | |
| height : Number [override]
sets the height of the container
| TouchContainerFactory | |
| hideFrontOnFlip : *
Specifies whether the front is hidden when the the back is shown
| Component | ||
| id : String
sets childlist id
| TouchContainerFactory | |
| layout : *
speciffies the type of layout
| TouchContainerFactory | |
| layoutComplete : Function
Sets the function to call when the layout is complete
| TouchContainer | |
| layoutList : Dictionary | TouchContainer | |
| layoutUpdate : Function
Sets the function to call when the layout updates
| TouchContainer | |
| maxScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| menu : *
Sets the menu element. | Component | ||
| minScale : Number
This method is called after class initialization. | TouchContainerFactory | |
| mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainerFactory | |
| N : int | TouchSprite | |
| nestedTransform : Boolean | TouchSprite | |
| outline_alpha : Number
sets the alpha of outline
| TouchContainerFactory | |
| outline_color : Number
sets the color of outline
| TouchContainerFactory | |
| outline_joint : String
TODO
| TouchContainerFactory | |
| outlineOn : String
specifies the outline of container to true or false
| TouchContainerFactory | |
| outline_stroke : int
sets the line stroke of outline
| TouchContainerFactory | |
| pointArray : Vector.<PointObject> [read-only] | TouchSprite | |
| pointCount : int | TouchSprite | |
| propertyStates : Array Deprecated: Please Use state | TouchContainerFactory | |
| scale : Number
Scales display object
| TouchContainer | |
| sO : StrokeObject | TouchSprite | |
| state : Array
property states array
| TouchContainerFactory | |
| targeting : Boolean
Turns off manual ALL targeting control, defaults to a simple hit test
targeting model with exclusive target clustering
| TouchSprite | |
| targetList : Array
Allows touch and gesture events to explicitly target a group of defined
touch objects which can be outside of the local parent child display list stack
| TouchSprite | |
| targetObject : Object
Allows touch and gesture events to explicitly target a touch object
this can be outside the local parent child display list stack
| TouchSprite | |
| targetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
| TouchSprite | |
| tc : TouchCluster | TouchSprite | |
| td : TouchDebugDisplay | TouchSprite | |
| textFields : Array | Component | ||
| tg : TouchGesture | TouchSprite | |
| timeout : Number
Set the timeout value for when the elements were automatically close. | Component | ||
| tiO : TimelineObject | TouchSprite | |
| touchChildren : Boolean | TouchSprite | |
| touchObjectID : int [read-only] | TouchSprite | |
| tp : TouchPipeline | TouchSprite | |
| traceDebugModeOn : Boolean | TouchSprite | |
| transformComplete : Boolean | TouchSprite | |
| transformEventComplete : Boolean | TouchSprite | |
| transformEvents : Boolean
Determins whether transformEvents are processed and dispatched on the touchSprite. | TouchSprite | |
| transformEventStart : Boolean | TouchSprite | |
| transformGestureVectors : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite. | TouchSprite | |
| transformStart : Boolean | TouchSprite | |
| trO : TransformObject | TouchSprite | |
| tt : TouchTransform | TouchSprite | |
| visible : Boolean [override] [write-only]
Manages the timer and dispatches a state event
| Component | ||
| width : Number [override]
sets the width of the container
| TouchContainerFactory | |
| x_lock : Boolean | TouchSprite | |
| y_lock : Boolean | TouchSprite | |
| Property | Defined By | ||
|---|---|---|---|
| cmlGestureList : Object | TouchContainerFactory | |
| side : String [read-only]
Specifies the currently displayed side
| Component | ||
| Method | Defined By | ||
|---|---|---|---|
component Constructor
| Component | ||
| activateTouch():void
TODO
| TouchContainerFactory | |
| addAllChildren():void
method searches the child and adds to the list
| TouchContainerFactory | |
| addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
Registers event listeners. | TouchSprite | |
| applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
| childToList(id:String, child:*):void
child appended to the childlist
| TouchContainerFactory | |
clone():* [override]
Returns clone of self
| Component | ||
displayComplete():void [override]
CML Initialisation callback
| Component | ||
dispose():void [override] | Component | ||
fadeIn(dur:Number = 250):void | Component | ||
fadeOut(dur:Number = 250):void | Component | ||
glowIn(dur:Number = 1):void | Component | ||
glowOut(dur:Number = 1):void | Component | ||
glowPulse():void | Component | ||
| hideIndex(index:int):void
hides child list index
| TouchContainer | |
| hideKey(key:String):void
hides childlist key visibility
| TouchContainer | |
init():void [override]
Initialisation method
| Component | ||
invertMatrix(displayObject:DisplayObject, newParent:DisplayObjectContainer):void | Component | ||
| makeGestureList(value:XMLList):Object
TODO
| TouchContainerFactory | |
noActivity(e:GWGestureEvent):void | Component | ||
onDown(event:* = null):void
handles touch event
| Component | ||
| onTouchDown(event:TouchEvent, target:* = null):void
decides how to assign the captured touch point to a cluster
can pass to parent, an explicit target, an explicit list or
targets or a passed to any touch object in the local display stack. | TouchSprite | |
onUp(event:* = null):void
handles event
| Component | ||
| parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | TouchContainer | |
| postparseCML(cml:XMLList):void
postparse method
| TouchContainerFactory | |
reset():void | Component | ||
resetMatrix():void | Component | ||
restartTimer():void | Component | ||
| searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
| setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainerFactory | |
| showIndex(index:int):void
shows index of the child list
| TouchContainer | |
| showKey(key:String):void
shows the child list key visibility
| TouchContainer | |
| updateClusterAnalysis():void | TouchSprite | |
| updateDebugDisplay():void | TouchSprite | |
| updateGesturePipeline():void | TouchSprite | |
| updateListeners():void
Registers/unregisters event handlers depending on the active modes
| TouchSprite | |
| updateMotionClusterAnalysis():void | TouchSprite | |
| updateProperties(state:Number = 0):void
update properties of child
| TouchContainerFactory | |
| updateSensorClusterAnalysis():void | TouchSprite | |
| updateTObjProcessing():void | TouchSprite | |
| Method | Defined By | ||
|---|---|---|---|
| childrenHaveUpdated():void
This method is called after class initialization. | TouchContainerFactory | |
| displayHandler(event:DisplayEvent):void
This method is called after class initialization. | TouchContainerFactory | |
onStateEvent(event:StateEvent):void | Component | ||
onTimer(e:TimerEvent):void | Component | ||
| randomMinMax(min:Number, max:Number):Number
This method is called after class initialization. | TouchContainerFactory | |
| scaleTransformHandler(event:GWTransformEvent):void
This method is called after class initialization. | TouchContainerFactory | |
| thumbUpdate(event:Event):void
This method is called after class initialization. | TouchContainerFactory | |
updateLayout(event:* = null):void | Component | ||
| activity | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesactivity:Boolean [read-only] public function get activity():Boolean| autoAlign | property |
autoAlign:StringSet 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:BooleanSpecifies whether text fields will be automatically adjusted to the component's width
The default value is true.
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:NumberSet 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:Numberfont 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:NumberSet 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* |
| displayComplete | () | method |
override public function displayComplete():voidCML Initialisation callback
| dispose | () | method |
override public function dispose():void| fadeIn | () | method |
public function fadeIn(dur:Number = 250):voidParameters
dur:Number (default = 250) |
| fadeOut | () | method |
public function fadeOut(dur:Number = 250):voidParameters
dur:Number (default = 250) |
| glowIn | () | method |
public function glowIn(dur:Number = 1):voidParameters
dur:Number (default = 1) |
| glowOut | () | method |
public function glowOut(dur:Number = 1):voidParameters
dur:Number (default = 1) |
| glowPulse | () | method |
public function glowPulse():void| init | () | method |
override public function init():voidInitialisation method
| invertMatrix | () | method |
public function invertMatrix(displayObject:DisplayObject, newParent:DisplayObjectContainer):voidParameters
displayObject:DisplayObject | |
newParent:DisplayObjectContainer |
| noActivity | () | method |
| onDown | () | method |
public function onDown(event:* = null):voidhandles touch event
Parameters
event:* (default = null) |
| onStateEvent | () | method |
| onTimer | () | method |
protected function onTimer(e:TimerEvent):voidParameters
e:TimerEvent |
| onUp | () | method |
public function onUp(event:* = null):voidhandles 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):voidParameters
event:* (default = null) |