Packagecom.gestureworks.cml.elements
Classpublic class MenuAlbum
InheritanceMenuAlbum Inheritance Album Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

...



Public Properties
 PropertyDefined By
 InheritedapplyMask : Boolean
Flag indicating whether the contents are masked
Album
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  backButton : *
The display object for the forward button.
MenuAlbum
 InheritedbackgroundAlpha : Number
The alpha of the ablum's background
Album
 InheritedbackgroundColor : uint
The color of the album's background
Album
 Inheritedbelt : TouchContainer
[read-only] The primary container and interactive object
Album
 InheritedcenterContent : Boolean
Flag indicating the album items should be centered horizontally and vertically
Album
 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
  clusterBubbling : Boolean
[override] [write-only] Prevent disabling of clusterBubbling
MenuAlbum
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheritedcurrentIndex : Number
[read-only] Returns the index of the current snap point
Album
 InheritedcurrentObject : *
[read-only] Returns the current object
Album
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 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
TouchContainer
 InheritedflickGesture : String
Specifies the GML flick gesture (e.g.
Album
  forwardButton : *
The display object for the forward button.
MenuAlbum
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] Sets the height of the container and associated mask
Album
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedhorizontal : Boolean
Flag indicating the scroll axis
Album
 Inheritedid : String
Returns the object's id.
TouchContainer
  initialAlpha : Number
The initial alpha value of the album content
MenuAlbum
 Inheritedlayout : *
[override] The album element is intended for a ListLayout only.
Album
 InheritedlayoutList : Dictionary
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
  mouseChildren : Boolean
[override] Prevent disabling of mouseChildren
MenuAlbum
 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
 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
  selectedAlpha : Number
The alpha value to indicate a selected item
MenuAlbum
  selectedItem : *
[read-only] The selected display object
MenuAlbum
  selections : List
MenuAlbum
 InheritedsnapOffset : Number
The offset from the album's origin to snap the belt to.
Album
 Inheritedsnapping : Boolean
A flag indicating the snap animation of the objects into place
Album
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtoBitmap : Boolean
TouchContainer
 Inheritedwidth : Number
[override] Sets the width of the container and associated mask
Album
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
Public Methods
 MethodDefined By
  
MenuAlbum
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 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
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
TouchContainer
 Inherited
clear():void
Removes belt children and resets initial album states
Album
 Inherited
clone():*
Clone method
TouchContainer
  
dispose():void
[override] Destructor
MenuAlbum
 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
  
inDockBounds(obj:*):Boolean
Determines if the object is within the dock's boundaries
MenuAlbum
  
init():void
[override] Initialization function
MenuAlbum
 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
next(tween:Boolean = true):void
Snap to the next item on the belt
Album
 Inherited
objectAtSnapPoint(point:int):*
Returns the object at the current stap point
Album
 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
previous(tween:Boolean = true):void
Snap to the previous item on the belt
Album
 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
reset():void
Reset to initial state
Album
 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
  
select(obj:*):void
MenuAlbum
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
snapTo(num:Number, tween:Boolean = true):void
Snap to a specific child index
Album
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
  
unSelect(obj:*):void
MenuAlbum
 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
 Inherited
updateState(album:Album):void
Intended to synchronize this album with another's state when album linking through the AlbumViewer.
Album
Protected Methods
 MethodDefined By
  
dragItem(e:GWGestureEvent):void
Applies drag to the drag clone of the targeted Album item.
MenuAlbum
  
dropItem(e:GWGestureEvent):void
Destroys the corresponding drag clone
MenuAlbum
 Inherited
enableDrag(enable:Boolean = true):void
Enables/disables drag gesture
Album
 Inherited
flickSnap(e:GWGestureEvent):void
Snap to next or previous depending on flick direction
Album
  
inBounds(e:*):void
[override] Sets inAlbumBounds flag to true
MenuAlbum
  
outOfBounds(e:*):void
[override] Sets inAlbumBounds flag to false
MenuAlbum
 Inherited
scrollH(e:GWGestureEvent):void
Drag the belt horizontally within the boundaries.
Album
 Inherited
scrollV(e:GWGestureEvent):void
Drag the belt vertically within the boundaries.
Album
Property Detail
backButtonproperty
backButton:*

The display object for the forward button.


Implementation
    public function get backButton():*
    public function set backButton(value:any):void
clusterBubblingproperty 
clusterBubbling:Boolean  [write-only] [override]

Prevent disabling of clusterBubbling


Implementation
    public function set clusterBubbling(value:Boolean):void
forwardButtonproperty 
forwardButton:*

The display object for the forward button.


Implementation
    public function get forwardButton():*
    public function set forwardButton(value:any):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

Destructor

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:*