fl.events

# SliderEvent - AS3 Flash

Package | fl.events
Class | public class SliderEvent
Inheritance | SliderEvent Event Object

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

The SliderEvent class defines events that are associated with the Slider component. These include the following:

- `SliderEvent.CHANGE`: dispatched after there is a change in the position of the slider.
- `SliderEvent.THUMB_DRAG`: dispatched when a user drags the thumb of the slider.
- `SliderEvent.THUMB_PRESS`: dispatched when a user presses the thumb of the slider.
- `SliderEvent.THUMB_RELEASE`: dispatched when the user releases the thumb of the slider.

Related API Elements

SliderEventClickTarget

Public Properties
Hide Inherited Public Properties
Show Inherited 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 [read-only] Gets a string that indicates whether the slider thumb or a slider track 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 : Number [read-only] Gets the key code for the key that was pressed to trigger the event. | SliderEvent
|  | target : Object [read-only] The event target. | Event
|  | triggerEvent : String [read-only] Gets the type of device that was used to send the input. | SliderEvent
|  | type : String [read-only] The type of event. | Event
|  | value : Number [read-only] Gets the new value of the slider, based on its position. | SliderEvent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SliderEvent(type:String, value:Number, clickTarget:String, triggerEvent:String, keyCode:int = 0) Creates a new SliderEvent object with the specified parameters. | SliderEvent
|  | clone():Event [override] Creates a copy of the SliderEvent object and sets the value of each parameter to match the original. | SliderEvent
|  | 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 [override] Returns a string that contains all the properties of the SliderEvent object. | SliderEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | CHANGE : String = "change" [static] Defines the value of the type property of a change event object. | SliderEvent
|  | THUMB_DRAG : String = "thumbDrag" [static] Defines the value of the type property of a thumbDrag event object. | SliderEvent
|  | THUMB_PRESS : String = "thumbPress" [static] Defines the value of the type property of a thumbPress event object. | SliderEvent
|  | THUMB_RELEASE : String = "thumbRelease" [static] Defines the value of the type property of a thumbRelease event object. | SliderEvent

Property Detail

### clickTarget

property

`clickTarget:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets a string that indicates whether the slider thumb or a slider track was pressed. A value of `SliderEventClickTarget.THUMB` indicates that the slider thumb was pressed; a value of `SliderEventClickTarget.TRACK` indicates that the slider track was pressed.

Implementation
`public function get clickTarget():String`

Related API Elements

SliderEventClickTarget

### keyCode

property

`keyCode:Number` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets the key code for the key that was pressed to trigger the event. A key code is a numeric value that identifies the key that was pressed.

Implementation
`public function get keyCode():Number`

Related API Elements

flash.events.KeyboardEvent.keyCode

### triggerEvent

property

`triggerEvent:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets the type of device that was used to send the input. A value of `InteractionInputType.MOUSE` indicates that a mouse was the source of the input; a value of `InteractionInputType.KEYBOARD` indicates that a keyboard was the source of the input.

Implementation
`public function get triggerEvent():String`

Related API Elements

SliderEventClickTarget

### value

property

`value:Number` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets the new value of the slider, based on its position.

Implementation
`public function get value():Number`
Constructor Detail

### SliderEvent

()
Constructor

`public function SliderEvent(type:String, value:Number, clickTarget:String, triggerEvent:String, keyCode:int = 0)`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Creates a new SliderEvent object with the specified parameters.

Parameters

| `type:String` — The event type; this value identifies the action that triggered the event.
| `value:Number` — The new value of the slider.
| `clickTarget:String` — Indicates whether a slider thumb or the slider track was pressed. A value of `SliderEventClickTarget.THUMB` indicates that the slider thumb was pressed; a value of `SliderEventClickTarget.TRACK` indicates that the slider track was pressed.
| `triggerEvent:String` — A String that indicates the source of the input. A value of `InteractionInputType.MOUSE` indicates that the mouse was the source of input; a value of `InteractionInputType.KEYBOARD` indicates that the keyboard was the source of input.
| `keyCode:int` (default = `0`)`` — If the event was triggered by a key press, this value is the key code that identifies that key.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Creates a copy of the SliderEvent object and sets the value of each parameter to match the original.

Returns

| `Event` — A copy of the current SliderEvent instance.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Returns a string that contains all the properties of the SliderEvent object. The string is in the following format:

[`SliderEvent type=value value=value bubbles=value cancelable=value keycode=value triggerEvent=value clickTarget=value`]

Returns

| `String` — A string representation of the SliderEvent object.

Constant Detail

### CHANGE

Constant

`public static const CHANGE:String = "change"`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Defines the value of the `type` property of a `change` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`clickTarget` | Identifies whether the slider track or a slider thumb was pressed.
`currentTarget` | The object that is actively processing the event object with an event listener.
`keyCode` | If the event was triggered by a key press, the code for the key that was pressed.
`target` | The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.
`triggerEvent` | The type of device that triggered the event. A value of `InteractionInputType.MOUSE` indicates that a mouse was the source of input; a value of `InteractionInputType.KEYBOARD` indicates that a keyboard was the source of input.
`value` | The value of the slider after the event.

### THUMB_DRAG

Constant

`public static const THUMB_DRAG:String = "thumbDrag"`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Defines the value of the `type` property of a `thumbDrag` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`clickTarget` | Identifies whether the slider track or a slider thumb was pressed.
`currentTarget` | The object that is actively processing the event object with an event listener.
`keyCode` | If the event was triggered by a key press, the code for the key that was pressed.
`target` | The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.
`triggerEvent` | The type of device that triggered the event. A value of `InteractionInputType.MOUSE` indicates that a mouse was the source of the input; a value of `InteractionInputType.KEYBOARD` indicates that a keyboard was the source of the input.
`value` | The value of the slider after the event.

Related API Elements

THUMB_PRESS
THUMB_RELEASE

### THUMB_PRESS

Constant

`public static const THUMB_PRESS:String = "thumbPress"`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Defines the value of the `type` property of a `thumbPress` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`clickTarget` | Identifies whether the slider track or a slider thumb was pressed.
`currentTarget` | The object that is actively processing the event object with an event listener.
`keyCode` | If the event was triggered by a key press, the code for the key that was pressed.
`target` | The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.
`triggerEvent` | The type of device that triggered the event. A value of `InteractionInputType.MOUSE` indicates that a mouse was the source of the input; a value of `InteractionInputType.KEYBOARD` indicates that a keyboard was the source of the input.
`value` | The value of the slider after the event.

Related API Elements

THUMB_DRAG
THUMB_RELEASE

### THUMB_RELEASE

Constant

`public static const THUMB_RELEASE:String = "thumbRelease"`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Defines the value of the `type` property of a `thumbRelease` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`clickTarget` | Identifies whether the slider track or a slider thumb was pressed.
`currentTarget` | The object that is actively processing the event object with an event listener.
`keyCode` | If the event was triggered by a key press, the code for the key that was pressed.
`target` | The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.
`triggerEvent` | The type of device that triggered the event. A value of `InteractionInputType.MOUSE` indicates that a mouse was the source of the input; a value of `InteractionInputType.KEYBOARD` indicates that a keyboard was the source of the input.
`value` | The value of the slider after the event.

Related API Elements

THUMB_DRAG
THUMB_PRESS

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00