Commit for v0.3

Major update. A list of changes which have been made since the last commit will be included shortly.

src/airdock/config/ContainerConfig.as

@@ -4,7 +4,7 @@ package airdock.config
 	 * Base configuration class for creating a container.
 	 * The width and height parameters are the minimum required parameters for creating the container; 
 	 * additional parameters can be added for extra customizability.
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class ContainerConfig extends Object
 	{

src/airdock/config/DockConfig.as

@@ -11,7 +11,7 @@ package airdock.config
 	import flash.display.NativeWindowInitOptions;
 	/**
 	 * Base configuration class for creating a Docker instance.
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class DockConfig extends Object
 	{

src/airdock/config/PanelConfig.as

@@ -3,7 +3,7 @@ package airdock.config
 	/**
 	 * Base configuration class for creating a panel. 
 	 * Extra attributes can be added for customizability, subject to the instance of the PanelFactory used by the Docker.
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class PanelConfig extends Object
 	{

src/airdock/delegates/DockHelperDelegate.as

@@ -11,9 +11,10 @@ package airdock.delegates
 	import flash.events.IEventDispatcher;
 	import flash.events.NativeDragEvent;
 	import flash.utils.Dictionary;
+
 	/**
 	 * ...
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class DockHelperDelegate implements IEventDispatcher
 	{
@@ -35,7 +36,8 @@ package airdock.delegates
 
 		/**
 		 * Adds the targets specified to the list of all dock helper candidates/targets.
-		 * Each target is a key-value pair with the key as the target displayObject and the value as the side which it represents, or the side that a container or panel will be attached to when dropped on that target.
+		 * Each target is a key-value pair with the key as the target displayObject and the value as the side it represents.
+		 * In other words, the value is the side that a container or panel will be attached to when dropped on that target.
 		 * @param	targets	A Vector of key-value pairs with the key as the target displayObject and the value as the side which it represents.
 		 * @see	airdock.util.IPair
 		 */

src/airdock/delegates/PanelDelegate.as

@@ -1,22 +1,25 @@
 package airdock.delegates 
 {
 	import airdock.events.PanelPropertyChangeEvent;
+	import airdock.interfaces.display.IDisplayFilter;
 	import airdock.interfaces.docking.IPanel;
+	import flash.display.DisplayObject;
 	import flash.events.Event;
 	import flash.events.IEventDispatcher;
 
 	/**
 	 * ...
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class PanelDelegate implements IEventDispatcher
 	{
 		private var b_dockable:Boolean;
 		private var b_resizable:Boolean;
+		private var cl_basePanel:IPanel;
 		private var str_panelName:String;
-		private var cl_dispatcher:IEventDispatcher
+		private var vec_displayFilters:Vector.<IDisplayFilter>;
 		public function PanelDelegate(panel:IPanel) {
-			cl_dispatcher = panel;
+			cl_basePanel = panel;
 		}
 
 		public function dispatchChanging(property:String, oldValue:Object, newValue:Object):Boolean {
@@ -28,23 +31,23 @@ package airdock.delegates
 		}
 
 		public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void {
-			cl_dispatcher.addEventListener(type, listener, useCapture, priority, useWeakReference);
+			cl_basePanel.addEventListener(type, listener, useCapture, priority, useWeakReference);
 		}
 
 		public function dispatchEvent(event:Event):Boolean {
-			return cl_dispatcher.dispatchEvent(event);
+			return cl_basePanel.dispatchEvent(event);
 		}
 
 		public function hasEventListener(type:String):Boolean {
-			return cl_dispatcher.hasEventListener(type);
+			return cl_basePanel.hasEventListener(type);
 		}
 
 		public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void {
-			cl_dispatcher.removeEventListener(type, listener, useCapture);
+			cl_basePanel.removeEventListener(type, listener, useCapture);
 		}
 
 		public function willTrigger(type:String):Boolean {
-			return cl_dispatcher.willTrigger(type);
+			return cl_basePanel.willTrigger(type);
 		}
 
 		public function get panelName():String 
@@ -87,6 +90,23 @@ package airdock.delegates
 				dispatchChanged("dockable", !value, value)
 			}
 		}
+
+		public function get displayFilters():Vector.<IDisplayFilter> {
+			return vec_displayFilters && vec_displayFilters.concat();
+		}
+
+		public function set displayFilters(value:Vector.<IDisplayFilter>):void
+		{
+			var i:int;
+			var filters:Vector.<IDisplayFilter> = vec_displayFilters
+			for (i = int(filters && filters.length) - 1; i >= 0; --i) {
+				filters[i].remove(cl_basePanel);
+			}
+			vec_displayFilters = value.concat();
+			for (i = int(value && value.length) - 1; i >= 0; --i) {
+				value[i].apply(cl_basePanel);
+			}
+		}
 	}
 
 }

src/airdock/delegates/PanelListDelegate.as

@@ -8,7 +8,7 @@ package airdock.delegates
 	import flash.events.IEventDispatcher;
 	/**
 	 * ...
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class PanelListDelegate implements IEventDispatcher
 	{
@@ -41,13 +41,31 @@ package airdock.delegates
 		}
 
 		public function requestShow(panel:IPanel):Boolean {
-			return panel && dispatchEvent(new PanelContainerEvent(PanelContainerEvent.SHOW_REQUESTED, panel, null, false, true))
+			return panel && dispatchEvent(new PanelContainerEvent(PanelContainerEvent.SHOW_REQUESTED, panel, null, true, true))
 		}
 
+		/**
+		 * Requests the panelList's container to start a drag-dock operation for the given panel.
+		 * If no panel is supplied (i.e. a null panel) then the drag-dock operation is started for the entire container.
+		 * @param	panel	An (optional) IPanel instance which is to take part in a drag-dock operation.
+		 * 					A null IPanel instance indicates the entire container should take part in the drag-dock operation.
+		 * @return	A Boolean indicating whether the operation was a success. If the event was prevented via preventDefault(), false is returned.
+		 */
 		public function requestDrag(panel:IPanel):Boolean {
 			return dispatchEvent(new PanelContainerEvent(PanelContainerEvent.DRAG_REQUESTED, panel, null, true, true))
 		}
 
+		public function requestRemove(panel:IPanel):Boolean {
+			return panel && dispatchEvent(new PanelContainerEvent(PanelContainerEvent.PANEL_REMOVE_REQUESTED, panel, null, true, true))
+		}
+
+		/**
+		 * Requests the panelList's container to toggle the state (docked to integrated and vice versa) for the given panel
+		 * If no panel is supplied (i.e. a null panel) then the state toggle operation is applied to the entire container.
+		 * @param	panel	An (optional) IPanel instance whose state is to be toggled (from docked to integrated and vice versa)
+		 * 					A null IPanel instance indicates the state toggle operation is to be applied to the entire container.
+		 * @return	A Boolean indicating whether the operation was a success. If the event was prevented via preventDefault(), false is returned.
+		 */
 		public function requestStateToggle(panel:IPanel):Boolean {
 			return dispatchEvent(new PanelContainerEvent(PanelContainerEvent.STATE_TOGGLE_REQUESTED, panel, null, true, true))
 		}
@@ -61,7 +79,7 @@ package airdock.delegates
 			var result:IPanel;
 			var index:int = getPanelIndex(panel);
 			if(index != -1) {
-				result = removePanelAt(index)
+				result = removePanelAt(index);
 			}
 			return result;
 		}

src/airdock/delegates/ResizerDelegate.as

@@ -8,17 +8,19 @@ package airdock.delegates
 	import flash.geom.Rectangle;
 	/**
 	 * ...
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class ResizerDelegate 
 	{
 		private var i_sideCode:int;
 		private var b_dragging:Boolean;
+		private var rect_maxSize:Rectangle;
 		private var cl_dispatcher:IResizer;
 		private var plc_container:IContainer;
-		public function ResizerDelegate(resizer:IResizer) 
+		public function ResizerDelegate(resizer:IResizer)
 		{
-			cl_dispatcher = resizer
+			cl_dispatcher = resizer;
+			rect_maxSize = new Rectangle();
 		}
 
 		/**
@@ -85,6 +87,17 @@ package airdock.delegates
 			plc_container = value;
 		}
 
+		public function get maxSize():Rectangle {	//returns a reference because no public getter
+			return rect_maxSize						//in IResizer; only class that should modify this is
+		}											//the IResizer implementation
+
+		public function set maxSize(size:Rectangle):void 
+		{
+			if (size) {
+				rect_maxSize.copyFrom(size)
+			}
+		}
+
 	}
 
 }

src/airdock/enums/CrossDockingPolicy.as

@@ -6,7 +6,7 @@ package airdock.enums
 	 * * Outgoing - Attach to another container which is not originating from (i.e. has not been created by) its Docker
 	 * * Incoming - Have another panel or container, which is not originating from its Docker, be attached to it
 	 * * Both - allow or forbid both actions.
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public class CrossDockingPolicy 
 	{
@@ -16,16 +16,19 @@ package airdock.enums
 		 * panels from other Dockers can be attached to containers originating from the Docker with this policy.
 		 */
 		public static const UNRESTRICTED:int = 0;
+
 		/**
 		 * Prevents panels from the Docker with this policy from being attached to containers originating from other Dockers, regardless of their docking policies.
 		 */
 		public static const PREVENT_OUTGOING:int = 1;
+
 		/**
 		 * Prevents panels from other Dockers from being attached to containers originating from the Docker with this policy.
 		 * This has a higher priority than PREVENT_OUTGOING; in effect, if one Docker has the PREVENT_OUTGOING policy and the other has the REJECT_INCOMING policy,
 		 * then the second Docker will reject it before the first can prevent the action.
 		 */
 		public static const REJECT_INCOMING:int = 2;
+
 		/**
 		 * Alias for (PREVENT_OUTGOING | REJECT_INCOMIN);
 		 * in effect, prevents panels from other Dockers being attached to containers originating from the current Docker 

src/airdock/enums/DockDefaults.as

@@ -23,7 +23,7 @@ package airdock.enums
 
 	/**
 	 * The default settings for a Docker. It is advised to use this in order to meet most (basic) use cases.
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public final class DockDefaults 
 	{

src/airdock/enums/PanelContainerSide.as

@@ -4,26 +4,30 @@ package airdock.enums
 
 	/**
 	 * The enumeration class which dictates the sides to which containers attach to.
-	 * @author Gimmick
+	 * @author	Gimmick
 	 */
 	public final class PanelContainerSide
 	{
 		/**
 		 * Gets the current container.
 		 */
 		public static const FILL:int = 0;		//00000000
+
 		/**
 		 * Gets the left side of the current container. 
 		 */
 		public static const LEFT:int = 1;		//00000001
+
 		/**
 		 * Gets the right side of the current container. 
 		 */
 		public static const RIGHT:int = 3;		//00000011
+
 		/**
 		 * Gets the top side of the current container. 
 		 */
 		public static const TOP:int = 4;		//00000100
+
 		/**
 		 * Gets the bottom side of the current container. 
 		 */
@@ -33,18 +37,22 @@ package airdock.enums
 		 * String representation of FILL.
 		 */
 		public static const STRING_FILL:String = "F";
+
 		/**
 		 * String representation of LEFT.
 		 */
 		public static const STRING_LEFT:String = "L"
+
 		/**
 		 * String representation of RIGHT.
 		 */
 		public static const STRING_RIGHT:String = "R";
+
 		/**
 		 * String representation of TOP.
 		 */
 		public static const STRING_TOP:String = "T";
+
 		/**
 		 * String representation of BOTTOM.
 		 */
@@ -125,6 +133,7 @@ package airdock.enums
 
 		/**
 		 * Convert a side, in string format, to an integer. Invalid values return FILL, by default.
+		 * Does not convert multiple side codes; only a single side code at a time is supported.
 		 * @param	side	The side to get the integer representation of, as a string.
 		 * @return	The integer representation of the side, as listed in this enumeration.
 		 */
@@ -186,29 +195,28 @@ package airdock.enums
 			if(!side) {
 				return null;
 			}
-			else if (side.length > 1)
+			else
 			{
 				var complementary:String = "";
-				for (var i:uint = 0; i < side.length; ++i) {
-					complementary += getComplementaryString(side.charAt(i));
+				for (var i:uint = 0; i < side.length; ++i)
+				{
+					switch(side.charAt(i))
+					{
+						case STRING_LEFT:
+							complementary += STRING_RIGHT;
+						case STRING_RIGHT:
+							complementary += STRING_LEFT;
+						case STRING_TOP:
+							complementary += STRING_BOTTOM;
+						case STRING_BOTTOM:
+							complementary += STRING_TOP;
+						case STRING_FILL:
+						default:
+							complementary += STRING_FILL;	
+					}
 				}
 				return complementary
 			}
-
-			switch(side)
-			{
-				case STRING_LEFT:
-					return STRING_RIGHT;
-				case STRING_RIGHT:
-					return STRING_LEFT;
-				case STRING_TOP:
-					return STRING_BOTTOM;
-				case STRING_BOTTOM:
-					return STRING_TOP;
-				case STRING_FILL:
-				default:
-					return STRING_FILL;	
-			}
 		}
 
 		/**

src/airdock/enums/PanelContainerState.as

@@ -1,8 +1,16 @@
 package airdock.enums 
 {
 	/**
-	 * ...
-	 * @author Gimmick
+	 * Enumeration class indicating the possible states a panel or container can occupy.
+	 * Each panel or container is either integrated or docked, and visible or invisible.
+	 * 
+	 * An integrated panel (or container) is one belonging to a container whose root is not parked.
+	 * A docked panel (or container) is one belonging to a container whose root is a parked container.
+	 * 
+	 * A visible panel (or container) is that which is visible on the screen; a panel is visible if it belongs to a visible container.
+	 * A container is visible if it is either part of a visible integrated container, or if it is part of a parked container whose window is visible.
+	 * 
+	 * @author	Gimmick
 	 */
 	public final class PanelContainerState 
 	{