Packagecom.bourre.view
Classpublic final class ViewLocator
InheritanceViewLocator Inheritance AbstractLocator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The ViewLocator class is a locator for AbstractView object.

Locator is unique for a Plugin instance.

See also

AbstractView

Protected Properties
 PropertyDefined by
 Inherited_m : HashMap
Map storing String keys associated with Object values.
AbstractLocator
Public Methods
 MethodDefined by
 Inherited
add(d:Dictionary):void
Adds all ressources contained in the passed-in dictionnary into this locator instance.
AbstractLocator
 Inherited
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
AbstractLocator
 Inherited
callMethodOnAllValues(methodName:String, ... args):void
Takes all values of a Locator and call on each value the method name passed as 1st argument.
AbstractLocator
  
getInstance(owner:Plugin = null):ViewLocator
[static] Returns the unique ViewLocator instance for passed-in Plugin.
ViewLocator
 Inherited
getKeys():Array
Returns an Array view of the keys contained in this locator.
AbstractLocator
 Inherited
getLogger():Log
Returns the exclusive logger object owned by this locator.
AbstractLocator
  
getOwner():Plugin
Returns the plugin owner of this locator.
ViewLocator
 Inherited
getType():Class
Return the class type of elements in this container.
AbstractLocator
 Inherited
getValues():Array
Returns an Array view of the values contained in this locator.
AbstractLocator
  
getView(key:String):AbstractView
Returns AbstractView registered with passed-in key identifier.
ViewLocator
 Inherited
isRegistered(name:String):Boolean
Returns true is there is a ressource associated with the passed-in key.
AbstractLocator
 Inherited
isTyped():Boolean
Returns true if this container perform a verification of the type of elements.
AbstractLocator
 Inherited
locate(name:String):Object
Returns the ressource associated with the passed-in key.
AbstractLocator
 Inherited
matchType(o:*):Boolean
Verify that the passed-in object type match the current container element's type.
AbstractLocator
 Inherited
processOnAllValues(f:Function, ... args):void
Takes all values of a Locator and pass them one by one as arguments to a method of an object.
AbstractLocator
  
register(key:String, o:Object):Boolean
Registers passed-in object with identifier name to this locator.
ViewLocator
  
release():void
Clears all association between keys and objects registered for this locator.
ViewLocator
 Inherited
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
AbstractLocator
  
toString():String
Returns the string representation of this instance.
ViewLocator
 Inherited
unregister(name:String):Boolean
Unregisters object registered with identifier name.
AbstractLocator
Protected Methods
 MethodDefined by
 Inherited
broadcastEvent(e:Event):void
Broadcast the passed-in event object to listeners according to the event's type.
AbstractLocator
 Inherited
getBroadcaster():Broadcaster
Returns event Broadcaster owned by this locator.
AbstractLocator
 Inherited
onRegister(name:String = null, o:Object = null):void
Call this method to do something when an object is registered in locator.
AbstractLocator
 Inherited
onUnregister(name:String = null):void
Call this method to do something when an object is unregistered from locator.
AbstractLocator
Method detail
getInstance()method
public static function getInstance(owner:Plugin = null):ViewLocator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the unique ViewLocator instance for passed-in Plugin.

Parameters
owner:Plugin (default = null)

Returns
ViewLocator — The unique ViewLocator instance.
getOwner()method 
public function getOwner():Plugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the plugin owner of this locator.

Returns
Plugin — The plugin owner of this locator.
getView()method 
public function getView(key:String):AbstractView

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns AbstractView registered with passed-in key identifier.

Parameters
key:String — View registration ID

Returns
AbstractView

Throws
— NoSuchElementException — There is no view associated with the passed-in key
register()method 
public override function register(key:String, o:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Registers passed-in object with identifier name to this locator.

Parameters
key:String — Key identifier
 
o:Object — Object to store

Returns
Boolean — true if success

Throws
— NullPointerException — Key or object are null
release()method 
public override function release():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Clears all association between keys and objects registered for this locator.

toString()method 
public override function toString():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the string representation of this instance.

Returns
String — the string representation of this instance



Submit Feedback
LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00