Package | com.gestureworks.cml.elements |
Class | public class MenuAlbum |
Inheritance | MenuAlbum ![]() ![]() ![]() |
Property | Defined By | ||
---|---|---|---|
![]() | applyMask : Boolean
Flag indicating whether the contents are masked
| Album | |
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
backButton : *
The display object for the forward button. | MenuAlbum | ||
![]() | backgroundAlpha : Number
The alpha of the ablum's background
| Album | |
![]() | backgroundColor : uint
The color of the album's background
| Album | |
![]() | belt : TouchContainer [read-only]
The primary container and interactive object
| Album | |
![]() | centerContent : Boolean
Flag indicating the album items should be centered horizontally and
vertically
| Album | |
![]() | 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 | |
clusterBubbling : Boolean [override] [write-only]
Prevent disabling of clusterBubbling
| MenuAlbum | ||
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
![]() | currentIndex : Number [read-only]
Returns the index of the current snap point
| Album | |
![]() | currentObject : * [read-only]
Returns the current object
| Album | |
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dragAngle : Number
Intended to account for the rotation of the parent object to apply to
drag transformations. | Album | |
![]() | dragGesture : String
Specifies the GML drag gesture of the belt (e.g. | Album | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | flickGesture : String
Specifies the GML flick gesture (e.g. | Album | |
forwardButton : *
The display object for the forward button. | MenuAlbum | ||
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
Sets the height of the container and associated mask
| Album | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | horizontal : Boolean
Flag indicating the scroll axis
| Album | |
![]() | id : String
Returns the object's id. | TouchContainer | |
initialAlpha : Number
The initial alpha value of the album content
| MenuAlbum | ||
![]() | layout : * [override]
The album element is intended for a ListLayout only. | Album | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | loop : Boolean
A flag instructing the album to continuously cycle through the objects opposed
to stopping at the beginning or end. | Album | |
![]() | loopQueue : Array [read-only]
The queue storing the order of children in the loop from head to tail
| Album | |
![]() | margin : Number
Sets the margin between the child display objects
| Album | |
mouseChildren : Boolean [override]
Prevent disabling of mouseChildren
| MenuAlbum | ||
![]() | 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 | |
![]() | rotation : Number [override] [write-only]
Synchronize the drag angle with the album's rotation
| Album | |
![]() | rotationX : Number [override] [write-only]
Synchronize the drag angle with the album's rotation
| Album | |
![]() | rotationY : 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 | ||
![]() | snapOffset : Number
The offset from the album's origin to snap the belt to. | Album | |
![]() | snapping : Boolean
A flag indicating the snap animation of the objects into place
| Album | |
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | toBitmap : Boolean | TouchContainer | |
![]() | width : Number [override]
Sets the width of the container and associated mask
| Album | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
MenuAlbum | |||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | 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 | |
![]() | 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 | |
![]() | applyLayout(value:* = null):void [override]
The album element is intended for a ListLayout only. | Album | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
![]() | clear():void
Removes belt children and resets initial album states
| Album | |
![]() | clone():*
Clone method
| TouchContainer | |
dispose():void [override]
Destructor
| MenuAlbum | ||
![]() | 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 | |
inDockBounds(obj:*):Boolean
Determines if the object is within the dock's boundaries
| MenuAlbum | ||
init():void [override]
Initialization function
| MenuAlbum | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | next(tween:Boolean = true):void
Snap to the next item on the belt
| Album | |
![]() | objectAtSnapPoint(point:int):*
Returns the object at the current stap point
| Album | |
![]() | 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 | |
![]() | previous(tween:Boolean = true):void
Snap to the previous item on the belt
| Album | |
![]() | 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
Reset to initial state
| Album | |
![]() | 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 | |
select(obj:*):void | MenuAlbum | ||
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | snapTo(num:Number, tween:Boolean = true):void
Snap to a specific child index
| Album | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
unSelect(obj:*):void | MenuAlbum | ||
![]() | 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 | |
![]() | updateState(album:Album):void
Intended to synchronize this album with another's state when album linking through the AlbumViewer. | Album |
Method | Defined 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 | ||
![]() | enableDrag(enable:Boolean = true):void
Enables/disables drag gesture
| Album | |
![]() | 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 | ||
![]() | scrollH(e:GWGestureEvent):void
Drag the belt horizontally within the boundaries. | Album | |
![]() | scrollV(e:GWGestureEvent):void
Drag the belt vertically within the boundaries. | Album |
backButton | property |
backButton:*
The display object for the forward button.
public function get backButton():*
public function set backButton(value:any):void
clusterBubbling | property |
clusterBubbling:Boolean
[write-only] [override] Prevent disabling of clusterBubbling
public function set clusterBubbling(value:Boolean):void
forwardButton | property |
forwardButton:*
The display object for the forward button.
public function get forwardButton():*
public function set forwardButton(value:any):void
initialAlpha | property |
initialAlpha:Number
The initial alpha value of the album content
public function get initialAlpha():Number
public function set initialAlpha(value:Number):void
mouseChildren | property |
mouseChildren:Boolean
[override] Prevent disabling of mouseChildren
public function get mouseChildren():Boolean
public function set mouseChildren(value:Boolean):void
selectedAlpha | property |
selectedAlpha:Number
The alpha value to indicate a selected item
public function get selectedAlpha():Number
public function set selectedAlpha(value:Number):void
selectedItem | property |
selectedItem:*
[read-only] The selected display object
public function get selectedItem():*
selections | property |
public var selections:List
MenuAlbum | () | Constructor |
public function MenuAlbum()
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:* |
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:* |