Gumbo FxSpinner - Functional and Design Specification

package mx.components
{

import flash.events.Event;
import flash.events.KeyboardEvent;
import flash.events.MouseEvent;
import flash.ui.Keyboard;

import mx.events.FlexEvent;
import mx.managers.IFocusManagerComponent;

/**
 *  Dispatched when the value of the FxSpinner control changes
 *  as a result of user interaction.
 *
 *  @eventType mx.events.Event
 */
[Event(name="change", type="mx.events.Event")]

/**
 *  A FxSpinner is used to select a value from an
 *  ordered set. It uses two buttons that increase or
 *  decrease the current value based on the current
 *  <code>stepSize</code>.
 *  
 *  <p>This control extends the FxRange class and
 *  is the base class for controls that select a value
 *  from an ordered set such as the FxNumericStepper control.</p>
 * 
 *  <p>A FxSpinner consists of two required buttons,
 *  one to increase the value and one to decrease the 
 *  value. </p>
 *
 *  <p>FxSpinner has the addition property of 
 *  <code>valueWrap</code> which enables value wrapping.</p>
 * 
 *  @see mx.components.baseClasses.FxRange
 *  @see mx.components.FxNumericStepper
 */
public class FxSpinner extends FxRange implements IFocusManagerComponent
{
    include "../core/Version.as";

    //--------------------------------------------------------------------------
    //
    //  Constructor
    //
    //--------------------------------------------------------------------------

    /**
     *  Constructor. 
     */
    public function FxSpinner():void

    //--------------------------------------------------------------------------
    //
    // SkinParts
    //
    //--------------------------------------------------------------------------
    
    [SkinPart]
    
    /**
     *  <code>incrementButton</code> is a SkinPart that defines 
     *  a button that, when pressed, will cause <code>value</code>
     *  to increment by <code>stepSize</code>.
     */
    public var incrementButton:Button;
    
    [SkinPart]
    
    /**
     *  <code>decrementButton</code> is a SkinPart that defines
     *  a button that, when pressed, will cause <code>value</code>
     *  to decrement by <code>stepSize</code>.
     */
    public var decrementButton:Button;
    
    //--------------------------------------------------------------------------
    //
    //  Overridden properties: UIComponent
    //
    //--------------------------------------------------------------------------

    //----------------------------------
    //  enabled
    //----------------------------------

    /**
     *  Enable/disable this component. This also enables/disables any of the 
     *  skin parts for this component.
     */
    override public function set enabled(value:Boolean):void;

    //--------------------------------------------------------------------------
    //
    // Properties
    //
    //--------------------------------------------------------------------------

    //----------------------------------
    //  valueWrap
    //----------------------------------

    /**
     *  <code>valueWrap</code> determines the behavior of stepping 
     *  beyond the maximum or minimum value. If 
     *  <code>valueWrap</code> is true when stepping beyond an 
     *  extreme, it will set <code>value</code> to the opposite
     *  extreme.
     * 
     *  @default false
     */
    public function get valueWrap():Boolean;

    public function set valueWrap(value:Boolean):void;
    
    //--------------------------------------------------------------------------
    //
    // Methods
    //
    //--------------------------------------------------------------------------

    /**
     *  @private
     */
    override protected function partAdded(partName:String, instance:*):void:

    /**
     *  @private
     */
    override protected function partRemoved(partName:String, instance:*):void;
    
    /**
     *  Make the skins reflect the enabled state of the Spinner.
     */
    protected function enableSkinParts(value:Boolean):void:
    
    /**
     *  @private
     *  Adds complex behavior to step in order to adhere to
     *  multiples of stepSize (including maximum and minimum).
     */
    override public function step(increase:Boolean = true):void;
    
    //--------------------------------------------------------------------------
    // 
    // Event Handlers
    //
    //--------------------------------------------------------------------------
    
    //--------------------------------- 
    // Mouse handlers
    //---------------------------------
   
    /**
     *  Handle a click on the incrementButton. This should
     *  increment <code>value</code> by <code>stepSize</code>.
     */
    protected function incrementButton_buttonDownHandler(event:Event):void;
    
    /**
     *  Handle a click on the decrementButton. This should
     *  decrement <code>value</code> by <code>stepSize</code>.
     */
    protected function decrementButton_buttonDownHandler(event:Event):void;
    
    /**
     *  Handles keyboard input. Up arrow increments. Down arrow
     *  decrements. Home and End keys set the value to maximum
     *  and minimum respectively.
     */
    override protected function keyDownHandler(event:KeyboardEvent):void;
}

}