Package | com.gestureworks.cml.elements |
Class | public class Image |
Inheritance | Image ![]() ![]() |
Subclasses | Flickr |
var img:Image = new Image(); img.src = "my_image.png"; img.init(); addChild(img);
Property | Defined By | ||
---|---|---|---|
aspectRatio : Number [read-only]
Stores the aspectRatio of the currently loaded image
| Image | ||
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
avatar : Boolean
sets the avatar value
| Image | ||
bitmap : Bitmap
Stores a reference to the currently loaded bitmap
| Image | ||
bitmapArray : Array [read-only]
stores images in an array
| Image | ||
bitmapData : BitmapData
Stores a reference to the currently loaded bitmapData
| Image | ||
bitmapDataArray : Array [read-only]
stores bitmap data array
| Image | ||
bitmapDataCache : Boolean
Specifies whether the bitmapData is cached or not
| Image | ||
![]() | 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 | |
fileData : Bitmap | Image | ||
![]() | group : String | TouchContainer | |
height : Number [override]
Sets width of the display object in pixels
| Image | ||
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | id : String
Returns the object's id. | TouchContainer | |
img : ImageLoader | Image | ||
isLoaded : Boolean = false | Image | ||
landscape : Boolean [read-only]
specifies whether the loaded image is landscape or not
| Image | ||
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
normalize : Boolean
specifies whether loaded image is normalised or not
| Image | ||
![]() | 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 | |
percentLoaded : Number | Image | ||
portrait : Boolean [read-only]
specifies whether the loaded image is portrait or not
| Image | ||
![]() | 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 | |
resample : Boolean
Specifies whether a loaded image is resampled to the provided width and/or height. | Image | ||
sizeArray : Array
stores array list size
| Image | ||
![]() | sound : String | TouchContainer | |
src : String
Sets the file source path
| Image | ||
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | toBitmap : Boolean | TouchContainer | |
width : Number [override]
Sets width of the display object in pixels
| Image | ||
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
_bitmapDataArray : Array | Image | ||
![]() | cmlGestureList : Object | TouchContainer |
Method | Defined By | ||
---|---|---|---|
Image()
Constructor
| Image | ||
![]() | 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 a clone of this Image
| Image | ||
close():void
Closes the currently open image file
| Image | ||
dispose():void [override]
Destructor
| Image | ||
![]() | 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 | |
init():void [override]
Initialisation method
| Image | ||
loadComplete(event:Event = null):void
This is called when the image is loaded. | Image | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
open(file:String = null):void
Opens an external image file
| Image | ||
![]() | 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 | |
resize():void | Image | ||
![]() | 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 | ||
---|---|---|---|
bitmapComplete():void | Image | ||
onPercentLoad(event:LoaderEvent):void | Image |
_bitmapDataArray | property |
protected var _bitmapDataArray:Array
aspectRatio | property |
aspectRatio:Number
[read-only] Stores the aspectRatio of the currently loaded image
The default value is 0
.
public function get aspectRatio():Number
avatar | property |
avatar:Boolean
sets the avatar value
The default value is false
.
public function get avatar():Boolean
public function set avatar(value:Boolean):void
bitmap | property |
bitmap:Bitmap
Stores a reference to the currently loaded bitmap
The default value is null
.
public function get bitmap():Bitmap
public function set bitmap(value:Bitmap):void
bitmapArray | property |
bitmapArray:Array
[read-only] stores images in an array
public function get bitmapArray():Array
bitmapData | property |
bitmapData:BitmapData
Stores a reference to the currently loaded bitmapData
The default value is null
.
public function get bitmapData():BitmapData
public function set bitmapData(value:BitmapData):void
bitmapDataArray | property |
bitmapDataArray:Array
[read-only] stores bitmap data array
public function get bitmapDataArray():Array
bitmapDataCache | property |
bitmapDataCache:Boolean
Specifies whether the bitmapData is cached or not
The default value is false
.
public function get bitmapDataCache():Boolean
public function set bitmapDataCache(value:Boolean):void
fileData | property |
public var fileData:Bitmap
height | property |
height:Number
[override] Sets width of the display object in pixels
The default value is 0
.
public function get height():Number
public function set height(value:Number):void
img | property |
public var img:ImageLoader
isLoaded | property |
public var isLoaded:Boolean = false
landscape | property |
landscape:Boolean
[read-only] specifies whether the loaded image is landscape or not
The default value is false
.
public function get landscape():Boolean
normalize | property |
normalize:Boolean
specifies whether loaded image is normalised or not
The default value is false
.
public function get normalize():Boolean
public function set normalize(value:Boolean):void
percentLoaded | property |
public var percentLoaded:Number
portrait | property |
portrait:Boolean
[read-only] specifies whether the loaded image is portrait or not
The default value is false
.
public function get portrait():Boolean
resample | property |
resample:Boolean
Specifies whether a loaded image is resampled to the provided width and/or height. In order for resampling to work, this must be set to true, and a width and/or height must be set prior to calling open.
The default value is false
.
public function get resample():Boolean
public function set resample(value:Boolean):void
sizeArray | property |
sizeArray:Array
stores array list size
public function get sizeArray():Array
public function set sizeArray(value:Array):void
src | property |
src:String
Sets the file source path
The default value is null
.
public function get src():String
public function set src(value:String):void
width | property |
width:Number
[override] Sets width of the display object in pixels
The default value is 0
.
public function get width():Number
public function set width(value:Number):void
Image | () | Constructor |
public function Image()
Constructor
bitmapComplete | () | method |
protected function bitmapComplete():void
clone | () | method |
override public function clone():*
Returns a clone of this Image
Returns* —
|
close | () | method |
public function close():void
Closes the currently open image file
dispose | () | method |
override public function dispose():void
Destructor
init | () | method |
override public function init():void
Initialisation method
loadComplete | () | method |
public function loadComplete(event:Event = null):void
This is called when the image is loaded. Do not override this method.
Parameters
event:Event (default = null )
|
onPercentLoad | () | method |
protected function onPercentLoad(event:LoaderEvent):void
Parameters
event:LoaderEvent |
open | () | method |
public function open(file:String = null):void
Opens an external image file
Parameters
file:String (default = null )
|
resize | () | method |
public function resize():void