Packagemx.events
Classpublic class SliderEvent
InheritanceSliderEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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 also

mx.controls.HSlider
mx.controls.VSlider
mx.controls.sliderClasses.Slider
mx.events.SliderEventClickTarget

Public Properties
 PropertyDefined By
  clickTarget : String
Specifies whether the slider track or a slider thumb was pressed.
SliderEvent
  keyCode : int
If the event was triggered by a key press, the keycode for the key.
SliderEvent
  thumbIndex : int
The zero-based index of the thumb whose position has changed.
SliderEvent
  triggerEvent : Event
Indicates the type of input action.
SliderEvent
  value : Number
The new value of the slider.
SliderEvent
Public Methods
 MethodDefined By
  
SliderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, thumbIndex:int = -1, value:Number, triggerEvent:Event = null, clickTarget:String = null, keyCode:int = -1)
Constructor.
SliderEvent
Public Constants
 ConstantDefined By
  CHANGE : String = change
[static] The SliderEvent.CHANGE constant defines the value of the type property of the event object for a change event.
SliderEvent
  THUMB_DRAG : String = thumbDrag
[static] The SliderEvent.THUMB_DRAG constant defines the value of the type property of the event object for a thumbDrag event.
SliderEvent
  THUMB_PRESS : String = thumbPress
[static] The SliderEvent.THUMB_PRESS constant defines the value of the type property of the event object for a thumbPress event.
SliderEvent
  THUMB_RELEASE : String = thumbRelease
[static] The SliderEvent.THUMB_RELEASE constant defines the value of the type property of the event object for a thumbRelease event.
SliderEvent
Property Detail
clickTargetproperty
public var clickTarget:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Specifies whether the slider track or a slider thumb was pressed. This property can have one of two values: SliderEventClickTarget.THUMB or SliderEventClickTarget.TRACK.

See also

mx.events.SliderEventClickTarget
keyCodeproperty 
public var keyCode:int

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

If the event was triggered by a key press, the keycode for the key.

thumbIndexproperty 
public var thumbIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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.

triggerEventproperty 
public var triggerEvent:Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Indicates the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent.

See also

flash.events.MouseEvent
flash.events.KeyboardEvent
valueproperty 
public var value:Number

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The new value of the slider.

Constructor Detail
SliderEvent()Constructor
public function SliderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, thumbIndex:int = -1, value:Number, triggerEvent:Event = null, clickTarget:String = null, keyCode:int = -1)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
thumbIndex:int (default = -1) — The zero-based index of the thumb whose position has changed.
 
value:Number (default = NaN) — The new value of the slider.
 
triggerEvent:Event (default = null) — The type of input action. The value is an object of type flash.events.MouseEvent or flash.events.KeyboardEvent.
 
clickTarget:String (default = null) — Whether the slider track or a slider thumb was pressed.
 
keyCode:int (default = -1) — If the event was triggered by a key press, the keycode for the key.
Constant Detail
CHANGEConstant
public static const CHANGE:String = change

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

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:

PropertyValue
bubblesfalse
cancelablefalse
clickTargetSpecifies whether the slider track or a slider thumb was pressed.
currentTargetThe 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.
keyCodeIf the event was triggered by a key press, the keycode for the key.
targetThe 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.
thumbIndexThe zero-based index of the thumb whose position has changed.
triggerEventContains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent.
valueThe new value of the slider.

THUMB_DRAGConstant 
public static const THUMB_DRAG:String = thumbDrag

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The 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:

PropertyValue
bubblesfalse
cancelablefalse
clickTargetSpecifies whether the slider track or a slider thumb was pressed.
currentTargetThe 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.
keyCodeIf the event was triggered by a key press, the keycode for the key.
targetThe 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.
thumbIndexThe zero-based index of the thumb whose position has changed.
triggerEventContains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent.
valueThe new value of the slider.

THUMB_PRESSConstant 
public static const THUMB_PRESS:String = thumbPress

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The 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:

PropertyValue
bubblesfalse
cancelablefalse
clickTargetSpecifies whether the slider track or a slider thumb was pressed.
currentTargetThe 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.
keyCodeIf the event was triggered by a key press, the keycode for the key.
targetThe 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.
thumbIndexThe zero-based index of the thumb whose position has changed.
triggerEventContains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent.
valueThe new value of the slider.

THUMB_RELEASEConstant 
public static const THUMB_RELEASE:String = thumbRelease

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The 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:

PropertyValue
bubblesfalse
cancelablefalse
clickTargetSpecifies whether the slider track or a slider thumb was pressed.
currentTargetThe 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.
keyCodeIf the event was triggered by a key press, the keycode for the key.
targetThe 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.
thumbIndexThe zero-based index of the thumb whose position has changed.
triggerEventContains a value indicating the type of input action. The value is an event object of type flash.events.MouseEvent or flash.events.KeyboardEvent.
valueThe new value of the slider.





Mon Dec 24 2012, 01:18 PM +11:00