Packagemx.events
Classpublic class SliderEvent
InheritanceSliderEvent Inheritance Event Inheritance Object

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
HSlider and VSlider controls


Public Properties
 PropertyDefined by
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
  clickTarget : String
Specifies whether the slider track or a slider thumb was pressed.
SliderEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
The current phase in the event flow.
Event
  keyCode : int
If the event was triggered by a key press, the keycode for the key.
SliderEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
The event target.
Event
  thumbIndex : int
The zero-based index of the thumb whose position has changed.
SliderEvent
  triggerEvent : Event
Indicates the type of input action.
SliderEvent
 Inheritedtype : String
The type of event.
Event
  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
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether preventDefault() has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
  CHANGE : String = "change"
[static] The SliderEvent.CHANGE constant defines the value of the type property of the event object for a change event.
SliderEvent
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
  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
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
clickTargetproperty
public var clickTarget:String

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

keyCodeproperty 
public var keyCode:int

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

thumbIndexproperty 
public var thumbIndex:int

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

Indicates the type of input action. The value is either InteractionInputType.MOUSE or InteractionInputType.KEYBOARD.

valueproperty 
public var value:Number

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)

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 — The type of input action. The value is either InteractionInputType.MOUSE or InteractionInputType.KEYBOARD.
 
triggerEvent:Event (default = null) — Whether the slider track or a slider thumb was pressed.
 
clickTarget:String (default = null) — If the event was triggered by a key press, the keycode for the key.
 
keyCode:int (default = -1)
Constant detail
CHANGEconstant
public static const CHANGE:String = "change"

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 either InteractionInputType.MOUSE or InteractionInputType.KEYBOARD.
valueThe new value of the slider.
THUMB_DRAGconstant 
public static const THUMB_DRAG:String = "thumbDrag"

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 either InteractionInputType.MOUSE or InteractionInputType.KEYBOARD.
valueThe new value of the slider.
THUMB_PRESSconstant 
public static const THUMB_PRESS:String = "thumbPress"

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 either InteractionInputType.MOUSE or InteractionInputType.KEYBOARD.
valueThe new value of the slider.
THUMB_RELEASEconstant 
public static const THUMB_RELEASE:String = "thumbRelease"

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 either InteractionInputType.MOUSE or InteractionInputType.KEYBOARD.
valueThe new value of the slider.




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/events/SliderEvent.html