Package | com.gestureworks.cml.components |
Class | public class CollectionViewer |
Inheritance | CollectionViewer ![]() ![]() ![]() |
It can load more objects than will display at any one time. The objects not displayed are put into queue and the CollectionViwer cycles through the queue whenever a user closes an object or moves it offscreen.
See also
Property | Defined By | ||
---|---|---|---|
![]() | activity : Boolean
Current state of interaction
| Component | |
amountToShow : int = -1 | CollectionViewer | ||
animateIn : Boolean = false | CollectionViewer | ||
![]() | 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 | |
bottomContainer : *
Sets bottom container for double sided database version. | CollectionViewer | ||
![]() | 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 | |
gateway : String
Sets database gateway url
| CollectionViewer | ||
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
topContainer : *
Sets top container for double sided database version. | CollectionViewer | ||
![]() | 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 |
Property | Defined By | ||
---|---|---|---|
![]() | cmlGestureList : Object | TouchContainer | |
queue : List | CollectionViewer | ||
shown : List | CollectionViewer | ||
![]() | side : String [read-only]
Specifies the currently displayed side
| Component |
Method | Defined By | ||
---|---|---|---|
Constructor
| CollectionViewer | ||
![]() | 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 | |
![]() | clone():* [override]
Returns clone of self
| Component | |
dispose():void [override]
Destructor
| CollectionViewer | ||
![]() | 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]
Initialisation method
| CollectionViewer | ||
![]() | 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 | |
tagObject(top:Boolean, obj:*):void
Classifies the object as either a top-container object or a bottom-container object. | CollectionViewer | ||
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
untagObject(obj:*):void
Disassociates the provided object from the top or bottom containers. | CollectionViewer | ||
![]() | 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 | ||
---|---|---|---|
addComponent(c:DisplayObject):void
Adds component. | CollectionViewer | ||
addNextComponent():void
Adds next component from queue. | CollectionViewer | ||
checkComponents():void
Checks to see if the correct number of componets are currently shown. | CollectionViewer | ||
onEnterFrame(e:Event):void
Enter frame event handler
| CollectionViewer | ||
onGestureComplete(event:GWGestureEvent = null):void | CollectionViewer | ||
onStateEvent(event:StateEvent):void [override]
| CollectionViewer | ||
![]() | onTimer(e:TimerEvent):void | Component | |
removeComponent(c:DisplayObject):void
Removes component. | CollectionViewer | ||
updateLayout(event:* = null):void [override]
| CollectionViewer |
amountToShow | property |
public var amountToShow:int = -1
animateIn | property |
public var animateIn:Boolean = false
bottomContainer | property |
bottomContainer:*
Sets bottom container for double sided database version.
public function get bottomContainer():*
public function set bottomContainer(value:any):void
gateway | property |
gateway:String
Sets database gateway url
public function get gateway():String
public function set gateway(value:String):void
queue | property |
protected var queue:List
shown | property |
protected var shown:List
topContainer | property |
topContainer:*
Sets top container for double sided database version.
public function get topContainer():*
public function set topContainer(value:any):void
CollectionViewer | () | Constructor |
public function CollectionViewer()
Constructor
addComponent | () | method |
protected function addComponent(c:DisplayObject):void
Adds component.
Parameters
c:DisplayObject |
addNextComponent | () | method |
protected function addNextComponent():void
Adds next component from queue.
checkComponents | () | method |
protected function checkComponents():void
Checks to see if the correct number of componets are currently shown.
dispose | () | method |
override public function dispose():void
Destructor
init | () | method |
override public function init():void
Initialisation method
onEnterFrame | () | method |
protected function onEnterFrame(e:Event):void
Enter frame event handler
Parameters
e:Event |
onGestureComplete | () | method |
protected function onGestureComplete(event:GWGestureEvent = null):void
Parameters
event:GWGestureEvent (default = null )
|
onStateEvent | () | method |
removeComponent | () | method |
protected function removeComponent(c:DisplayObject):void
Removes component.
Parameters
c:DisplayObject |
tagObject | () | method |
public function tagObject(top:Boolean, obj:*):void
Classifies the object as either a top-container object or a bottom-container object.
Parameters
top:Boolean — container tag
| |
obj:* — the object to tag
|
untagObject | () | method |
public function untagObject(obj:*):void
Disassociates the provided object from the top or bottom containers.
Parameters
obj:* |
updateLayout | () | method |
override protected function updateLayout(event:* = null):void
Parameters
event:* (default = null )
|