Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
| Class | Package | Description | |
|---|---|---|---|
| CairngormError
| com.adobe.cairngorm | ||
| CairngormEvent
| com.adobe.cairngorm.control | The CairngormEvent class is mandatory for Cairngorm event dispatching. | |
| CairngormEventDispatcher
| com.adobe.cairngorm.control | The CairngormEventDispatcher class is a singleton class, used by the application developer to broadcast events that correspond to user gestures and requests. | |
| CairngormMessageCodes
| com.adobe.cairngorm | All messages/error codes must match the regular expression: C\d{4}[EWI] 1. | |
| Command
| com.adobe.cairngorm.commands |
Deprecated as of Cairngorm 2.1, replaced by com.adobe.cairngorm.commands.ICommand
The Command interface enforces the contract between the Front Controller and concrete command classes in your application. In a Cairngorm application, the application specific Front Controller will listen for events of interest, dispatching control to appropriate command classes according to the type of the event broadcast. When an event is broadcasted by the Front Controller, it will lookup its list of registered commands, to find the command capable of carrying out the appropriate work in response to the user gesture that has caused the event. |
|
| FrontController
| com.adobe.cairngorm.control | A base class for an application specific front controller, that is able to dispatch control following particular user gestures to appropriate command classes. | |
| ICommand
| com.adobe.cairngorm.commands | The ICommand interface enforces the contract between the Front Controller and concrete command classes in your application. | |
| IServiceLocator
| com.adobe.cairngorm.business | ||
| IValueObject
| com.adobe.cairngorm.vo | The IValueObject interface is a marker interface that improves readability of code by identifying the classes within a Cairngorm application that are to be used as value objects for passing data between tiers of an application. | |
| ModelLocator
| com.adobe.cairngorm.model | Marker interface used to mark the custom ModelLocator. | |
| Responder
| com.adobe.cairngorm.business |
Deprecated as of Cairngorm 2.1, replaced by mx.rpc.IResponder
The Responder interface is implemented by classes that wish to handle data returned as the result of a service-call to the server. Typically, a server-side call will be made using a service that is defined on the ServiceLocator. |
|
| SequenceCommand
| com.adobe.cairngorm.commands | The SequenceCommand is provided as a "psuedo-abstract" (since ActionScript has no real concept of abstract classes) base-class that can be extended when you wish to chain commands together for a single user-gesture, or establish some simple form of decision-based workflow. | |
| ServiceLocator
| com.adobe.cairngorm.business | ||
| ValueObject
| com.adobe.cairngorm.vo |
Deprecated as of Cairngorm 2.1, replaced by com.adobe.cairngorm.vo.IValueObject
The ValueObject interface is a marker interface that improves readability of code by identifying the classes within a Cairngorm application that are to be used as value objects for passing data between tiers of an application. Currently, this interface does not require the implementation of any methods; the developer is free to extend this interface according to their preferred ValueObject implementation. |
|
| ViewHelper
| com.adobe.cairngorm.view | Used to isolate command classes from the implementation details of a view. | |
| ViewLocator
| com.adobe.cairngorm.view | The ViewLocator is a singleton class, that is used to retreive ViewHelper classes that can manipulate (get/set/switch) the user interface of a Cairngorm RIA. |