ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.events 

DateChooserEvent  - AS3 Flex
Packagemx.events
Classpublic class DateChooserEvent
InheritanceDateChooserEvent Inheritance Event Inheritance 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
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : 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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
  triggerEvent : Event
The event that triggered this change; usually a scroll.
DateChooserEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
DateChooserEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, detail:String = null, triggerEvent:Event = null)
Constructor.
DateChooserEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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 scrollevent.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
detailThe scroll direction.
targetThe 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.
triggerEventThe event that triggered this change event; usually a scroll.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy