Archive for the tag 'class'

AS3: Environment

October 15, 2007 in AS3, My Classes | Show Some Love | | 1 Comment »

View Example
View Documentation
Download Class & Example Files

UPDATED 10/26/07
The Environment class has been re-versioned to 2.0. It is now a singleton which means you can only have one instance of it anywhere in your application. This is a cleaner approach. The code has changed only slightly as it has added a setPaths() method and obviously you now call everything through Environment.getInstance().

UPDATED 10/22/07
Version 1.1 adds a Boolean, isLive, that can be checked to see if the site is live or not and have other parts of your code react accordingly.

A small utility class that allows you to set debug and live path variable for local and remote testing without having to toggle anything. Made in conjunction with Josh Perez.

PLAIN TEXT
Actionscript:
  1. /**
  2. * A small utility class that allows you to set debug and live path variable for local and remote testing without having to toggle anything.
  3. *
  4. * @usage
  5. * <code>
  6. * <pre>
  7. import com.reintroducing.debug.Environment;
  9. var env:Environment = Environment.getInstance();
  10. env.setPaths("../", "");
  12. if (env.isLive)
  13. {
  14.     trace("The site is live!");
  15. }
  16. else
  17. {
  18.     trace("The site is being debugged locally");
  19. }
  21. var xmlURL:String = env.basePath + "xml/data.xml";
  22. * </pre>
  23. * </code>
  24. *
  25. * @author Joshua Perez [http://www.joshua-studios.com]
  26. * @author Matt Przybylski [http://www.reintroducing.com]
  27. * @version 2.0
  28. */
  29.  
  30. package com.reintroducing.debug
  31. {
  32.     import flash.system.Capabilities;
  33.    
  34.     public class Environment
  35.     {
  36. //- PRIVATE & PROTECTED VARIABLES -------------------------------------------------------------------------
  37.  
  38.         // singleton instance
  39.         private static var _instance:Environment;
  40.         private static var _allowInstance:Boolean;
  41.        
  42.         private var _debugPath:String;
  43.         private var _livePath:String;
  44.         private var _basePath:String;
  45.         private var _isLive:Boolean;
  46.        
  47. //- PUBLIC & INTERNAL VARIABLES ---------------------------------------------------------------------------
  48.        
  49.         public static const DEFAULT_NAME:String = "com.reintroducing.debug.Environment";
  50.        
  51. //- CONSTRUCTOR -------------------------------------------------------------------------------------------
  52.    
  53.         // singleton instance of Environment
  54.         public static function getInstance():Environment
  55.         {
  56.             if (Environment._instance == null)
  57.             {
  58.                 Environment._allowInstance = true;
  59.                 Environment._instance = new Environment();
  60.                 Environment._allowInstance = false;
  61.             }
  62.            
  63.             return Environment._instance;
  64.         }
  65.        
  66.         public function Environment()
  67.         {
  68.             if (!Environment._allowInstance)
  69.             {
  70.                 throw new Error("Error: Use Environment.getInstance() instead of the new keyword.");
  71.             }
  72.         }
  73.        
  74. //- PRIVATE & PROTECTED METHODS ---------------------------------------------------------------------------
  75.        
  76.         private function setProperPath():void
  77.         {
  78.             if (Capabilities.playerType == "PlugIn" || Capabilities.playerType == "ActiveX")
  79.             {
  80.                 this._basePath = this._livePath;
  81.                 this._isLive = true;
  82.             }
  83.             else
  84.             {
  85.                 this._basePath = this._debugPath;
  86.                 this._isLive = false;
  87.             }
  88.         }
  89.        
  90. //- PUBLIC & INTERNAL METHODS -----------------------------------------------------------------------------
  91.    
  92.         /**
  93.          * Sets the proper debug/live paths.
  94.          *
  95.          * @usage <pre><code>Environment.getInstance().setPaths("../", "");</code></pre>
  96.          *
  97.          * @param $debugPath A string representing the local (debug) path
  98.          * @param $livePath A string representing the remote (live) path
  99.          */
  100.        
  101.         public function setPaths($debugPath:String, $livePath:String):void
  102.         {
  103.             this._debugPath = $debugPath;
  104.             this._livePath = $livePath;
  105.            
  106.             this.setProperPath();
  107.         }
  108.    
  109. //- EVENT HANDLERS ----------------------------------------------------------------------------------------
  110.    
  111.        
  112.    
  113. //- GETTERS & SETTERS -------------------------------------------------------------------------------------
  114.    
  115.         /**
  116.          * Returns the basePath for use in loading assets.
  117.          *
  118.          * @usage <pre><code>var xmlURL:String = Environment.getInstance().basePath + "xml/data.xml";</code></pre>
  119.          *
  120.          * @return String
  121.          */
  122.        
  123.         public function get basePath():String
  124.         {
  125.             return this._basePath;
  126.         }
  127.        
  128.         /**
  129.          * Returns a Boolean value if the site is on a live server or being tested locally.
  130.          *
  131.          * @usage <pre><code>var siteLive:Boolean = Environment.getInstance().isLive;</code></pre>
  132.          *
  133.          * @return Boolean
  134.          */
  135.        
  136.         public function get isLive():Boolean
  137.         {
  138.             return this._isLive;
  139.         }
  140.    
  141. //- HELPERS -----------------------------------------------------------------------------------------------
  142.    
  143.         public function toString():String
  144.         {
  145.             return "com.reintroducing.debug.Environment";
  146.         }
  147.    
  148. //- END CLASS ---------------------------------------------------------------------------------------------
  149.     }
  150. }

Tags: , , , ,

AS2: MousePositionPanel

October 14, 2007 in AS2, My Classes | Show Some Love | | 5 Comments »

View Example
View Documentation
Download Class & Example Files

Creates a scrolling panel that allows for scrolling in the x or y axis depending on where the mouse pointer is within the panel.

PLAIN TEXT
Actionscript:
  1. /**
  2. * Creates a scrolling panel that allows for scrolling in the x or y axis depending on where the mouse pointer is within the panel.
  3. *
  4. * @usage
  5. * <code>
  6. * <pre>
  7. import com.reintroducing.ui.MousePositionPanel;
  9. var mpp:MousePositionPanel = new MousePositionPanel(holder_mc, holder_mc.content_mc, holder_mc.mask_mc, "x", "withMouse", 10);
  11. holder_mc.mask_mc.onRollOver = function():Void
  12. {
  13.     mpp.startPanel();
  14. };
  16. holder_mc.mask_mc.onRollOut = function():Void
  17. {
  18.     mpp.stopPanel();
  19. };
  20. * </pre>
  21. * </code>
  22. *
  23. * @author Matt Przybylski [http://www.reintroducing.com]
  24. * @version 1.0
  25. */
  26.  
  27. class com.reintroducing.ui.MousePositionPanel
  28. {
  29. //- PRIVATE VARIABLES -------------------------------------------------------------------------------------
  30.    
  31.     private var _holder:MovieClip;
  32.     private var _mc:MovieClip;
  33.     private var _mask:MovieClip;
  34.     private var _axis:String;
  35.     private var _moveType:String;
  36.     private var _moveDir:Number;
  37.     private var _mouseAxis:String;
  38.     private var _changeProp:String;
  39.     private var _speed:Number;
  40.     private var _end:Number;
  41.     
  42. //- PUBLIC VARIABLES --------------------------------------------------------------------------------------
  43.    
  44.     public static var DEFAULT_NAME:String = "com.reintroducing.ui.MousePositionPanel";
  45.    
  46. //- CONSTRUCTOR -------------------------------------------------------------------------------------------
  47.    
  48.     /**
  49.      * Creates a new instance of the MousePositionPanel class.
  50.      *
  51.      * @usage <pre><code>var mpp:MousePositionPanel = new MousePositionPanel($holder, $mc, $mask, $axis, $moveType, $speed);</code></pre>
  52.      *
  53.      * @param $holder The movie clip (or timeline) that holds the content and mask clips
  54.      * @param $mc The movie clip to be scrolled
  55.      * @param $mask The movie clip that is used as the mask for the scrollable content area
  56.      * @param $axis A string value of either "x" or "y" that determines what axis the content is scrolled along
  57.      * @param $moveType A string, "withMouse" (moves with the mouse) or "againstMouse" (moves away from the mouse)
  58.      * @param $speed A number that represents how fast to scroll the clip
  59.      */
  60.    
  61.     public function MousePositionPanel($holder:MovieClip, $mc:MovieClip, $mask:MovieClip, $axis:String, $moveType:String, $speed:Number)
  62.     {
  63.         this._holder                    = $holder;
  64.         this._mc                        = $mc;
  65.         this._mask            = $mask;
  66.         this._axis       = "_" + $axis;
  67.         this._moveType          = $moveType;
  68.         this._speed      = $speed;
  69.        
  70.         this.manageAxis(this._axis);
  71.         this.manageMoveType();
  72.     }
  73.    
  74. //- PRIVATE METHODS ---------------------------------------------------------------------------------------
  75.    
  76.     private function manageAxis($axis:String):Void
  77.     {
  78.         if ($axis == "_x")
  79.         {
  80.             this._changeProp          = "_width";
  81.             this._mouseAxis             = "_xmouse";
  82.         }
  83.         else if ($axis == "_y")
  84.         {
  85.             this._changeProp          = "_height";
  86.             this._mouseAxis             = "_ymouse";
  87.         }
  88.     }
  89.    
  90.     private function manageMoveType():Void
  91.     {
  92.         if (this._moveType == "withMouse")
  93.         {
  94.             this._moveDir = 1;
  95.         }
  96.         else if (this._moveType == "againstMouse")
  97.         {
  98.             this._moveDir = -1;
  99.         }
  100.         else
  101.         {
  102.             this._moveDir = 1;
  103.         }
  104.     }
  105.    
  106.     private function movePanel(dir:Number):Void
  107.     {
  108.         var owner:MousePositionPanel = this;
  109.         var mousePercent:Number = (this._holder[this._mouseAxis] / this._mask[this._changeProp]);
  110.         var mSpeed:Number;
  111.        
  112.         if (dir == 1)
  113.         {
  114.             mSpeed = 1 - mousePercent;
  115.         }
  116.         else
  117.         {
  118.             mSpeed = mousePercent;
  119.         }
  120.        
  121.         this._end = Math.round(-((this._mc[this._changeProp] - this._mask[this._changeProp]) * mSpeed));
  122.        
  123.         this._mc.onEnterFrame = function():Void
  124.         {
  125.             if (this[owner._axis] == owner._end)
  126.             {
  127.                 delete this.onEnterFrame;
  128.             }
  129.             else if (this[owner._axis]> owner._end)
  130.             {
  131.                 this[owner._axis] -= Math.ceil((this[owner._axis] - owner._end) * (owner._speed / 100));
  132.             }
  133.             else if (this[owner._axis] <owner._end)
  134.             {
  135.                 this[owner._axis] += Math.ceil((owner._end - this[owner._axis]) * (owner._speed / 100));
  136.             }
  137.         };
  138.     }
  139.    
  140. //- PUBLIC METHODS ----------------------------------------------------------------------------------------
  141.    
  142.     /**
  143.      * Starts the panel scrolling in the proper direction.
  144.      *
  145.      * @usage <pre><code>mpp.startPanel();</code></pre>
  146.      *
  147.      * @return Nothing
  148.      */
  149.    
  150.     public function startPanel():Void
  151.     {
  152.         var owner:MousePositionPanel = this;
  153.        
  154.         _level0.onMouseMove = function():Void
  155.         {
  156.             owner.movePanel(owner._moveDir);
  157.         };
  158.     }
  159.    
  160.     /**
  161.      * Stops the panel from scrolling any further.
  162.      *
  163.      * @usage <pre><code>mpp.stopPanel();</code></pre>
  164.      *
  165.      * @return Nothing
  166.      */
  167.    
  168.     public function stopPanel():Void
  169.     {
  170.         _level0.onMouseMove = null;
  171.     }
  172.    
  173. //- EVENT HANDLERS ----------------------------------------------------------------------------------------
  174.    
  175.    
  176.    
  177. //- GETTERS & SETTERS -------------------------------------------------------------------------------------
  178.    
  179.    
  180.    
  181. //- HELPERS -----------------------------------------------------------------------------------------------
  182.    
  183.     public function toString():String
  184.     {
  185.         return "com.reintroducing.ui.MousePositionPanel";
  186.     }
  187.    
  188. //- END CLASS ---------------------------------------------------------------------------------------------
  189. }

Tags: , , ,

AS2: ContactForm

October 10, 2007 in AS2, My Classes | Show Some Love | | 1 Comment »

View Example
View Documentation
Download Class & Example Files

Creates a communication gateway between a contact form and a PHP script that checks for validity and sends the email. The e-mail checking is rudimentary at best, but it gets the job done. If someone will go through the trouble to try and break this e-mail checker, then by all means spam away (at least that's the way I see it).

PLAIN TEXT
Actionscript:
  1. import mx.events.EventDispatcher;
  2.  
  3. /**
  4. * Creates a communication gateway between a contact form and a PHP script that checks for validity and sends the email.  The
  5. * e-mail checking is rudimentary at best, but it gets the job done.  If someone will go through the trouble to try and break this
  6. * e-mail checker, then by all means spam away (at least that's the way I see it).
  7. *
  8. * <p>The fields array should contain an object for each field.  The object will have a "field" string value, which is the
  9. * instance name (minus the "_txt" suffix) of the text field to check, an "error" string value which is the error text
  10. * that is displayed when the error events are dispatched, and a "required" boolean that checks if the field is a
  11. * required field.</p>
  12. *
  13. * <p>As of right now, the fields that are passed into the fields array should be written as the instance name of the field minus the _txt extension.
  14. * For example, if the instance name is name_txt, you pass "name" as the field string value in the fields array.</p>
  15. *
  16. * <p>The class dispatches events depending on what happens.  The events are as follows:</p>
  17. *
  18. * <ul>
  19. * <li>onEmailError: Dispatched if the e-mail check returns an incorrect e-mail address</li>
  20. * <li>onInvalidError: Dispatched when a required field fails the check (displays error from fields array object)</li>
  21. * <li>onMessageSent: Dispatched when the message has been successfully sent</li>
  22. * <li>onServerError: Dispatched if the server is unable to deliver the message</li>
  23. * </ul>
  24. *
  25. * @usage
  26. * <code>
  27. * <pre>
  28. import com.reintroducing.forms.ContactForm;
  30. var listener:Object = new Object();
  32. var scriptURL:String = "scripts/contactSubmit.php";
  33. var toEmail:String = "matt@reintroducing.com";
  34. var subject:String = "Testing the ContactForm Class";
  35. var fields:Array = new Array(   {field: "name", error: "Please enter your name.", required: true},
  36.                                 {field: "email", error: "Please enter a valid e-mail address.", required: true},
  37.                                 {field: "phone", error: "", required: false},
  38.                                 {field: "comments", error: "Please enter your comments.", required: true});
  40. var cf:ContactForm = new ContactForm(fields, scriptURL, toEmail, subject);
  42. cf.addEventListener("onEmailError", listener);
  43. cf.addEventListener("onInvalidError", listener);
  44. cf.addEventListener("onMessageSent", listener);
  45. cf.addEventListener("onServerError", listener);
  47. listener.onEmailError = function($eo:Object):Void
  48. {
  49.     _root.error_txt.text = $eo.error;
  50. };
  52. listener.onInvalidError = function($eo:Object):Void