Class fever.data.libs.BitmapLibLocator

Description

BitmapLib repository.

See Also

Field Index

DEFAULT

Method Index

disposeBitmap(), getBitmap(), getFullQualifiedBitmap(), getLocator(), getLocatorName(), isFullQualifiedBitmapExist(), isRegistredBitmap(), isRegistredLocator(), pushBitmap(), removeBitmap(), unregisterLocator()

Field Detail

DEFAULT

static public DEFAULT:String [Read Only]
Default bitmapData repository name.

Method Detail

getLocator

static public function getLocator(name:String):BitmapLibLocator

Returns BitmapLibLocator registred with passed-in name.

If name not exist, a new BitmapLibLocator is created with passed-in name for registration.

If name is null or undefined, returns the default BitmapLibLocator named DEFAULT

Return

BitmapLibLocator instance

isRegistredLocator

static public function isRegistredLocator(name:String):Boolean

Returns true if a BitmapLibLocator is registred with the passed-in name id, otherwise false

unregisterLocator

static public function unregisterLocator(name:String):Boolean

Unregistrers BitmapLibLocator defined by passed-in name id.

All data stored in this BitmapLibLocator are lost.

getFullQualifiedBitmap

static public function getFullQualifiedBitmap(id:String):BitmapData

Retreives BitmapData object from passed-in full qualified id.

id must be :ID@LOCATOR_NAME

Useful when define icons in xml config file for example.

isFullQualifiedBitmapExist

static public function isFullQualifiedBitmapExist(id:String):Boolean

Returns true if passed-in full qualified bitmap id exist.

id must be :BITMAP_ID@REPOSITORY_NAME

pushBitmap

public function pushBitmap(id:String, bmp:BitmapData):Boolean

Stores a new BitmapData object with id name.

getBitmap

public function getBitmap(id:String):BitmapData

Returns BitmapData stored with passed-in id

isRegistredBitmap

public function isRegistredBitmap(id:String):Boolean

Returns true if a BitmapData is registred with the passed-in id, otherwise false

removeBitmap

public function removeBitmap(id:String):Boolean

Removes BitmapData stored with passed-in id

disposeBitmap

public function disposeBitmap():Void

Clears all BitmapData object stored in current BitmapLibLocator

getLocatorName

public function getLocatorName():String

Returns locator name.