////////////////////////////////////////////////////////////////////////////////
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
package mx.events
{
import flash.events.Event;
/**
* The SliderEvent class represents the event object passed to
* the event listener for the change
, thumbDrag
,
* thumbPress
, and thumbRelease
events
* of the HSlider and VSlider classes.
*
* @see mx.controls.HSlider
* @see mx.controls.VSlider
* @see mx.controls.sliderClasses.Slider
* @see mx.events.SliderEventClickTarget
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public class SliderEvent extends Event
{
include "../core/Version.as";
//--------------------------------------------------------------------------
//
// Class constants
//
//--------------------------------------------------------------------------
/**
* The SliderEvent.CHANGE
constant defines the value of the
* type
property of the event object for a change
event.
*
*
The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider * track or a slider thumb was pressed. |
currentTarget | The Object that defines the
* event listener that handles the event. For example, if you use
* myButton.addEventListener() to register an event listener,
* myButton is the value of the currentTarget . |
keyCode | If the event was triggered by a key press, * the keycode for the key. |
target | The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the currentTarget property to always access the
* Object listening for the event. |
thumbIndex | The zero-based index of the thumb * whose position has changed. |
triggerEvent | Contains a value indicating the * type of input action. The value is an event object of type flash.events.MouseEvent * or flash.events.KeyboardEvent. |
value | The new value of the slider. |
SliderEvent.THUMB_DRAG
constant defines the value of the
* type
property of the event object for a thumbDrag
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider * track or a slider thumb was pressed. |
currentTarget | The Object that defines the
* event listener that handles the event. For example, if you use
* myButton.addEventListener() to register an event listener,
* myButton is the value of the currentTarget . |
keyCode | If the event was triggered by a key press, * the keycode for the key. |
target | The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the currentTarget property to always access the
* Object listening for the event. |
thumbIndex | The zero-based index of the thumb * whose position has changed. |
triggerEvent | Contains a value indicating the * type of input action. The value is an event object of type flash.events.MouseEvent * or flash.events.KeyboardEvent. |
value | The new value of the slider. |
SliderEvent.THUMB_PRESS
constant defines the value of the
* type
property of the event object for a thumbPress
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider * track or a slider thumb was pressed. |
currentTarget | The Object that defines the
* event listener that handles the event. For example, if you use
* myButton.addEventListener() to register an event listener,
* myButton is the value of the currentTarget . |
keyCode | If the event was triggered by a key press, * the keycode for the key. |
target | The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the currentTarget property to always access the
* Object listening for the event. |
thumbIndex | The zero-based index of the thumb * whose position has changed. |
triggerEvent | Contains a value indicating the * type of input action. The value is an event object of type flash.events.MouseEvent * or flash.events.KeyboardEvent. |
value | The new value of the slider. |
SliderEvent.THUMB_RELEASE
constant defines the value of the
* type
property of the event object for a thumbRelease
event.
*
* The properties of the event object have the following values:
*Property | Value |
---|---|
bubbles | false |
cancelable | false |
clickTarget | Specifies whether the slider * track or a slider thumb was pressed. |
currentTarget | The Object that defines the
* event listener that handles the event. For example, if you use
* myButton.addEventListener() to register an event listener,
* myButton is the value of the currentTarget . |
keyCode | If the event was triggered by a key press, * the keycode for the key. |
target | The Object that dispatched the event;
* it is not always the Object listening for the event.
* Use the currentTarget property to always access the
* Object listening for the event. |
thumbIndex | The zero-based index of the thumb * whose position has changed. |
triggerEvent | Contains a value indicating the * type of input action. The value is an event object of type flash.events.MouseEvent * or flash.events.KeyboardEvent. |
value | The new value of the slider. |
SliderEventClickTarget.THUMB
* or SliderEventClickTarget.TRACK
.
*
* @see mx.events.SliderEventClickTarget
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var clickTarget:String;
//----------------------------------
// keyCode
//----------------------------------
/**
* If the event was triggered by a key press, the keycode for the key.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var keyCode:int;
//----------------------------------
// thumbIndex
//----------------------------------
/**
* The zero-based index of the thumb whose position has changed.
* If there is only a single thumb, the value is 0.
* If there are two thumbs, the value is 0 or 1.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var thumbIndex:int;
//----------------------------------
// triggerEvent
//----------------------------------
/**
* Indicates the type of input action.
* The value is an event object of type flash.events.MouseEvent
* or flash.events.KeyboardEvent.
*
* @see flash.events.MouseEvent
* @see flash.events.KeyboardEvent
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var triggerEvent:Event;
//----------------------------------
// value
//----------------------------------
/**
* The new value of the slider.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var value:Number;
//--------------------------------------------------------------------------
//
// Overridden methods: Event
//
//--------------------------------------------------------------------------
/**
* @private
*/
override public function clone():Event
{
return new SliderEvent(type, bubbles, cancelable, thumbIndex,
value, triggerEvent, clickTarget, keyCode);
}
}
}