| Package | com.gestureworks.cml.element | 
| Class | public class ImageList | 
| Inheritance | ImageList    ElementFactory   flash.display.Sprite | 
| Subclasses | ImageSequence | 
See also
| Property | Defined By | ||
|---|---|---|---|
![]()  | alpha : Number [override] [write-only] 
		 sets the alpha for display objects
		   | ElementFactory | |
| autoShow : Boolean 
		Indicates whether the file shows upon load
		  | ImageList | ||
![]()  | blur : Boolean 
		 Sets the drop shadow effect
		   | ElementFactory | |
![]()  | bottom : Number 
		 sets the bottom value
		   | ElementFactory | |
![]()  | class_ : String 
		 Object's css class; 
		   | ElementFactory | |
![]()  | className : String 
		 sets the class name of displayobject
		   | ElementFactory | |
![]()  | cmlIndex : int 
		 sets the cml index
		   | ElementFactory | |
| currentIndex : int 
		 sets the current index of the image
		   | ImageList | ||
| currentValue : * [read-only] 
		 sets the current value
		   | ImageList | ||
![]()  | debugStyle : * 
		 sets the debug style
		   | ElementFactory | |
![]()  | displayEvents : String 
		 Use for dispatch completes.  | ElementFactory | |
![]()  | dropShadow : Boolean 
		 Sets the drop shadow effect
		   | ElementFactory | |
![]()  | height : Number [override] 
		 Sets width of the display object in pixels
		   | ElementFactory | |
![]()  | heightPercent : String 
		 sets the height percent of display object
		   | ElementFactory | |
![]()  | horizontalCenter : Number 
		 sets the horizontal center of display object
		   | ElementFactory | |
![]()  | id : String 
		 sets the id of child
		   | ElementFactory | |
![]()  | index : int 
		 sets the index of display object
		   | ElementFactory | |
![]()  | left : Number 
		 sets left value
		   | ElementFactory | |
| length : int [read-only] 
		 defines the length
		   | ImageList | ||
| preload : Boolean = true 
		 defines preload flag
		   | ImageList | ||
![]()  | propertyStates : Array Deprecated: Please Use state  | ElementFactory | |
![]()  | right : Number 
		 sets the right value
		   | ElementFactory | |
![]()  | scale : Number 
		 Sets both the x and y scale values
		   | ElementFactory | |
![]()  | scaleX : Number [override] 
		 Sets width of the display object in pixels
		   | ElementFactory | |
![]()  | scaleY : Number [override] 
		 Sets width of the display object in pixels
		   | ElementFactory | |
| src : String 
		 sets the src xml file
		   | ImageList | ||
![]()  | state : Array 
		 property states array
		   | ElementFactory | |
![]()  | top : Number 
		 sets top value
		   | ElementFactory | |
![]()  | verticalCenter : Number 
		 sets the vertical center of display object
		   | ElementFactory | |
![]()  | width : Number [override] 
		 Sets width of the display object in pixels
		   | ElementFactory | |
![]()  | widthPercent : String 
		 sets the percent of width of display object
		   | ElementFactory | |
| Method | Defined By | ||
|---|---|---|---|
		 Constructor
		   | ImageList | ||
append(file:String):void 
		 appends the image to the list
		   | ImageList | ||
![]()  | clone():* 
		 Returns clone of self
		   | ElementFactory | |
![]()  | displayComplete():void 
		 CML callback
		   | ElementFactory | |
dispose():void [override] 
		 Dispose methods.  | ImageList | ||
getIndex(index:int):* 
		 returns the image by index
		   | ImageList | ||
hasIndex(index:int):Boolean 
		 finds and returns the index value
		   | ImageList | ||
hasNext():Boolean 
		 find and returns the next image from the list
		   | ImageList | ||
hasPrev():Boolean 
		 returns the previous index from list
		   | ImageList | ||
hide(index:int):void 
		 hides
		   | ImageList | ||
![]()  | init():void 
		 Initialization function
		   | ElementFactory | |
insert(index:int, file:String):void 
		 inserts image into specified index location
		   | ImageList | ||
loadComplete():void 
		 image load callback
		   | ImageList | ||
next():* 
		 returns the next image
		   | ImageList | ||
![]()  | parseCML(cml:XMLList):XMLList 
		 parses cml file
		   | ElementFactory | |
postparseCML(cml:XMLList):void [override] 
		 This is called by the CML parser.  | ImageList | ||
prepend(file:String):void 
		 prepends the image to the list
		   | ImageList | ||
prev():* 
		 returns the previous image
		   | ImageList | ||
removeIndex(index:int):void 
		 removes the index from list
		   | ImageList | ||
reset():void 
		 sets the current index from list
		   | ImageList | ||
search(value:*):* 
		 search the list by image value
		   | ImageList | ||
selectIndex(index:int):* 
		 returns the image by index and updates the current index
		   | ImageList | ||
show(index:int):void 
		 adds the selected index
		   | ImageList | ||
toggle(index1:int, index2:int):void 
		 toggles the indexes
		   | ImageList | ||
![]()  | updateProperties(state:Number = 0):void 
		 this method updates the properties
		   | ElementFactory | |
| autoShow | property | 
autoShow:BooleanIndicates whether the file shows upon load
 The default value is false.
    public function get autoShow():Boolean    public function set autoShow(value:Boolean):void| currentIndex | property | 
currentIndex:intsets the current index of the image
    public function get currentIndex():int    public function set currentIndex(value:int):void| currentValue | property | 
currentValue:*  [read-only] sets the current value
    public function get currentValue():*| length | property | 
length:int  [read-only] defines the length
    public function get length():int| preload | property | 
public var preload:Boolean = truedefines preload flag
| src | property | 
src:Stringsets the src xml file
    public function get src():String    public function set src(value:String):void| ImageList | () | Constructor | 
public function ImageList()Constructor
| append | () | method | 
 public function append(file:String):voidappends the image to the list
Parameters
file:String | 
| dispose | () | method | 
override public function dispose():voidDispose methods.
| getIndex | () | method | 
 public function getIndex(index:int):*returns the image by index
Parameters
index:int | 
* —  | 
| hasIndex | () | method | 
 public function hasIndex(index:int):Booleanfinds and returns the index value
Parameters
index:int | 
Boolean —  | 
| hasNext | () | method | 
 public function hasNext():Booleanfind and returns the next image from the list
ReturnsBoolean —  | 
| hasPrev | () | method | 
 public function hasPrev():Booleanreturns the previous index from list
ReturnsBoolean —  | 
| hide | () | method | 
 public function hide(index:int):voidhides
Parameters
index:int | 
| insert | () | method | 
 public function insert(index:int, file:String):voidinserts image into specified index location
Parameters
index:int | |
file:String | 
| loadComplete | () | method | 
 public function loadComplete():voidimage load callback
| next | () | method | 
 public function next():*returns the next image
Returns* —  | 
| postparseCML | () | method | 
override public function postparseCML(cml:XMLList):voidThis is called by the CML parser. Do not override this method.
Parameters
cml:XMLList | 
| prepend | () | method | 
 public function prepend(file:String):voidprepends the image to the list
Parameters
file:String | 
| prev | () | method | 
 public function prev():*returns the previous image
Returns* —  | 
| removeIndex | () | method | 
 public function removeIndex(index:int):voidremoves the index from list
Parameters
index:int | 
| reset | () | method | 
 public function reset():voidsets the current index from list
| search | () | method | 
 public function search(value:*):*search the list by image value
Parameters
value:* | 
* —  | 
| selectIndex | () | method | 
 public function selectIndex(index:int):*returns the image by index and updates the current index
Parameters
index:int | 
* —  | 
| show | () | method | 
 public function show(index:int):voidadds the selected index
Parameters
index:int | 
| toggle | () | method | 
 public function toggle(index1:int, index2:int):voidtoggles the indexes
Parameters
index1:int | |
index2:int |