Packagecom.gestureworks.cml.element
Classpublic class MenuAlbum
InheritanceMenuAlbum Inheritance Album Inheritance TouchContainer Inheritance TouchContainerFactory Inheritance TouchSprite Inheritance flash.display.Sprite

...



Public Properties
 PropertyDefined By
 Inherited_$height : Number = 0
TouchSprite
 Inherited_$rotation : Number = 0
TouchSprite
 Inherited$rotation : Number
TouchSprite
 Inherited_$scaleX : Number = 1
TouchSprite
 Inherited$scaleX : Number
TouchSprite
 Inherited_$scaleY : Number = 1
TouchSprite
 Inherited$scaleY : Number
TouchSprite
 Inherited$transformPoint : Point
TouchSprite
 Inherited_$width : Number = 0
TouchSprite
 Inherited_$x : Number = 0
TouchSprite
 Inherited$x : Number
TouchSprite
 Inherited_$y : Number = 0
TouchSprite
 Inherited$y : Number
TouchSprite
 InheritedapplyMask : Boolean
Flag indicating whether the contents are masked
Album
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainerFactory
 InheritedbackgroundColor : uint
The color of the album's background
Album
 Inheritedbelt : TouchContainer
[read-only] The primary container and interactive object
Album
 InheritedbroadcastTarget : Boolean
TouchSprite
 InheritedcenterContent : Boolean
Flag indicating the album items should be centered horizontally and vertically
Album
 InheritedchildList : ChildList
[read-only] returns the childlist
TouchContainerFactory
 Inheritedclass_ : String
Object's css class;
TouchContainerFactory
 InheritedclassName : String
sets the class name of displayobject
TouchContainerFactory
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
  clusterBubbling : Boolean
[override] Prevent disabling of clusterBubbling
MenuAlbum
 InheritedclusterEvents : Boolean
Determins whether clusterEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedclusterID : int
TouchSprite
 InheritedcmlIndex : int
sets the cml index
TouchContainerFactory
 Inheritedcml_item : Boolean
TouchSprite
 InheritedcO : ClusterObject
TouchSprite
 InheritedcurrentSnapPoint : Number
[read-only] Returns the index of the current snap point
Album
 InheriteddebugDisplay : Boolean
TouchSprite
 InheriteddeltaFilterOn : Boolean
Determins whether filtering is applied to the delta values.
TouchSprite
 InheriteddimensionsTo : String
sets the dimensions of touchcontainer
TouchContainerFactory
 InheriteddisableAffineTransform : Boolean
Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite.
TouchSprite
 InheriteddisableNativeTransform : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite.
TouchSprite
 InheriteddN : Number
TouchSprite
 InheriteddragAngle : Number
Intended to account for the rotation of the parent object to apply to drag transformations.
Album
 InheriteddragGesture : String
Specifies the GML drag gesture of the belt (e.g.
Album
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainerFactory
 InheritedGESTRELIST_UPDATE : String = gestureList update
[static]
TouchSprite
 InheritedgestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite.
TouchSprite
 InheritedgestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite.
TouchSprite
 InheritedgestureEvents : Boolean
Determins whether gestureEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedgestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite.
TouchSprite
 InheritedgestureFilters : Boolean
TouchSprite
 InheritedgestureList : Object
TouchSprite
 InheritedgestureReleaseInertia : Boolean
Determins whether release inertia is given to gestureEvents on the touchSprite.
TouchSprite
 InheritedgestureTouchInertia : Boolean
Determins whether touch inertia is processed on the touchSprite.
TouchSprite
 Inherited_gestureTweenOn : Boolean = false
TouchSprite
 InheritedgestureTweenOn : Boolean
TouchSprite
 InheritedgO : GestureListObject
TouchSprite
 Inheritedgroup : String
TouchContainerFactory
 Inheritedheight : Number
[override] Sets the height of the container and associated mask
Album
 Inheritedhorizontal : Boolean
Flag indicating the scroll axis
Album
 Inheritedid : String
sets childlist id
TouchContainerFactory
  initialAlpha : Number
The initial alpha value of the album content
MenuAlbum
 Inheritedlayout : *
[override] The album element is intended for a ListLayout only.
Album
 InheritedlayoutComplete : Function
Sets the function to call when the layout is complete
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 InheritedlayoutUpdate : Function
Sets the function to call when the layout updates
TouchContainer
 Inheritedloop : Boolean
A flag instructing the album to continuously cycle through the objects opposed to stopping at the beginning or end.
Album
 InheritedloopQueue : Array
[read-only] The queue storing the order of children in the loop from head to tail
Album
 Inheritedmargin : Number
Sets the margin between the child display objects
Album
 InheritedmaxScale : Number
This method is called after class initialization.
TouchContainerFactory
 InheritedminScale : Number
This method is called after class initialization.
TouchContainerFactory
  mouseChildren : Boolean
[override] Prevent disabling of mouseChildren
MenuAlbum
 InheritedN : int
TouchSprite
 InheritednestedTransform : Boolean
TouchSprite
 Inheritedoutline_alpha : Number
sets the alpha of outline
TouchContainerFactory
 Inheritedoutline_color : Number
sets the color of outline
TouchContainerFactory
 Inheritedoutline_joint : String
TODO
TouchContainerFactory
 InheritedoutlineOn : String
specifies the outline of container to true or false
TouchContainerFactory
 Inheritedoutline_stroke : int
sets the line stroke of outline
TouchContainerFactory
 InheritedpointArray : Vector.<PointObject>
[read-only]
TouchSprite
 InheritedpointCount : int
TouchSprite
 InheritedpropertyStates : Array
Deprecated: Please Use state
TouchContainerFactory
 Inheritedrotation : Number
[override] [write-only] Synchronize the drag angle with the album's rotation
Album
 InheritedrotationX : Number
[override] [write-only] Synchronize the drag angle with the album's rotation
Album
 InheritedrotationY : Number
[override] [write-only] Synchronize the drag angle with the album's rotation
Album
 Inheritedscale : Number
Scales display object
TouchContainer
  selectedAlpha : Number
The alpha value to indicate a selected item
MenuAlbum
  selectedItem : *
[read-only] The selected display object
MenuAlbum
  selections : List
MenuAlbum
 Inheritedsnapping : Boolean
A flag indicating the snap animation of the objects into place
Album
 InheritedsO : StrokeObject
TouchSprite
 Inheritedstate : Array
property states array
TouchContainerFactory
 Inheritedtargeting : Boolean
Turns off manual ALL targeting control, defaults to a simple hit test targeting model with exclusive target clustering
TouchSprite
 InheritedtargetList : 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
 InheritedtargetObject : Object
Allows touch and gesture events to explicitly target a touch object this can be outside the local parent child display list stack
TouchSprite
 InheritedtargetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
TouchSprite
 Inheritedtc : TouchCluster
TouchSprite
 Inheritedtd : TouchDebugDisplay
TouchSprite
 Inheritedtg : TouchGesture
TouchSprite
 InheritedtiO : TimelineObject
TouchSprite
 InheritedtouchChildren : Boolean
TouchSprite
 InheritedtouchObjectID : int
[read-only]
TouchSprite
 Inheritedtp : TouchPipeline
TouchSprite
 InheritedtraceDebugModeOn : Boolean
TouchSprite
 InheritedtransformComplete : Boolean
TouchSprite
 InheritedtransformEventComplete : Boolean
TouchSprite
 InheritedtransformEvents : Boolean
Determins whether transformEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedtransformEventStart : Boolean
TouchSprite
 InheritedtransformGestureVectors : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite.
TouchSprite
 InheritedtransformStart : Boolean
TouchSprite
 InheritedtrO : TransformObject
TouchSprite
 Inheritedtt : TouchTransform
TouchSprite
 Inheritedwidth : Number
[override] Sets the width of the container and associated mask
Album
 Inheritedx_lock : Boolean
TouchSprite
 Inheritedy_lock : Boolean
TouchSprite
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainerFactory
Public Methods
 MethodDefined By
  
MenuAlbum
 Inherited
TODO
TouchContainerFactory
 Inherited
method searches the child and adds to the list
TouchContainerFactory
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Reroutes the addition of children from the album to the album's belt and sets the dimesions of the container based on the greatest width and height of the child dimensions.
Album
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Reroutes the addition of children from the album to the album's belt and sets the dimesions of the container based on the greatest width and height of the child dimensions.
Album
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] Registers event listeners.
TouchSprite
 Inherited
applyLayout(value:* = null):void
[override] The album element is intended for a ListLayout only.
Album
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainerFactory
 Inherited
clear():void
Removes belt children and resets initial album states
Album
 Inherited
clone():*
Clone method
TouchContainer
 Inherited
[override] CML initialization
Album
  
dispose():void
[override]
MenuAlbum
 Inherited
hideIndex(index:int):void
hides child list index
TouchContainer
 Inherited
hideKey(key:String):void
hides childlist key visibility
TouchContainer
  
inDockBounds(obj:*):Boolean
Determines if the object is within the dock's boundaries
MenuAlbum
  
init():void
[override] Initialization function
MenuAlbum
 Inherited
makeGestureList(value:XMLList):Object
TODO
TouchContainerFactory
 Inherited
next():void
Snap to the next item on the belt
Album
 Inherited
objectAtSnapPoint(point:int):*
Returns the object at the current stap point
Album
 Inherited
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
 Inherited
parseCML(cml:XMLList):XMLList
[override] Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
postparse method
TouchContainerFactory
 Inherited
previous():void
Snap to the previous item on the belt
Album
 Inherited
reset():void
Album
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
  
select(obj:*):void
MenuAlbum
 Inherited
method sets the dimensions of each child
TouchContainerFactory
 Inherited
showIndex(index:int):void
shows index of the child list
TouchContainer
 Inherited
showKey(key:String):void
shows the child list key visibility
TouchContainer
 Inherited
snapTo(num:Number):void
Album
  
unSelect(obj:*):void
MenuAlbum
 Inherited
TouchSprite
 Inherited
TouchSprite
 Inherited
TouchSprite
 Inherited
Registers/unregisters event handlers depending on the active modes
TouchSprite
 Inherited
TouchSprite
 Inherited
updateProperties(state:Number = 0):void
update properties of child
TouchContainerFactory
 Inherited
TouchSprite
 Inherited
updateState(album:Album):void
Intended to synchronize this album with another's state when album linking through the AlbumViewer.
Album
 Inherited
TouchSprite
Protected Methods
 MethodDefined By
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
This method is called after class initialization.
TouchContainerFactory
  
Applies drag to the drag clone of the targeted Album item.
MenuAlbum
  
Destroys the corresponding drag clone
MenuAlbum
 Inherited
enableDrag(enable:Boolean = true):void
Album
  
inBounds(e:*):void
[override] Sets inAlbumBounds flag to true
MenuAlbum
  
outOfBounds(e:*):void
[override] Sets inAlbumBounds flag to false
MenuAlbum
 Inherited
randomMinMax(min:Number, max:Number):Number
This method is called after class initialization.
TouchContainerFactory
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
Drag the belt horizontally within the boundaries.
Album
 Inherited
Drag the belt vertically within the boundaries.
Album
 Inherited
thumbUpdate(event:Event):void
This method is called after class initialization.
TouchContainerFactory
Property Detail
clusterBubblingproperty
clusterBubbling:Boolean[override]

Prevent disabling of clusterBubbling


Implementation
    public function get clusterBubbling():Boolean
    public function set clusterBubbling(value:Boolean):void
initialAlphaproperty 
initialAlpha:Number

The initial alpha value of the album content


Implementation
    public function get initialAlpha():Number
    public function set initialAlpha(value:Number):void
mouseChildrenproperty 
mouseChildren:Boolean[override]

Prevent disabling of mouseChildren


Implementation
    public function get mouseChildren():Boolean
    public function set mouseChildren(value:Boolean):void
selectedAlphaproperty 
selectedAlpha:Number

The alpha value to indicate a selected item


Implementation
    public function get selectedAlpha():Number
    public function set selectedAlpha(value:Number):void
selectedItemproperty 
selectedItem:*  [read-only]

The selected display object


Implementation
    public function get selectedItem():*
selectionsproperty 
public var selections:List

Constructor Detail
MenuAlbum()Constructor
public function MenuAlbum()



Method Detail
dispose()method
override public function dispose():void

dragItem()method 
protected function dragItem(e:GWGestureEvent):void

Applies drag to the drag clone of the targeted Album item. If the item does not yet have a drag clone, one is generated and mapped to the item.

Parameters

e:GWGestureEvent

dropItem()method 
protected function dropItem(e:GWGestureEvent):void

Destroys the corresponding drag clone

Parameters

e:GWGestureEvent

inBounds()method 
override protected function inBounds(e:*):void

Sets inAlbumBounds flag to true

Parameters

e:*

inDockBounds()method 
public function inDockBounds(obj:*):Boolean

Determines if the object is within the dock's boundaries

Parameters

obj:*

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

Initialization function

outOfBounds()method 
override protected function outOfBounds(e:*):void

Sets inAlbumBounds flag to false

Parameters

e:*

select()method 
public function select(obj:*):void

Parameters

obj:*

unSelect()method 
public function unSelect(obj:*):void

Parameters

obj:*