| Package | com.adobe.solutions.exm.authoring.domain.variable |
| Interface | public interface IVariableProvider extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Expression Manager Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Fires an asynchronous operation for retrieving the list of all variables available for use inside expressions
during authoring. | IVariableProvider | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Fires an asynchronous operation for retrieving the list of available variables which match the given search term. | IVariableProvider | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the provider encounters an error retrieving a list of variables. | IVariableProvider | |||
| Dispatched when the provider successfully retrieves a list of variables. | IVariableProvider | |||
Method Detail
listVariables | () | method |
public function listVariables():String| Language Version: | ActionScript 3.0 |
| Product Version: | Expression Manager Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Fires an asynchronous operation for retrieving the list of all variables available for use inside expressions during authoring. Returns immediately and causes the current object to later dispatch one of the following events:
- If the operation completes successfuly, an event with name "variableProviderEvent" of type VariableProviderEvent. The 'variables' property of the event will be a reference to the list of available variables (IVariable objects). The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
- If the operation errors out, an event with name "variableProviderError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.
String — A unique request ID which calling code can use for correlating invocations of this method
with events dispatched later.
|
searchVariables | () | method |
public function searchVariables(searchTerm:String):String| Language Version: | ActionScript 3.0 |
| Product Version: | Expression Manager Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Fires an asynchronous operation for retrieving the list of available variables which match the given search term. Returns immediately and causes the current object to later dispatch one of the following events:
- If the operation completes successfuly, an event with name "variableProviderEvent" of type VariableProviderEvent. The 'variables' property of the event will be a reference to the list of matching variables (IVariable objects). The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
- If the operation errors out, an event with name "variableProviderError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.
Parameters
searchTerm:String — The search term to be used for filtering variables.
|
String — A unique request ID which calling code can use for correlating invocations of this method
with events dispatched later.
|
Event Detail
variableProviderError | Event |
Event Object Type:
com.adobe.solutions.exm.authoring.domain.RequestAwareErrorEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Expression Manager Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Dispatched when the provider encounters an error retrieving a list of variables.
variableProviderEvent | Event |
Event Object Type:
com.adobe.solutions.exm.authoring.domain.variable.VariableProviderEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Expression Manager Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Dispatched when the provider successfully retrieves a list of variables.
Mon Nov 28 2011, 06:48 AM -08:00