mx.events

# DateChooserEvent - AS3 Flex

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

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

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

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
|  | 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
|  | detail : String Indicates the direction of scrolling. | DateChooserEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | triggerEvent : Event The event that triggered this change; usually a scroll. | DateChooserEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | DateChooserEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, triggerEvent:Event = null) Constructor. | DateChooserEvent
|  | 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
Hide Inherited Public Constants
Show Inherited 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`.

Related API Elements

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`.

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