Coverage Report - org.as3coreaddendum.events.PriorityEvent
 
Classes in this File Line Coverage Branch Coverage Complexity
PriorityEvent
100%
5/5
N/A
0
 
 1  
 /*
 2  
  * Licensed under the MIT License
 3  
  * 
 4  
  * Copyright 2011 (c) Flávio Silva, flsilva.com
 5  
  *
 6  
  * Permission is hereby granted, free of charge, to any person
 7  
  * obtaining a copy of this software and associated documentation
 8  
  * files (the "Software"), to deal in the Software without
 9  
  * restriction, including without limitation the rights to use,
 10  
  * copy, modify, merge, publish, distribute, sublicense, and/or sell
 11  
  * copies of the Software, and to permit persons to whom the
 12  
  * Software is furnished to do so, subject to the following
 13  
  * conditions:
 14  
  *
 15  
  * The above copyright notice and this permission notice shall be
 16  
  * included in all copies or substantial portions of the Software.
 17  
  *
 18  
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 19  
  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 20  
  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 21  
  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 22  
  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 23  
  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 24  
  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 25  
  * OTHER DEALINGS IN THE SOFTWARE.
 26  
  * 
 27  
  * http://www.opensource.org/licenses/mit-license.php
 28  
  */
 29  1
 package org.as3coreaddendum.events
 30  
 {
 31  
         import flash.events.Event;
 32  
 
 33  
         /**
 34  
          * This event should be dispatched by objects that implement <code>org.as3coreaddendum.system.IPriority</code> interface and had its "priority" setter invoked.
 35  
          * This way the object will inform that its priority was changed.
 36  
          * <p>But if the object does not implement <code>flash.events.IEventDispatcher</code> interface, that's ok to not dispatch this event.</p>
 37  
          * 
 38  
          * @author Flávio Silva
 39  
          */
 40  
         public class PriorityEvent extends Event
 41  
         {
 42  
                 public static const CHANGED:String = "org.as3coreaddendum.events.PriorityEvent.CHANGED";
 43  
                 
 44  
                 /**
 45  
                  * description
 46  
                  */
 47  
                 private var _priority:int;
 48  
                 
 49  
                 /**
 50  
                  * description
 51  
                  */
 52  
                 public function get priority(): int { return _priority; }
 53  
                 
 54  
                 /**
 55  
                  * Constructor, creates a new <code>PriorityEvent</code> object.
 56  
                  * 
 57  
                  * @param type                         The type of the event, accessible as <code>Event.type</code>.
 58  
                  * @param priority                 The new priority value.
 59  
                  * @param bubbles                 Determines whether the Event object participates in the bubbling stage of the event flow. The default value is <code>false</code>.
 60  
                  * @param cancelable         Determines whether the Event object can be canceled. The default value is <code>false</code>.
 61  
                  */
 62  
                 public function PriorityEvent(type:String, priority:int, bubbles: Boolean = false, cancelable: Boolean = false)
 63  
                 {
 64  1
                         super(type, bubbles, cancelable);
 65  
                         
 66  1
                         _priority = priority;
 67  1
                 }
 68  
                 
 69  
                 /**
 70  
                  * Duplicates the instance of PriorityEvent object.
 71  
                  * <p>Returns a new PriorityEvent object that is a copy of the original instance of the PriorityEvent object. You do not normally call <code>clone()</code>; the <code>EventDispatcher</code> class calls it automatically when you redispatch an event—that is, when you call <code>dispatchEvent(event)</code> from a handler that is handling event.</p>
 72  
                  * <p>The new PriorityEvent object includes all the properties of the original.</p>
 73  
                  * 
 74  
                  * @return        A new PriorityEvent object that is identical to the original.
 75  
                  */
 76  
                 override public function clone():Event
 77  
                 {
 78  1
                         return new PriorityEvent(type, _priority, bubbles, cancelable);
 79  
                 }
 80  
                 
 81  
         }
 82  
 
 83  
 }