SliderEvent

Package	mx.events
Class	public class SliderEvent
Inheritance	SliderEvent Event Object

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.

More examples

Manually dispatching events
Using slider events

Learn more

About Flex events

Related API Elements

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

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] 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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] 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
		target : Object [read-only] 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
		type : String [read-only] The type of event.	Event
		value : Number The new value of the slider.	SliderEvent

Public Methods

	Method		Defined By
		SliderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, thumbIndex:int = -1, value:Number = NaN, triggerEvent:Event = null, clickTarget:String = null, keyCode:int = -1) Constructor.	SliderEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined 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

clickTarget

property

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.

Related API Elements

mx.events.SliderEventClickTarget

keyCode

property

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.

thumbIndex

property

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.

triggerEvent

property

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.

Related API Elements

flash.events.MouseEvent
flash.events.KeyboardEvent

value

property

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 = NaN, 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

CHANGE

Constant

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:

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.

THUMB_DRAG

Constant

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:

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.

THUMB_PRESS

Constant

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:

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.

THUMB_RELEASE

Constant

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:

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.

Legal Notices | Online Privacy Policy

SliderEvent - AS3 Flex

Classes x

clickTarget

keyCode

thumbIndex

triggerEvent

value

SliderEvent

CHANGE

THUMB_DRAG

THUMB_PRESS

THUMB_RELEASE