+Show TOC
×Hide TOC

Plugin

Kind of class:	public interface
Package:	com.bourre.plugin
Inherits from:	none
Implemented by:	AbstractPlugin NullPlugin
Classpath:	com.bourre.plugin.Plugin
File last modified:	Tuesday, 29 April 2008, 10:48:07

► View source

▼ Hide source

package com.bourre.plugin
{
    /*
     * 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.commands.FrontController;
    import com.bourre.events.EventChannel;
    import com.bourre.model.AbstractModel;
    import com.bourre.view.AbstractView;    

    public interface Plugin 
    {
        function fireExternalEvent( e : Event, channel : EventChannel ) : void;
        function firePublicEvent( e : Event ) : void;
        function firePrivateEvent( e : Event ) : void;

        function getChannel() : EventChannel;
        function getLogger() : PluginDebug;
        
        function getModel( key : String ) : AbstractModel;
        function getView( key : String ) : AbstractView;
        function isModelRegistered( name : String ) : Boolean;
        function isViewRegistered( name : String ) : Boolean;
    }
}

Summary

Instance methods

fireExternalEvent (e:Event, channel:EventChannel) : void
firePublicEvent (e:Event) : void
firePrivateEvent (e:Event) : void
getChannel : EventChannel
getLogger : PluginDebug
getModel (key:String) : AbstractModel
getView (key:String) : AbstractView
isModelRegistered (name:String) : Boolean
isViewRegistered (name:String) : Boolean

Instance methods

fireExternalEvent

public function fireExternalEvent (

e:Event, channel:EventChannel) : void

firePrivateEvent

public function firePrivateEvent (

e:Event) : void

firePublicEvent

public function firePublicEvent (

e:Event) : void

getChannel

public function getChannel (

) : EventChannel

getLogger

public function getLogger (

) : PluginDebug

getModel

public function getModel (

key:String) : AbstractModel

getView

public function getView (

key:String) : AbstractView

isModelRegistered

public function isModelRegistered (

name:String) : Boolean

isViewRegistered

public function isViewRegistered (

name:String) : Boolean