| Package | com.gestureworks.cml.components |
| Class | public class AlbumViewer |
| Inheritance | AlbumViewer  Component TouchContainer TouchContainerFactory TouchSprite flash.display.Sprite |
It is composed of the following:
The width and height of the component are automatically set to the dimensions of the Album element unless it is previously specifed by the component.
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 | |
| album : *
Sets the album element. | AlbumViewer | ||
| 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 | |
| linkAlbums : Boolean
When the back is also an album, this flag indicates the actions applied to one album will be
applied to the other album. | AlbumViewer | ||
| 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 | |
| pageButtons : *
Sets the page buttons element. | AlbumViewer | ||
| pointArray : Vector.<PointObject> [read-only] | TouchSprite | |
| pointCount : int | TouchSprite | |
| propertyStates : Array Deprecated: Please Use state | TouchContainerFactory | |
| rotation : Number [override] [write-only]
Updates the angle of the album element
| AlbumViewer | ||
| rotationX : Number [override] [write-only]
Updates the angle of the album element
| AlbumViewer | ||
| rotationY : Number [override] [write-only]
Updates the angle of the album element
| AlbumViewer | ||
| 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor
| AlbumViewer | ||
| 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 | |
clear():void | AlbumViewer | ||
| clone():* [override]
Returns clone of self
| Component | |
displayComplete():void [override]
CML initialization
| AlbumViewer | ||
dispose():void [override]
Dispose method
| AlbumViewer | ||
| 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]
Initialization function
| AlbumViewer | ||
| 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 [override]
Process AlbumViewer state events
| AlbumViewer | ||
| 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 [override]
Updates dimensions and other attributes
| AlbumViewer | ||
| album | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesalbum:*Sets the album 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 album():* public function set album(value:any):void| linkAlbums | property |
linkAlbums:BooleanWhen the back is also an album, this flag indicates the actions applied to one album will be applied to the other album. Both albums must have the same number of objects.
public function get linkAlbums():Boolean public function set linkAlbums(value:Boolean):void| pageButtons | property |
pageButtons:*Sets the page buttons 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 pageButtons():* public function set pageButtons(value:any):void| rotation | property |
rotation:Number [write-only] [override] Updates the angle of the album element
public function set rotation(value:Number):void| rotationX | property |
rotationX:Number [write-only] [override] Updates the angle of the album element
public function set rotationX(value:Number):void| rotationY | property |
rotationY:Number [write-only] [override] Updates the angle of the album element
public function set rotationY(value:Number):void| AlbumViewer | () | Constructor |
public function AlbumViewer()Constructor
| clear | () | method |
public function clear():void| displayComplete | () | method |
override public function displayComplete():voidCML initialization
| dispose | () | method |
override public function dispose():voidDispose method
| init | () | method |
override public function init():voidInitialization function
| onStateEvent | () | method |
override protected function onStateEvent(event:StateEvent):voidProcess AlbumViewer state events
Parameters
event:StateEvent |
| updateLayout | () | method |
override protected function updateLayout(event:* = null):voidUpdates dimensions and other attributes
Parameters
event:* (default = null) |