puremvc-as3 2.0.4

data/2.0.4/src/org/puremvc/as3/interfaces/ICommand.as

@@ -0,0 +1,21 @@
+/*
+ PureMVC - Copyright(c) 2006-08 Futurescale, Inc., Some rights reserved.
+ Your reuse is governed by the Creative Commons Attribution 3.0 United States License
+*/
+package org.puremvc.as3.interfaces
+{
+	/**
+	 * The interface definition for a PureMVC Command.
+	 *
+	 * @see org.puremvc.as3.interfaces INotification
+	 */
+	public interface ICommand
+	{
+		/**
+		 * Execute the <code>ICommand</code>'s logic to handle a given <code>INotification</code>.
+		 * 
+		 * @param note an <code>INotification</code> to handle.
+		 */
+		function execute( notification:INotification ) : void;
+	}
+}

data/2.0.4/src/org/puremvc/as3/interfaces/IController.as

@@ -0,0 +1,64 @@
+/*
+ PureMVC - Copyright(c) 2006-08 Futurescale, Inc., Some rights reserved.
+ Your reuse is governed by the Creative Commons Attribution 3.0 United States License
+*/
+package org.puremvc.as3.interfaces
+{
+	/**
+	 * The interface definition for a PureMVC Controller.
+	 * 
+	 * <P>
+	 * In PureMVC, an <code>IController</code> implementor 
+	 * follows the 'Command and Controller' strategy, and 
+	 * assumes these responsibilities:
+	 * <UL>
+	 * <LI> Remembering which <code>ICommand</code>s 
+	 * are intended to handle which <code>INotifications</code>.</LI>
+	 * <LI> Registering itself as an <code>IObserver</code> with
+	 * the <code>View</code> for each <code>INotification</code> 
+	 * that it has an <code>ICommand</code> mapping for.</LI>
+	 * <LI> Creating a new instance of the proper <code>ICommand</code>
+	 * to handle a given <code>INotification</code> when notified by the <code>View</code>.</LI>
+	 * <LI> Calling the <code>ICommand</code>'s <code>execute</code>
+	 * method, passing in the <code>INotification</code>.</LI> 
+	 * </UL>
+	 *
+	 * @see org.puremvc.as3.interfaces INotification
+	 * @see org.puremvc.as3.interfaces ICommand
+	 */
+	public interface IController
+	{
+
+		/**
+		 * Register a particular <code>ICommand</code> class as the handler 
+		 * for a particular <code>INotification</code>.
+		 * 
+		 * @param notificationName the name of the <code>INotification</code>
+		 * @param commandClassRef the Class of the <code>ICommand</code>
+		 */
+		function registerCommand( notificationName : String, commandClassRef : Class ) : void;
+		
+		/**
+		 * Execute the <code>ICommand</code> previously registered as the
+		 * handler for <code>INotification</code>s with the given notification name.
+		 * 
+		 * @param notification the <code>INotification</code> to execute the associated <code>ICommand</code> for
+		 */
+		function executeCommand( notification : INotification ) : void;
+
+		/**
+		 * Remove a previously registered <code>ICommand</code> to <code>INotification</code> mapping.
+		 * 
+		 * @param notificationName the name of the <code>INotification</code> to remove the <code>ICommand</code> mapping for
+		 */
+		function removeCommand( notificationName : String ):void;
+
+		/**
+		 * Check if a Command is registered for a given Notification 
+		 * 
+		 * @param notificationName
+		 * @return whether a Command is currently registered for the given <code>notificationName</code>.
+		 */
+		function hasCommand( notificationName:String ) : Boolean;
+	}
+}

data/2.0.4/src/org/puremvc/as3/interfaces/IFacade.as

@@ -0,0 +1,131 @@
+/*
+ PureMVC - Copyright(c) 2006-08 Futurescale, Inc., Some rights reserved.
+ Your reuse is governed by the Creative Commons Attribution 3.0 United States License
+*/
+package org.puremvc.as3.interfaces
+{
+
+	/**
+	 * The interface definition for a PureMVC Facade.
+	 *
+	 * <P>
+	 * The Facade Pattern suggests providing a single
+	 * class to act as a central point of communication 
+	 * for a subsystem. </P>
+	 * 
+	 * <P>
+	 * In PureMVC, the Facade acts as an interface between
+	 * the core MVC actors (Model, View, Controller) and
+	 * the rest of your application.</P>
+	 * 
+	 * @see org.puremvc.as3.interfaces.IModel IModel
+	 * @see org.puremvc.as3.interfaces.IView IView
+	 * @see org.puremvc.as3.interfaces.IController IController
+	 * @see org.puremvc.as3.interfaces.ICommand ICommand
+	 * @see org.puremvc.as3.interfaces.INotification INotification
+	 */
+	public interface IFacade extends INotifier
+	{
+
+		/**
+		 * Register an <code>IProxy</code> with the <code>Model</code> by name.
+		 * 
+		 * @param proxy the <code>IProxy</code> to be registered with the <code>Model</code>.
+		 */
+		function registerProxy( proxy:IProxy ) : void;
+
+		/**
+		 * Retrieve a <code>IProxy</code> from the <code>Model</code> by name.
+		 * 
+		 * @param proxyName the name of the <code>IProxy</code> instance to be retrieved.
+		 * @return the <code>IProxy</code> previously regisetered by <code>proxyName</code> with the <code>Model</code>.
+		 */
+		function retrieveProxy( proxyName:String ) : IProxy;
+		
+		/**
+		 * Remove an <code>IProxy</code> instance from the <code>Model</code> by name.
+		 *
+		 * @param proxyName the <code>IProxy</code> to remove from the <code>Model</code>.
+		 * @return the <code>IProxy</code> that was removed from the <code>Model</code>
+		 */
+		function removeProxy( proxyName:String ) : IProxy;
+
+		/**
+		 * Check if a Proxy is registered
+		 * 
+		 * @param proxyName
+		 * @return whether a Proxy is currently registered with the given <code>proxyName</code>.
+		 */
+		function hasProxy( proxyName:String ) : Boolean;
+
+		/**
+		 * Register an <code>ICommand</code> with the <code>Controller</code>.
+		 * 
+		 * @param noteName the name of the <code>INotification</code> to associate the <code>ICommand</code> with.
+		 * @param commandClassRef a reference to the <code>Class</code> of the <code>ICommand</code>.
+		 */
+		function registerCommand( noteName : String, commandClassRef : Class ) : void;
+		
+		/**
+		 * Remove a previously registered <code>ICommand</code> to <code>INotification</code> mapping from the Controller.
+		 * 
+		 * @param notificationName the name of the <code>INotification</code> to remove the <code>ICommand</code> mapping for
+		 */
+		function removeCommand( notificationName:String ): void;
+
+		/**
+		 * Check if a Command is registered for a given Notification 
+		 * 
+		 * @param notificationName
+		 * @return whether a Command is currently registered for the given <code>notificationName</code>.
+		 */
+		function hasCommand( notificationName:String ) : Boolean;
+		
+		/**
+		 * Register an <code>IMediator</code> instance with the <code>View</code>.
+		 * 
+		 * @param mediator a reference to the <code>IMediator</code> instance
+		 */
+		function registerMediator( mediator:IMediator ) : void;
+
+		/**
+		 * Retrieve an <code>IMediator</code> instance from the <code>View</code>.
+		 * 
+		 * @param mediatorName the name of the <code>IMediator</code> instance to retrievve
+		 * @return the <code>IMediator</code> previously registered with the given <code>mediatorName</code>.
+		 */
+		function retrieveMediator( mediatorName:String ) : IMediator;
+
+		/**
+		 * Remove a <code>IMediator</code> instance from the <code>View</code>.
+		 * 
+		 * @param mediatorName name of the <code>IMediator</code> instance to be removed.
+		 * @return the <code>IMediator</code> instance previously registered with the given <code>mediatorName</code>.
+		 */
+		function removeMediator( mediatorName:String ) : IMediator;
+		
+		/**
+		 * Check if a Mediator is registered or not
+		 * 
+		 * @param mediatorName
+		 * @return whether a Mediator is registered with the given <code>mediatorName</code>.
+		 */
+		function hasMediator( mediatorName:String ) : Boolean;
+
+		/**
+		 * Notify the <code>IObservers</code> for a particular <code>INotification</code>.
+		 * 
+		 * <P>
+		 * All previously attached <code>IObservers</code> for this <code>INotification</code>'s
+		 * list are notified and are passed a reference to the <code>INotification</code> in 
+		 * the order in which they were registered.</P>
+		 * <P>
+		 * NOTE: Use this method only if you are sending custom Notifications. Otherwise
+		 * use the sendNotification method which does not require you to create the
+		 * Notification instance.</P> 
+		 * 
+		 * @param notification the <code>INotification</code> to notify <code>IObservers</code> of.
+		 */
+		function notifyObservers( note:INotification ) : void;
+	}
+}

data/2.0.4/src/org/puremvc/as3/interfaces/IMediator.as

@@ -0,0 +1,150 @@
+/*
+ PureMVC - Copyright(c) 2006-08 Futurescale, Inc., Some rights reserved.
+ Your reuse is governed by the Creative Commons Attribution 3.0 United States License
+*/
+package org.puremvc.as3.interfaces
+{
+	
+	/**
+	 * The interface definition for a PureMVC Mediator.
+	 *
+	 * <P>
+	 * In PureMVC, <code>IMediator</code> implementors assume these responsibilities:</P>
+	 * <UL>
+	 * <LI>Implement a common method which returns a list of all <code>INotification</code>s 
+	 * the <code>IMediator</code> has interest in.</LI>
+	 * <LI>Implement a notification callback method.</LI>
+	 * <LI>Implement methods that are called when the IMediator is registered or removed from the View.</LI>
+	 * </UL>
+	 * <P>
+	 * Additionally, <code>IMediator</code>s typically:
+	 * <UL>
+	 * <LI>Act as an intermediary between one or more view components such as text boxes or 
+	 * list controls, maintaining references and coordinating their behavior.</LI>
+	 * <LI>In Flash-based apps, this is often the place where event listeners are
+	 * added to view components, and their handlers implemented.</LI>
+	 * <LI>Respond to and generate <code>INotifications</code>, interacting with of 
+	 * the rest of the PureMVC app.
+	 * </UL></P>
+	 * <P>
+	 * When an <code>IMediator</code> is registered with the <code>IView</code>, 
+	 * the <code>IView</code> will call the <code>IMediator</code>'s 
+	 * <code>listNotificationInterests</code> method. The <code>IMediator</code> will 
+	 * return an <code>Array</code> of <code>INotification</code> names which 
+	 * it wishes to be notified about.</P>
+	 * 
+	 * <P>
+	 * The <code>IView</code> will then create an <code>Observer</code> object 
+	 * encapsulating that <code>IMediator</code>'s (<code>handleNotification</code>) method
+	 * and register it as an Observer for each <code>INotification</code> name returned by 
+	 * <code>listNotificationInterests</code>.</P>
+	 * 
+	 * <P>
+	 * A concrete IMediator implementor usually looks something like this:</P>
+	 * 
+	 * <listing>
+	 *	import org.puremvc.as3.patterns.mediator.~~;
+	 *	import org.puremvc.as3.patterns.observer.~~;
+	 *	import org.puremvc.as3.core.view.~~;
+	 * 
+	 *	import com.me.myapp.model.~~;
+	 *	import com.me.myapp.view.~~;
+	 *	import com.me.myapp.controller.~~;
+	 * 		
+	 *	import mx.controls.ComboBox;
+	 *	import mx.events.ListEvent;
+	 * 
+	 * public class MyMediator extends Mediator implements IMediator {
+	 * 
+	 * 		public function MyComboMediator( viewComponent:Object ) {
+	 * 			super( viewComponent );
+	 * 			combo.addEventListener( Event.CHANGE, onChange );
+	 * 		}
+	 * 		
+	 * 		override public function listNotificationInterests():Array {
+	 * 				return [ MyFacade.SET_SELECTION, 
+	 * 						 MyFacade.SET_DATAPROVIDER ];
+	 * 		}
+	 * 
+	 * 		override public function handleNotification( notification:INotification ):void {
+	 * 				switch ( notification.getName() ) {
+	 * 					case MyFacade.SET_SELECTION:
+	 * 						setSelection(notification);
+	 * 						break;
+	 * 					case MyFacade.SET_DATAPROVIDER:
+	 * 						setDataProvider(notification);
+	 * 						break;
+	 * 				}
+	 * 		}
+	 * 
+	 * 		// Set the data provider of the combo box
+	 * 		protected function setDataProvider( notification:INotification ):void {
+	 * 			combo.dataProvider = notification.getBody() as Array;
+	 * 		}
+	 * 
+	 * 		// Invoked when the combo box dispatches a change event, we send a
+	 *      // notification with the
+	 * 		protected function onChange(event:ListEvent):void {
+	 * 			sendNotification( MyFacade.MYCOMBO_CHANGED, this );
+	 * 		}
+	 * 
+	 * 		// A private getter for accessing the view object by class
+	 *      protected function get combo():ComboBox  {
+	 *         return view as ComboBox;
+	 *      }
+	 * 
+	 * }
+	 * </listing>
+	 * 
+	 * @see org.puremvc.as3.interfaces.INotification INotification
+	 */
+	public interface IMediator
+	{
+		
+		/**
+		 * Get the <code>IMediator</code> instance name
+		 * 
+		 * @return the <code>IMediator</code> instance name
+		 */
+		function getMediatorName():String;
+		
+		/**
+		 * Get the <code>IMediator</code>'s view component.
+		 * 
+		 * @return Object the view component
+		 */
+		function getViewComponent():Object;
+
+		/**
+		 * Set the <code>IMediator</code>'s view component.
+		 * 
+		 * @param Object the view component
+		 */
+		function setViewComponent( viewComponent:Object ):void;
+		
+		/**
+		 * List <code>INotification</code> interests.
+		 * 
+		 * @return an <code>Array</code> of the <code>INotification</code> names this <code>IMediator</code> has an interest in.
+		 */
+		function listNotificationInterests( ):Array;
+		
+		/**
+		 * Handle an <code>INotification</code>.
+		 * 
+		 * @param notification the <code>INotification</code> to be handled
+		 */
+		function handleNotification( notification:INotification ):void;
+		
+		/**
+		 * Called by the View when the Mediator is registered
+		 */ 
+		function onRegister( ):void;
+
+		/**
+		 * Called by the View when the Mediator is removed
+		 */ 
+		function onRemove( ):void;
+		
+	}
+}

data/2.0.4/src/org/puremvc/as3/interfaces/IModel.as

@@ -0,0 +1,57 @@
+/*
+ PureMVC - Copyright(c) 2006-08 Futurescale, Inc., Some rights reserved.
+ Your reuse is governed by the Creative Commons Attribution 3.0 United States License
+*/
+package org.puremvc.as3.interfaces
+{
+	/**
+	 * The interface definition for a PureMVC Model.
+	 * 
+	 * <P>
+	 * In PureMVC, <code>IModel</code> implementors provide
+	 * access to <code>IProxy</code> objects by named lookup. </P>
+	 * 
+	 * <P>
+	 * An <code>IModel</code> assumes these responsibilities:</P>
+	 * 
+	 * <UL>
+	 * <LI>Maintain a cache of <code>IProxy</code> instances</LI>
+	 * <LI>Provide methods for registering, retrieving, and removing <code>IProxy</code> instances</LI>
+	 * </UL>
+	 */
+	public interface IModel 
+	{
+		/**
+		 * Register an <code>IProxy</code> instance with the <code>Model</code>.
+		 * 
+		 * @param proxyName the name to associate with this <code>IProxy</code> instance.
+		 * @param proxy an object reference to be held by the <code>Model</code>.
+		 */
+		function registerProxy( proxy:IProxy ) : void;
+
+		/**
+		 * Retrieve an <code>IProxy</code> instance from the Model.
+		 * 
+		 * @param proxyName
+		 * @return the <code>IProxy</code> instance previously registered with the given <code>proxyName</code>.
+		 */
+		function retrieveProxy( proxyName:String ) : IProxy;
+
+		/**
+		 * Remove an <code>IProxy</code> instance from the Model.
+		 * 
+		 * @param proxyName name of the <code>IProxy</code> instance to be removed.
+		 * @return the <code>IProxy</code> that was removed from the <code>Model</code>
+		 */
+		function removeProxy( proxyName:String ) : IProxy;
+
+		/**
+		 * Check if a Proxy is registered
+		 * 
+		 * @param proxyName
+		 * @return whether a Proxy is currently registered with the given <code>proxyName</code>.
+		 */
+		function hasProxy( proxyName:String ) : Boolean;
+
+	}
+}

data/2.0.4/src/org/puremvc/as3/interfaces/INotification.as

@@ -0,0 +1,76 @@
+/*
+ PureMVC - Copyright(c) 2006-08 Futurescale, Inc., Some rights reserved.
+ Your reuse is governed by the Creative Commons Attribution 3.0 United States License
+*/
+package org.puremvc.as3.interfaces
+{
+	/**
+	 * The interface definition for a PureMVC Notification.
+	 *
+	 * <P>
+	 * PureMVC does not rely upon underlying event models such 
+	 * as the one provided with Flash, and ActionScript 3 does 
+	 * not have an inherent event model.</P>
+	 * 
+	 * <P>
+	 * The Observer Pattern as implemented within PureMVC exists 
+	 * to support event-driven communication between the 
+	 * application and the actors of the MVC triad.</P>
+	 * 
+	 * <P>
+	 * Notifications are not meant to be a replacement for Events
+	 * in Flex/Flash/AIR. Generally, <code>IMediator</code> implementors
+	 * place event listeners on their view components, which they
+	 * then handle in the usual way. This may lead to the broadcast of <code>Notification</code>s to 
+	 * trigger <code>ICommand</code>s or to communicate with other <code>IMediators</code>. <code>IProxy</code> and <code>ICommand</code>
+	 * instances communicate with each other and <code>IMediator</code>s 
+	 * by broadcasting <code>INotification</code>s.</P>
+	 * 
+	 * <P>
+	 * A key difference between Flash <code>Event</code>s and PureMVC 
+	 * <code>Notification</code>s is that <code>Event</code>s follow the 
+	 * 'Chain of Responsibility' pattern, 'bubbling' up the display hierarchy 
+	 * until some parent component handles the <code>Event</code>, while
+	 * PureMVC <code>Notification</code>s follow a 'Publish/Subscribe'
+	 * pattern. PureMVC classes need not be related to each other in a 
+	 * parent/child relationship in order to communicate with one another
+	 * using <code>Notification</code>s.
+	 * 
+	 * @see org.puremvc.as3.interfaces.IView IView
+	 * @see org.puremvc.as3.interfaces.IObserver IObserver
+	 */
+	public interface INotification
+	{
+		
+		/**
+		 * Get the name of the <code>INotification</code> instance. 
+		 * No setter, should be set by constructor only
+		 */
+		function getName():String;
+
+		/**
+		 * Set the body of the <code>INotification</code> instance
+		 */
+		function setBody( body:Object ):void;
+		
+		/**
+		 * Get the body of the <code>INotification</code> instance
+		 */
+		function getBody():Object;
+		
+		/**
+		 * Set the type of the <code>INotification</code> instance
+		 */
+		function setType( type:String ):void;
+		
+		/**
+		 * Get the type of the <code>INotification</code> instance
+		 */
+		function getType():String;
+
+		/**
+		 * Get the string representation of the <code>INotification</code> instance
+		 */
+		function toString():String;
+	}
+}