| Package | com.gestureworks.cml.factories |
| Class | public class BitmapFactory |
| Inheritance | BitmapFactory  ElementFactory flash.display.Sprite |
| Subclasses | Flickr, Image |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| aspectRatio : Number [read-only]
Stores the aspectRatio of the currently loaded image
| BitmapFactory | ||
| avatar : Boolean
sets the avatar value
| BitmapFactory | ||
| bitmap : Bitmap
Stores a reference to the currently loaded bitmap
| BitmapFactory | ||
| bitmapArray : Array [read-only]
stores images in an array
| BitmapFactory | ||
| bitmapData : BitmapData
Stores a reference to the currently loaded bitmapData
| BitmapFactory | ||
| bitmapDataArray : Array [read-only]
stores bitmap data array
| BitmapFactory | ||
| bitmapDataCache : Boolean
Specifies whether the bitmapData is cached or not
| BitmapFactory | ||
| 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 | |
| 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
| BitmapFactory | ||
| 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 | |
| isLoaded : Boolean = false | BitmapFactory | ||
| landscape : Boolean [read-only]
specifies whether the loaded image is landscape or not
| BitmapFactory | ||
| left : Number
sets left value
| ElementFactory | |
| normalize : Boolean
specifies whether loaded image is normalised or not
| BitmapFactory | ||
| percentLoaded : Number | BitmapFactory | ||
| portrait : Boolean [read-only]
specifies whether the loaded image is portrait or not
| BitmapFactory | ||
| propertyStates : Array Deprecated: Please Use state | ElementFactory | |
| resample : Boolean
Specifies whether a loaded image is resampled to the provided width and/or height. | BitmapFactory | ||
| 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 | |
| sizeArray : Array
stores array list size
| BitmapFactory | ||
| src : String
Sets the file source path
| BitmapFactory | ||
| 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
| BitmapFactory | ||
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| Method | Defined By | ||
|---|---|---|---|
Constructor
| BitmapFactory | ||
| clone():*
Returns clone of self
| ElementFactory | |
close():void
Closes the currently open image file
| BitmapFactory | ||
displayComplete():void [override]
This is called by the CML parser. | BitmapFactory | ||
dispose():void [override]
Dispose methods and remove listener
| BitmapFactory | ||
| init():void
Initialization function
| ElementFactory | |
load(file:String):void Deprecated: Please Use open()
loads external image file
| BitmapFactory | ||
loadComplete(event:Event = null):void
This is called when the image is loaded. | BitmapFactory | ||
open(file:String = null):void
Opens an external image file
| BitmapFactory | ||
| parseCML(cml:XMLList):XMLList
parses cml file
| ElementFactory | |
| postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | |
preloadFile(file:String):void
loads the file
| BitmapFactory | ||
resize():void | BitmapFactory | ||
| updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory | |
| Method | Defined By | ||
|---|---|---|---|
bitmapComplete():void | BitmapFactory | ||
onPercentLoad(event:StateEvent):void | BitmapFactory | ||
| aspectRatio | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesaspectRatio:Number [read-only] Stores the aspectRatio of the currently loaded image
The default value is 0.
public function get aspectRatio():Number| avatar | property |
avatar:Booleansets the avatar value
The default value is false.
public function get avatar():Boolean public function set avatar(value:Boolean):void| bitmap | property |
bitmap:BitmapStores 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:BitmapDataStores 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:BooleanSpecifies whether the bitmapData is cached or not
The default value is false.
public function get bitmapDataCache():Boolean public function set bitmapDataCache(value:Boolean):void| 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 |
protected var img:IMGLoader| 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:Booleanspecifies 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:BooleanSpecifies 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:Arraystores array list size
public function get sizeArray():Array public function set sizeArray(value:Array):void| src | property |
src:StringSets 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| BitmapFactory | () | Constructor |
public function BitmapFactory()Constructor
| bitmapComplete | () | method |
protected function bitmapComplete():void| close | () | method |
public function close():voidCloses the currently open image file
| displayComplete | () | method |
override public function displayComplete():voidThis is called by the CML parser. Do not override this method.
| dispose | () | method |
override public function dispose():voidDispose methods and remove listener
| load | () | method |
public function load(file:String):voidloads external image file
Parameters
file:String |
| loadComplete | () | method |
public function loadComplete(event:Event = null):voidThis is called when the image is loaded. Do not override this method.
Parameters
event:Event (default = null) |
| onPercentLoad | () | method |
| open | () | method |
public function open(file:String = null):voidOpens an external image file
Parameters
file:String (default = null) |
| preloadFile | () | method |
public function preloadFile(file:String):voidloads the file
Parameters
file:String |
| resize | () | method |
public function resize():void