Packagecom.adobe.cairngorm.control
Classpublic class CairngormEvent
InheritanceCairngormEvent Inheritance flash.events.Event

The CairngormEvent class is used to differentiate Cairngorm events from events raised by the underlying Flex framework (or similar). It is mandatory for Cairngorm event dispatching.

For more information on how event dispatching works in Cairngorm, please check with CairngormEventDispatcher.

Events are typically broadcast as the result of a user gesture occuring in the application, such as a button click, a menu selection, a double click, a drag and drop operation, etc.

See also

com.adobe.cairngorm.control.CairngormEventDispatcher


Public Properties
 PropertyDefined by
  data : *
The data property can be used to hold information to be passed with the event in cases where the developer does not want to extend the CairngormEvent class.
CairngormEvent
Public Methods
 MethodDefined by
  
CairngormEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Constructor, takes the event name (type) and data object (defaults to null) and also defaults the standard Flex event properties bubbles and cancelable to true and false respectively.
CairngormEvent
  
dispatch():Boolean
Dispatch this event via the Cairngorm event dispatcher.
CairngormEvent
Property detail
dataproperty
public var data:*

The data property can be used to hold information to be passed with the event in cases where the developer does not want to extend the CairngormEvent class. However, it is recommended that specific classes are created for each type of event to be dispatched.

Constructor detail
CairngormEvent()constructor
public function CairngormEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Constructor, takes the event name (type) and data object (defaults to null) and also defaults the standard Flex event properties bubbles and cancelable to true and false respectively.

Parameters
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
Method detail
dispatch()method
public function dispatch():Boolean

Dispatch this event via the Cairngorm event dispatcher.

Returns
Boolean