+Show TOC
×Hide TOC

AbstractModel

Kind of class:	public class
Package:	com.bourre.model
Inherits from:	none
Classpath:	com.bourre.model.AbstractModel
File last modified:	Tuesday, 15 April 2008, 09:25:43

► View source

▼ Hide source

package com.bourre.model
{
    /*
     * Copyright the original author or authors.
     * 
     * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     * 
     *      http://www.mozilla.org/MPL/MPL-1.1.html
     * 
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */
    
    /**
     * @author Francis Bourre
     * @version 1.0
     */
    import flash.events.Event;
    
    import com.bourre.events.EventBroadcaster;
    import com.bourre.events.StringEvent;
    import com.bourre.log.PixlibStringifier;
    import com.bourre.plugin.NullPlugin;
    import com.bourre.plugin.Plugin;
    import com.bourre.plugin.PluginDebug;    

    public class AbstractModel 
    {
        public static const onInitModelEVENT     : String = "onInitModel";
        public static const onReleaseModelEVENT : String = "onReleaseModel";
        
        protected var _oEB         : EventBroadcaster;
        protected var _sName     : String;
        protected var _owner     : Plugin;
        
        public function AbstractModel( owner : Plugin = null, name : String = null ) 
        {
            _oEB = new EventBroadcaster( this );
            
            setOwner( owner );
            if ( name ) setName( name );
        }
        
        public function setListenerType( type : Class ) : void
        {
            _oEB.setListenerType(type);
        }

        public function handleEvent( e : Event ) : void
        {
            
        }
        
        protected function onInitModel() : void
        {
            notifyChanged( new StringEvent( AbstractModel.onInitModelEVENT, this, getName() ) );
        }
        
        protected function onReleaseModel() : void
        {
            notifyChanged( new StringEvent( AbstractModel.onReleaseModelEVENT, this, getName() ) );
        }
        
        public function setName( name : String ) : void
        {
            var ml : ModelLocator = ModelLocator.getInstance( getOwner() );
            
            if ( !( ml.isRegistered( name ) ) )
            {
                if ( getName() != null && ml.isRegistered( getName() ) ) ml.unregister( getName() );
                if ( ml.register( name, this ) ) _sName = name;
                
            } else
            {
                getLogger().error( this + ".setName() failed. '" + name + "' is already registered in ModelLocator." );
            }
        }
        
        public function getOwner() : Plugin
        {
            return _owner;
        }
        
        public function setOwner( owner : Plugin ) : void
        {
            _owner = owner ? owner : NullPlugin.getInstance();
        }
        
        public function getLogger() : PluginDebug
        {
            return PluginDebug.getInstance( getOwner() );
        }
        
        public function notifyChanged( e : Event ) : void
        {
            getBroadcaster().broadcastEvent( e );
        }
        
        public function getName() : String
        {
            return _sName;
        }
        
        public function release() : void
        {
            getBroadcaster().removeAllListeners();
            ModelLocator.getInstance( getOwner() ).unregister( getName() );

            onReleaseModel();

            _sName = null;
        }
    
        public function addListener( listener : ModelListener ) : Boolean
        {
            return _oEB.addListener( listener );
        }

        public function removeListener( listener : ModelListener ) : Boolean
        {
            return _oEB.removeListener( listener );
        }
        
        public function addEventListener( type : String, listener : Object, ... rest ) : Boolean
        {
            return _oEB.addEventListener.apply( _oEB, rest.length > 0 ? [ type, listener ].concat( rest ) : [ type, listener ] );
        }
        
        public function removeEventListener( type : String, listener : Object ) : Boolean
        {
            return _oEB.removeEventListener( type, listener );
        }
        
        //
        protected function getBroadcaster() : EventBroadcaster
        {
            return _oEB;
        }

        /**
         * Returns the string representation of this instance.
         * @return the string representation of this instance
         */
        public function toString() : String 
        {
            return PixlibStringifier.stringify( this );
        }
    }
}

Summary

Constructor

AbstractModel (owner:Plugin = null, name:String = null)

Instance methods

setListenerType (type:Class) : void
handleEvent (e:Event) : void
setName (name:String) : void
getOwner : Plugin
setOwner (owner:Plugin) : void
getLogger : PluginDebug
notifyChanged (e:Event) : void
getName : String
release : void
addListener (listener:ModelListener) : Boolean
removeListener (listener:ModelListener) : Boolean
addEventListener (type:String, listener:Object, rest) : Boolean
removeEventListener (type:String, listener:Object) : Boolean
toString : String
- Returns the string representation of this instance.

Event handlers

onInitModelEVENT : String
onReleaseModelEVENT : String

Constructor

AbstractModel

public function AbstractModel (

owner:Plugin = null, name:String = null)

Instance methods

addEventListener

public function addEventListener (

type:String, listener:Object, rest) : Boolean

addListener

public function addListener (

listener:ModelListener) : Boolean

getLogger

public function getLogger (

) : PluginDebug

getName

public function getName (

) : String

getOwner

public function getOwner (

) : Plugin

handleEvent

public function handleEvent (

e:Event) : void

notifyChanged

public function notifyChanged (

e:Event) : void

release

public function release (

) : void

removeEventListener

public function removeEventListener (

type:String, listener:Object) : Boolean

removeListener

public function removeListener (

listener:ModelListener) : Boolean

setListenerType

public function setListenerType (

type:Class) : void

setName

public function setName (

name:String) : void

setOwner

public function setOwner (

owner:Plugin) : void

toString

public function toString (

) : String

Returns the string representation of this instance.

Returns:

the string representation of this instance

Event handlers

onInitModelEVENT

public static const onInitModelEVENT:String = "onInitModel"

(read)

onReleaseModelEVENT

public static const onReleaseModelEVENT:String = "onReleaseModel"

(read)