Packagecom.bourre.model
Classpublic class AbstractModel

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Abstract implementation of Model part of the MVC implementation.



Protected Properties
 PropertyDefined by
  _oEB : EventBroadcaster
Dedicated Broadcaster for this model.
AbstractModel
  _owner : Plugin
Plugin owner.
AbstractModel
  _sName : String
Model identifier.
AbstractModel
Public Methods
 MethodDefined by
  
AbstractModel(owner:Plugin = null, name:String = null)
Creates instance.
AbstractModel
  
addEventListener(type:String, listener:Object, ... rest):Boolean
Adds an event listener for the specified event type.
AbstractModel
  
addListener(listener:Object):Boolean
Adds the passed-in listener as listener for all events dispatched by this event broadcaster.
AbstractModel
  
Returns model logger tunnel.
AbstractModel
  
getName():String
Returns model identifier.
AbstractModel
  
Returns plugin owner.
AbstractModel
  
Broadcast the passed-in event object to listeners according to the event's type.
AbstractModel
  
release():void
Releases model.
AbstractModel
  
removeEventListener(type:String, listener:Object):Boolean
Removes the passed-in listener for listening the specified event.
AbstractModel
  
removeListener(listener:Object):Boolean
Removes the passed-in listener object from this event broadcaster.
AbstractModel
  
setListenerType(type:Class):void
Defines specific event listener type, compliant to listen this model event broadcaster.
AbstractModel
  
setName(name:String):void
AbstractModel
  
setOwner(owner:Plugin):void
Sets the plugin owner for model.
AbstractModel
  
toString():String
Returns the string representation of this instance.
AbstractModel
Protected Methods
 MethodDefined by
  
Returns event broadcaster used by model.
AbstractModel
  
onInitModel():void
Broadcasts onInitModel event to listeners.
AbstractModel
  
Broadcasts onReleaseModel event to listeners.
AbstractModel
Events
 EventSummaryDefined by
   Dispatched when the user presses the Button control.AbstractModel
   Dispatched when the user presses the Button control.AbstractModel
Public Constants
 ConstantDefined by
  onInitModelEVENT : String = "onInitModel"
[static] Defines the value of the type property of the event object for a onInitModel event.
AbstractModel
  onReleaseModelEVENT : String = "onReleaseModel"
[static] Defines the value of the type property of the event object for a onInitModel event.
AbstractModel
Property detail
_oEBproperty
protected var _oEB:EventBroadcaster

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dedicated Broadcaster for this model.

_ownerproperty 
protected var _owner:Plugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Plugin owner.

_sNameproperty 
protected var _sName:String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Model identifier.

Constructor detail
AbstractModel()constructor
public function AbstractModel(owner:Plugin = null, name:String = null)

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates instance.

Parameters
owner:Plugin (default = null) — (optional) Plugin owner.
If null, use NullPlugin instance.
 
name:String (default = null) — Model's identifier to register into model locator.
Method detail
addEventListener()method
public function addEventListener(type:String, listener:Object, ... rest):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds an event listener for the specified event type. There is two behaviors for the addEventListener function :

  1. The passed-in listener is an object : The object is added as listener only for the specified event, the object must have a function with the same name than type or at least a handleEvent function.
  2. The passed-in listener is a function : A Delegate object is created and then added as listener for the event type. There is no restriction on the name of the function. If the rest is not empty, all elements in it is used as additional arguments into the delegate object.

Parameters
type:String — name of the event for which register the listener
 
listener:Object — object or function which will receive this event
 
... rest — additional arguments for the function listener

Returns
Booleantrue if the function have been succesfully added as listener fot the passed-in event
addListener()method 
public function addListener(listener:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds the passed-in listener as listener for all events dispatched by this event broadcaster. The function returns true if the listener have been added at the end of the call. If the listener is already registered in this event broadcaster the function returns false.

Note : The addListener function doesn't accept functions as listener, functions could only register for a single event.

Parameters
listener:Object — the listener object to add as global listener

Returns
Booleantrue if the listener have been added during this call
getBroadcaster()method 
protected function getBroadcaster():EventBroadcaster

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns event broadcaster used by model.

Returns
EventBroadcaster
getLogger()method 
public function getLogger():PluginDebug

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns model logger tunnel.

Returns
PluginDebug
getName()method 
public function getName():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns model identifier.

Returns
String
getOwner()method 
public function getOwner():Plugin

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns plugin owner.

Returns
Plugin
notifyChanged()method 
public function notifyChanged(e:Event):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Broadcast the passed-in event object to listeners according to the event's type. The event is broadcasted to both listeners registered specifically for this event type and global listeners in the broadcaster.

If the target property of the passed-in event is null, it will be set using the value of the source property of this event broadcaster.

Parameters
e:Event — event object to broadcast
onInitModel()method 
protected function onInitModel():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Broadcasts onInitModel event to listeners.

onReleaseModel()method 
protected function onReleaseModel():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Broadcasts onReleaseModel event to listeners.

release()method 
public function release():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Releases model.

removeEventListener()method 
public function removeEventListener(type:String, listener:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener for listening the specified event. The listener could be either an object or a function.

Parameters
type:String — name of the event for which unregister the listener
 
listener:Object — object or function to be unregistered

Returns
Booleantrue if the listener have been successfully removed as listener for the passed-in event
removeListener()method 
public function removeListener(listener:Object):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes the passed-in listener object from this event broadcaster. The object is removed as listener for all events the broadcaster may dispatch.

Parameters
listener:Object — the listener object to remove from this event broadcaster object

Returns
Booleantrue if the object have been successfully removed from this event broadcaster
setListenerType()method 
public function setListenerType(type:Class):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines specific event listener type, compliant to listen this model event broadcaster.

Parameters
type:Class
setName()method 
public function setName(name:String):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Parameters
name:String
setOwner()method 
public function setOwner(owner:Plugin):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Sets the plugin owner for model.

if owner is null, use NullPlugin instance.

Parameters
owner:Plugin
toString()method 
public 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
Event detail
onInitModelevent 
Event object type: com.bourre.events.StringEvent
StringEvent.type property = com.bourre.model.AbstractModel.onInitModelEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when the user presses the Button control. If the autoRepeat property is true, this event is dispatched repeatedly as long as the button stays down.

Defines the value of the type property of the event object for a onInitModel event.

onReleaseModelevent  
Event object type: com.bourre.events.StringEvent
StringEvent.type property = com.bourre.model.AbstractModel.onReleaseModelEVENT

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Dispatched when the user presses the Button control. If the autoRepeat property is true, this event is dispatched repeatedly as long as the button stays down.

Constant detail
onInitModelEVENTconstant
public static const onInitModelEVENT:String = "onInitModel"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onInitModel event.

onReleaseModelEVENTconstant 
public static const onReleaseModelEVENT:String = "onReleaseModel"

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Defines the value of the type property of the event object for a onInitModel event.