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

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

See also

mx.controls.DateChooser
mx.controls.DateField

Public Properties

| Property | Defined By
--- | --- | ---
|  | newDate : Date The selected date of the control. | CalendarLayoutChangeEvent
|  | triggerEvent : Event The event that triggered the change of the date; usually a change event. | CalendarLayoutChangeEvent

Public Methods

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

Public Constants

| Constant | Defined By
--- | --- | ---
|  | CHANGE : String = change [static] The CalendarLayoutChangeEvent.CHANGE constant defines the value of the type property of the event object for a change event. | CalendarLayoutChangeEvent

Property Detail

newDate | property

`public var newDate:Date`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The selected date of the control.

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 the change of the date; usually a `change` event.

Constructor Detail

CalendarLayoutChangeEvent | () | Constructor

`public function CalendarLayoutChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, newDate:Date = null, triggerEvent:Event = null)`

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 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.
| `newDate:Date` (default = `null`)`` — The date selected in the control.
| `triggerEvent:Event` (default = `null`)`` — The event that triggered this change event; usually a `change` event.

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 `CalendarLayoutChangeEvent.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
`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`.
`newDate` | The date selected in the control.
`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 `change` event.

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