Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
DateChooserEvent

Package | mx.events
Class | public class DateChooserEvent
Inheritance | DateChooserEvent flash.events.Event

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The DateChooserEvent class represents the event object passed to the event listener for the `scroll` event for the DateChooser and DateField controls.

See also

mx.controls.DateChooser
mx.controls.DateField
mx.events.DateChooserEventDetail

Public Properties

| Property | Defined By
--- | --- | ---
|  | detail : String Indicates the direction of scrolling. | DateChooserEvent
|  | triggerEvent : Event The event that triggered this change; usually a scroll. | DateChooserEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | DateChooserEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, triggerEvent:Event = null) Constructor. | DateChooserEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | SCROLL : String = scroll [static] The DateChooserEvent.SCROLL constant defines the value of the type property of the event object for a scrollevent. | DateChooserEvent

Property Detail

detail | property

`public var detail:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates the direction of scrolling. The values are defined by the DateChooserEventDetail class. The possible values are `DateChooserEventDetail.NEXT_MONTH`, `DateChooserEventDetail.NEXT_YEAR`, `DateChooserEventDetail.PREVIOUS_MONTH`, or `DateChooserEventDetail.PREVIOUS_YEAR`.

See also

mx.events.DateChooserEventDetail

triggerEvent | property |

`public var triggerEvent:Event`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The event that triggered this change; usually a `scroll`.

Constructor Detail

DateChooserEvent | () | Constructor

`public function DateChooserEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, triggerEvent:Event = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor. Normally called by the DateChooser object and not used in application code.

Parameters

| `type:String` — The event type; indicates the action that triggered 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.
| `detail:String` (default = `null`)`` — Indicates the unit and direction of scrolling. The possible values are `DateChooserEventDetail.NEXT_MONTH`, `DateChooserEventDetail.NEXT_YEAR`, `DateChooserEventDetail.PREVIOUS_MONTH`, or `DateChooserEventDetail.PREVIOUS_YEAR`.
| `triggerEvent:Event` (default = `null`)`` — The event that triggered this change event; usually a `scroll`.

Constant Detail

SCROLL | Constant

`public static const SCROLL:String = scroll`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The `DateChooserEvent.SCROLL` constant defines the value of the `type` property of the event object for a `scroll`event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`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`.
`detail` | The scroll direction.
`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.
`triggerEvent` | The event that triggered this change event; usually a `scroll`.

Sun Mar 5 2017, 03:42 PM +11:00