/FD3/FlashDevelop/Bin/Debug/Library/AS3/frameworks/FlashIDE/fl/controls/Slider.as
ActionScript | 543 lines | 77 code | 4 blank | 462 comment | 0 complexity | fea379035123d7159225f91e560ed288 MD5 | raw file
- package fl.controls
- {
- import fl.controls.BaseButton;
- import fl.controls.SliderDirection;
- import fl.controls.ScrollBar;
- import fl.core.InvalidationType;
- import fl.core.UIComponent;
- import fl.events.SliderEvent;
- import fl.events.InteractionInputType;
- import fl.events.SliderEventClickTarget;
- import fl.managers.IFocusManagerComponent;
- import flash.display.DisplayObject;
- import flash.display.Sprite;
- import flash.events.KeyboardEvent;
- import flash.events.MouseEvent;
- import flash.ui.Keyboard;
-
- /**
- * Dispatched when the slider thumb is pressed.
- *
- * @eventType fl.events.SliderEvent.THUMB_PRESS
- *
- * @see #event:thumbDrag
- * @see #event:thumbRelease
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Event(name="thumbPress", type="fl.events.SliderEvent")]
- /**
- * Dispatched when the slider thumb is pressed and released.
- *
- * @eventType fl.events.SliderEvent.THUMB_RELEASE
- *
- * @includeExample examples/Slider.thumbRelease.1.as -noswf
- *
- * @see #event:thumbDrag
- * @see #event:thumbPress
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Event(name="thumbRelease", type="fl.events.SliderEvent")]
- /**
- * Dispatched when the slider thumb is pressed and
- * then moved by the mouse. This event is always preceded by a
- * <code>thumbPress</code> event.
- *
- * @eventType fl.events.SliderEvent.THUMB_DRAG
- *
- * @includeExample examples/Slider.thumbDrag.1.as -noswf
- *
- * @see #event:thumbPress
- * @see #event:thumbRelease
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Event(name="thumbDrag", type="fl.events.SliderEvent")]
- /**
- * Dispatched when the value of the Slider component changes as a result of mouse or keyboard
- * interaction. If the <code>liveDragging</code> property is <code>true</code>, the event is
- * dispatched continuously as the user moves the thumb. If
- * <code>liveDragging</code> is <code>false</code>, the event is dispatched when the user
- * releases the slider thumb.
- *
- * @eventType fl.events.SliderEvent.CHANGE
- *
- * @see #liveDragging
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Event(name="change", type="fl.events.SliderEvent")]
- /**
- * @copy fl.controls.ScrollBar#style:thumbUpSkin
- *
- * @default SliderThumb_upSkin
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Style(name="thumbUpSkin", type="Class")]
- /**
- * @copy fl.controls.ScrollBar#style:thumbOverSkin
- *
- * @default SliderThumb_overSkin
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Style(name="thumbOverSkin", type="Class")]
- /**
- * @copy fl.controls.ScrollBar#style:thumbDownSkin
- *
- * @default SliderThumb_downSkin
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Style(name="thumbDownSkin", type="Class")]
- /**
- * @copy fl.controls.ScrollBar#style:thumbDisabledSkin
- *
- * @default SliderThumb_disabledSkin
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Style(name="thumbDisabledSkin", type="Class")]
- /**
- * The skin for the track in a Slider component.
- *
- * @default SliderTrack_skin
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Style(name="sliderTrackSkin", type="Class")]
- /**
- * The skin for the track in a Slider component that is disabled.
- *
- * @default SliderTrack_disabledSkin
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Style(name="sliderTrackDisabledSkin", type="Class")]
- /**
- * The skin for the ticks in a Slider component.
- *
- * @default SliderTick_skin
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- [Style(name="tickSkin", type="Class")]
-
- /**
- * The Slider component lets users select a value by moving a slider
- * thumb between the end points of the slider track. The current
- * value of the Slider component is determined by the relative location of
- * the thumb between the end points of the slider, corresponding to
- * the <code>minimum</code> and <code>maximum</code> values of the Slider
- * component.
- *
- * @includeExample examples/SliderExample.as
- *
- * @see fl.events.SliderEvent SliderEvent
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public class Slider extends UIComponent implements IFocusManagerComponent
- {
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var _direction : String;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var _minimum : Number;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var _maximum : Number;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var _value : Number;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var _tickInterval : Number;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var _snapInterval : Number;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var _liveDragging : Boolean;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var tickContainer : Sprite;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var thumb : BaseButton;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected var track : BaseButton;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected static var defaultStyles : Object;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected static const TRACK_STYLES : Object;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected const THUMB_STYLES : Object;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected const TICK_STYLES : Object;
-
- /**
- * Sets the direction of the slider. Acceptable values are <code>SliderDirection.HORIZONTAL</code> and
- * <code>SliderDirection.VERTICAL</code>.
- *
- * @default SliderDirection.HORIZONTAL
- *
- * @includeExample examples/Slider.direction.1.as -noswf
- *
- * @see SliderDirection
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get direction () : String;
- /**
- * @private (setter)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set direction (value:String) : void;
- /**
- * The minimum value allowed on the Slider component instance.
- *
- * @default 0
- *
- * @see #maximum
- * @see #value
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get minimum () : Number;
- /**
- * @private (setter)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set minimum (value:Number) : void;
- /**
- * The maximum allowed value on the Slider component instance.
- *
- * @default 10
- *
- * @see #minimum
- * @see #value
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get maximum () : Number;
- /**
- * @private (setter)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set maximum (value:Number) : void;
- /**
- * The spacing of the tick marks relative to the maximum value
- * of the component. The Slider component displays tick marks whenever
- * you set the <code>tickInterval</code> property to a nonzero value.
- *
- * @default 0
- *
- * @see #snapInterval
- *
- * @includeExample examples/Slider.tickInterval.1.as -noswf
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get tickInterval () : Number;
- /**
- * @private (setter)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set tickInterval (value:Number) : void;
- /**
- * Gets or sets the increment by which the value is increased or decreased
- * as the user moves the slider thumb.
- *
- * <p>For example, this property is set to 2, the <code>minimum</code> value is 0,
- * and the <code>maximum</code> value is 10, the position of the thumb will always
- * be at 0, 2, 4, 6, 8, or 10. If this property is set to 0, the slider
- * moves continuously between the <code>minimum</code> and <code>maximum</code> values.</p>
- *
- * @default 0
- *
- * @includeExample examples/Slider.snapInterval.2.as -noswf
- * @includeExample examples/Slider.snapInterval.1.as -noswf
- *
- * @see #tickInterval
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get snapInterval () : Number;
- /**
- * @private (setter)
- *
- * @includeExample examples/Slider.snapInterval.1.as -noswf
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set snapInterval (value:Number) : void;
- /**
- * Gets or sets a Boolean value that indicates whether the <code>SliderEvent.CHANGE</code>
- * event is dispatched continuously as the user moves the slider thumb. If the
- * <code>liveDragging</code> property is <code>false</code>, the <code>SliderEvent.CHANGE</code>
- * event is dispatched when the user releases the slider thumb.
- *
- * @default false
- *
- * @includeExample examples/Slider.liveDragging.1.as -noswf
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set liveDragging (value:Boolean) : void;
- /**
- * @private (setter)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get liveDragging () : Boolean;
- /**
- * @copy fl.core.UIComponent#enabled
- *
- * @default true
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get enabled () : Boolean;
- /**
- * @private (setter)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set enabled (value:Boolean) : void;
- /**
- * Gets or sets the current value of the Slider component. This value is
- * determined by the position of the slider thumb between the minimum and
- * maximum values.
- *
- * @default 0
- *
- * @see #maximum
- * @see #minimum
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function get value () : Number;
- /**
- * @private (setter)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function set value (value:Number) : void;
-
- /**
- * @copy fl.core.UIComponent#getStyleDefinition()
- *
- * @includeExample ../core/examples/UIComponent.getStyleDefinition.1.as -noswf
- *
- * @see fl.core.UIComponent#getStyle() UIComponent.getStyle()
- * @see fl.core.UIComponent#setStyle() UIComponent.setStyle()
- * @see fl.managers.StyleManager StyleManager
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public static function getStyleDefinition () : Object;
- /**
- * @copy fl.core.UIComponent#setSize()
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- public function setSize (w:Number, h:Number) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function doSetValue (val:Number, interactionType:String = null, clickTarget:String = null, keyCode:int = undefined) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function setStyles () : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function draw () : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function positionThumb () : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function drawTicks () : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function clearTicks () : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function calculateValue (pos:Number, interactionType:String, clickTarget:String, keyCode:int = undefined) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function doDrag (event:MouseEvent) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function thumbPressHandler (event:MouseEvent) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function thumbReleaseHandler (event:MouseEvent) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function onTrackClick (event:MouseEvent) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function keyDownHandler (event:KeyboardEvent) : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function configUI () : void;
- /**
- * @private (protected)
- *
- * @langversion 3.0
- * @playerversion Flash 9.0.28.0
- */
- protected function getPrecision (num:Number) : Number;
- }
- }