Package | com.gestureworks.cml.components |
Class | public class AlbumViewer |
Inheritance | AlbumViewer ![]() ![]() ![]() |
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 | ||
---|---|---|---|
![]() | activity : Boolean
Current state of interaction
| Component | |
album : *
Sets the album element. | AlbumViewer | ||
![]() | autoAlign : String
Set the autoAlign for the auto text layout feature if desired. | Component | |
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
![]() | 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 | |
![]() | 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 | |
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | 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 | |
![]() | glowColor : uint = 0xFFFFFF | Component | |
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
sets the height of the container
| TouchContainer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | hideFrontOnFlip : *
Specifies whether the front is hidden when the the back is shown
| Component | |
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : 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 | ||
![]() | menu : *
Sets the menu element. | Component | |
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | 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 | |
pageButtons : *
Sets the page buttons element. | AlbumViewer | ||
![]() | 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]
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 | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | textFields : Array | Component | |
![]() | timeout : Number
Set the timeout value for when the elements were automatically close. | Component | |
![]() | toBitmap : Boolean | TouchContainer | |
![]() | visible : Boolean [override] [write-only]
Manages the timer and dispatches a state event
| Component | |
![]() | width : Number [override]
sets the width of the container
| TouchContainer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
Constructor
| AlbumViewer | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
clear():void | AlbumViewer | ||
![]() | clone():* [override]
Returns clone of self
| Component | |
dispose():void [override]
Destructor
| AlbumViewer | ||
![]() | fadeIn(dur:Number = 250):void | Component | |
![]() | fadeOut(dur:Number = 250):void | Component | |
![]() | 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 | |
![]() | glowIn(dur:Number = 1):void | Component | |
![]() | glowOut(dur:Number = 1):void | Component | |
![]() | glowPulse():void | Component | |
init():void [override]
Initialization function
| AlbumViewer | ||
![]() | invertMatrix(displayObject:DisplayObject, newParent:DisplayObjectContainer):void | Component | |
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | noActivity(e:GWGestureEvent):void | Component | |
![]() | onDown(event:* = null):void
handles touch event
| Component | |
![]() | onUp(event:* = null):void
handles event
| Component | |
![]() | 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 | |
![]() | 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 | Component | |
![]() | resetMatrix():void | Component | |
![]() | restartTimer():void | Component | |
![]() | 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 | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
![]() | 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 |
Method | Defined By | ||
---|---|---|---|
onStateEvent(event:StateEvent):void [override]
Process AlbumViewer state events
| AlbumViewer | ||
![]() | onTimer(e:TimerEvent):void | Component | |
updateLayout(event:* = null):void [override]
Updates dimensions and other attributes
| AlbumViewer |
album | property |
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.
public function get album():*
public function set album(value:any):void
linkAlbums | property |
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.
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
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 )
|