ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.exm.authoring.domain.variable 

IVariableProvider  - AS3 Expression Manager
Packagecom.adobe.solutions.exm.authoring.domain.variable
Interfacepublic interface IVariableProvider extends IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The IVariableProvider interface serves as the entry point for variable-specific operations during expression authoring.


Public Methods
 MethodDefined By
 Inherited
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
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
listVariables():String
Fires an asynchronous operation for retrieving the list of all variables available for use inside expressions during authoring.
IVariableProvider
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
searchVariables(searchTerm:String):String
Fires an asynchronous operation for retrieving the list of available variables which match the given search term.
IVariableProvider
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Events
Click for more information on events
 Event Summary Defined By
  
variableProviderError
Dispatched when the provider encounters an error retrieving a list of variables.IVariableProvider
  
variableProviderEvent
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.

Returns
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.

Returns
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.




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

 

Legal Notices | Online Privacy Policy