Packagecom.gestureworks.cml.components
Classpublic class AlbumViewer
InheritanceAlbumViewer Inheritance Component Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The AlbumViewer component is primarily meant to display an Album element and its associated meta-data.

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

Component
com.gestureworks.cml.elements.Album
com.gestureworks.cml.elements.TouchContainer


Public Properties
 PropertyDefined By
 Inheritedactivity : Boolean
Current state of interaction
Component
  album : *
Sets the album element.
AlbumViewer
 InheritedautoAlign : String
Set the autoAlign for the auto text layout feature if desired.
Component
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
 InheritedautoTextLayout : Boolean
Specifies whether text fields will be automatically adjusted to the component's width
Component
 Inheritedback : *
Sets the back element.
Component
 Inheritedbackground : *
Sets the back background element.
Component
 Inheritedbacks : Array
Component
 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
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 InheritedfadeoutDuration : Number
Set the fadeout time for an object that's timed out.
Component
 InheritedfontArray : Array
Component
 InheritedfontIncrement : Number
font increment
Component
 Inheritedframe : *
Sets the frame element.
Component
 Inheritedfront : *
Sets the front element.
Component
 Inheritedfronts : Array
Component
 InheritedglowColor : uint = 0xFFFFFF
Component
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 InheritedhideFrontOnFlip : *
Specifies whether the front is hidden when the the back is shown
Component
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
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
 Inheritedmenu : *
Sets the menu element.
Component
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 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
  pageButtons : *
Sets the page buttons element.
AlbumViewer
 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
  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
 Inheritedsound : String
TouchContainer
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 InheritedtextFields : Array
Component
 Inheritedtimeout : Number
Set the timeout value for when the elements were automatically close.
Component
 InheritedtoBitmap : Boolean
TouchContainer
 Inheritedvisible : Boolean
[override] [write-only] Manages the timer and dispatches a state event
Component
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
 Inheritedside : String
[read-only] Specifies the currently displayed side
Component
Public Methods
 MethodDefined By
  
Constructor
AlbumViewer
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
  
clear():void
AlbumViewer
 Inherited
clone():*
[override] Returns clone of self
Component
  
dispose():void
[override] Destructor
AlbumViewer
 Inherited
fadeIn(dur:Number = 250):void
Component
 Inherited
fadeOut(dur:Number = 250):void
Component
 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
 Inherited
glowIn(dur:Number = 1):void
Component
 Inherited
glowOut(dur:Number = 1):void
Component
 Inherited
glowPulse():void
Component
  
init():void
[override] Initialization function
AlbumViewer
 Inherited
invertMatrix(displayObject:DisplayObject, newParent:DisplayObjectContainer):void
Component
 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
noActivity(e:GWGestureEvent):void
Component
 Inherited
onDown(event:* = null):void
handles touch event
Component
 Inherited
onUp(event:* = null):void
handles event
Component
 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
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
Component
 Inherited
Component
 Inherited
Component
 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
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 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
Protected Methods
 MethodDefined By
  
[override] Process AlbumViewer state events
AlbumViewer
 Inherited
onTimer(e:TimerEvent):void
Component
  
updateLayout(event:* = null):void
[override] Updates dimensions and other attributes
AlbumViewer
Property Detail
albumproperty
album:*

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.


Implementation
    public function get album():*
    public function set album(value:any):void
linkAlbumsproperty 
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. Both albums must have the same number of objects.


Implementation
    public function get linkAlbums():Boolean
    public function set linkAlbums(value:Boolean):void
pageButtonsproperty 
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.


Implementation
    public function get pageButtons():*
    public function set pageButtons(value:any):void
rotationproperty 
rotation:Number  [write-only] [override]

Updates the angle of the album element


Implementation
    public function set rotation(value:Number):void
rotationXproperty 
rotationX:Number  [write-only] [override]

Updates the angle of the album element


Implementation
    public function set rotationX(value:Number):void
rotationYproperty 
rotationY:Number  [write-only] [override]

Updates the angle of the album element


Implementation
    public function set rotationY(value:Number):void
Constructor Detail
AlbumViewer()Constructor
public function AlbumViewer()

Constructor

Method Detail
clear()method
public function clear():void

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

Destructor

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

Initialization function

onStateEvent()method 
override protected function onStateEvent(event:StateEvent):void

Process AlbumViewer state events

Parameters

event:StateEvent

updateLayout()method 
override protected function updateLayout(event:* = null):void

Updates dimensions and other attributes

Parameters

event:* (default = null)