Class fever.app.local.Localisation

Description

Localisation system manager.

Field Index

CONFIG_ID, culture, lang, UPDATE

Method Index

addLocalisationListener(), connectAccessor(), connectInstance(), disconnectAccessor(), disconnectInstance(), getLocalisationList(), getResource(), hasResource(), init(), isLoaded(), isSupported(), removeLocalisationListener(), update()

Inherited from PriorityEventBroadcaster

Field Detail

UPDATE

static public UPDATE:EventType
Broadcasted when lang change.

lang

static public lang:String
Current used localisation.

culture

static public culture:Culture [Read Only]
Current used Culture

CONFIG_ID

static public CONFIG_ID:String [Read Only]
Property name identifier for sharedObject saving.

Method Detail

init

static public function init(langList:Object, handler:Delegate):Void

Inits localisation system.

Automatically call by configuration API.

getResource

static public function getResource(id:String)

Retreives passed-in id local resource in current language map.

Return

resource string or null if id is not defined in map.

hasResource

static public function hasResource(id:String):Boolean

connectInstance

static public function connectInstance(instance:Object, setter, id:String, substitution:Object):Void

Registers an instance property by his passed-in setter method.

Parameters

instance* Target instance
setter String or {code Function} property access
idLanguage key to watch
substitution( optional ) if apply, use a StringUtil.substitute() to return translation.

connectAccessor

static public function connectAccessor(accessor:IAccessor, id:String, substitution:Object):Void

Registers an IAccessor instance

Parameters

accessorIAccessor instance
idLanguage key to watch
substitution( optional ) if apply, use a StringUtil.substitute() to return translation.

disconnectInstance

static public function disconnectInstance(instance:Object):Void

Unregisters instance property.

Parameters

instance* Target instance

disconnectAccessor

static public function disconnectAccessor(accessor:IAccessor):Void

Unregisters accessor.

Parameters

isLoaded

static public function isLoaded():Boolean

Returns true if resources files are loaded.

addLocalisationListener

static public function addLocalisationListener(listener:LocalisationListener, priority:Number):Void

Adds passed-in listener for receiving localisation events.

Parameters

listenerLocalisationListener instance

removeLocalisationListener

static public function removeLocalisationListener(listener:LocalisationListener):Void

Removes passed-in listener for receiving localisation events.

Parameters

listenerLocalisationListener instance

update

static public function update():Void

Broadcasts a LocalisationEvent.UPDATE event.

All connected objects and listeners are update.

getLocalisationList

static public function getLocalisationList():Array

Returns all available localisation.

isSupported

static public function isSupported():Boolean

Returns if localisation is supported in application.

Returns false if no translation file is found.