Package | com.gestureworks.cml.element |
Class | public class MenuAlbum |
Inheritance | MenuAlbum Album TouchContainer TouchContainerFactory TouchSprite flash.display.Sprite |
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 | ||
applyMask : Boolean
Flag indicating whether the contents are masked
| Album | ||
autoShuffle : Boolean
autoshuffles
| TouchContainerFactory | ||
backgroundColor : uint
The color of the album's background
| Album | ||
belt : TouchContainer [read-only]
The primary container and interactive object
| Album | ||
broadcastTarget : Boolean | TouchSprite | ||
centerContent : Boolean
Flag indicating the album items should be centered horizontally and
vertically
| Album | ||
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 [override]
Prevent disabling of clusterBubbling
| MenuAlbum | ||
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 | ||
currentSnapPoint : Number [read-only]
Returns the index of the current snap point
| Album | ||
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 | ||
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
| TouchContainerFactory | ||
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 | ||
gO : GestureListObject | TouchSprite | ||
group : String | TouchContainerFactory | ||
height : Number [override]
Sets the height of the container and associated mask
| Album | ||
horizontal : Boolean
Flag indicating the scroll axis
| Album | ||
id : String
sets childlist id
| TouchContainerFactory | ||
initialAlpha : Number
The initial alpha value of the album content
| MenuAlbum | ||
layout : * [override]
The album element is intended for a ListLayout only. | Album | ||
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 | ||
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 | ||
maxScale : Number
This method is called after class initialization. | TouchContainerFactory | ||
minScale : Number
This method is called after class initialization. | TouchContainerFactory | ||
mouseChildren : Boolean [override]
Prevent disabling of mouseChildren
| MenuAlbum | ||
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 | ||
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 | ||
scale : 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 | ||
snapping : Boolean
A flag indicating the snap animation of the objects into place
| Album | ||
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 | ||
tg : TouchGesture | TouchSprite | ||
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 | ||
width : Number [override]
Sets the width of the container and associated mask
| Album | ||
x_lock : Boolean | TouchSprite | ||
y_lock : Boolean | TouchSprite |
Method | Defined By | ||
---|---|---|---|
MenuAlbum | |||
activateTouch():void
TODO
| TouchContainerFactory | ||
addAllChildren():void
method searches the child and adds to the list
| TouchContainerFactory | ||
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 | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [override]
Registers event listeners. | TouchSprite | ||
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
| TouchContainerFactory | ||
clear():void
Removes belt children and resets initial album states
| Album | ||
clone():*
Clone method
| TouchContainer | ||
displayComplete():void [override]
CML initialization
| Album | ||
dispose():void [override] | MenuAlbum | ||
hideIndex(index:int):void
hides child list index
| TouchContainer | ||
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 | ||
makeGestureList(value:XMLList):Object
TODO
| TouchContainerFactory | ||
next():void
Snap to the next item on the belt
| Album | ||
objectAtSnapPoint(point:int):*
Returns the object at the current stap point
| Album | ||
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 | ||
parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | TouchContainer | ||
postparseCML(cml:XMLList):void
postparse method
| TouchContainerFactory | ||
previous():void
Snap to the previous item on the belt
| Album | ||
reset():void | Album | ||
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
| TouchContainerFactory | ||
showIndex(index:int):void
shows index of the child list
| TouchContainer | ||
showKey(key:String):void
shows the child list key visibility
| TouchContainer | ||
snapTo(num:Number):void | Album | ||
unSelect(obj:*):void | MenuAlbum | ||
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 | ||
updateState(album:Album):void
Intended to synchronize this album with another's state when album linking through the AlbumViewer. | Album | ||
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 | ||
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 | Album | ||
inBounds(e:*):void [override]
Sets inAlbumBounds flag to true
| MenuAlbum | ||
outOfBounds(e:*):void [override]
Sets inAlbumBounds flag to false
| MenuAlbum | ||
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 | ||
scrollH(e:GWGestureEvent):void
Drag the belt horizontally within the boundaries. | Album | ||
scrollV(e:GWGestureEvent):void
Drag the belt vertically within the boundaries. | Album | ||
thumbUpdate(event:Event):void
This method is called after class initialization. | TouchContainerFactory |
clusterBubbling | property |
clusterBubbling:Boolean
[override] Prevent disabling of clusterBubbling
public function get clusterBubbling():Boolean
public function set clusterBubbling(value:Boolean):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
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:* |