| Package | com.adobe.mosaic.om.interfaces |
| Interface | public interface IContext |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
IContext interface models a simple hash map that allows tiles to store attibutes
in name-value pairs. The name-value pairs are uniquely identified by their names, and any tile can
reference a name-value pair using the unique identifier.
The context is specific to its accessor. For example, the mosaicApp.context is shared for the application, whereas the IView.context is shared for only the specific view.
| Method | Defined By | ||
|---|---|---|---|
Adds a watcher to a specific set of context attributes. | IContext | ||
Adds a watcher to the context. | IContext | ||
Returns a named attribute from the context. | IContext | ||
Returns an array of named attributes from the context. | IContext | ||
Removes a watcher from a specific set of context attributes. | IContext | ||
Removes a watcher from the context. | IContext | ||
Sets a single attribute in the context to a value. | IContext | ||
Sets an array of context attributes. | IContext | ||
addAttributesWatcher | () | method |
public function addAttributesWatcher(name:Array, listener:Object, tile:com.adobe.mosaic.om.interfaces:ITile):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Adds a watcher to a specific set of context attributes.
The watcher only triggers when all the attributes are set by a call to setAttributes that
matches the list of watched attributes.
Parameters
name:Array — The name of the context object to watch.
| |
listener:Object — A function that takes in one parameter of type PropertyChangeEvent that will be
called any time a set is called with this name.
| |
tile:com.adobe.mosaic.om.interfaces:ITile — The tile that added the watcher. The tile must be specified in order for the tile
to observe its contextWatcherPolicy
|
Related API Elements
addAttributeWatcher | () | method |
public function addAttributeWatcher(name:String, listener:Object, tile:com.adobe.mosaic.om.interfaces:ITile):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Adds a watcher to the context.
The context watchers behave similar to watchers in Flex, with the exception that the context attributes do not need to be set in advance of creating the watcher. This way a tile can watch for an attribute that has not previously been set.
Parameters
name:String — The name of the context object to watch.
| |
listener:Object — A function that takes in one parameter of type PropertyChangeEvent that will be called any time a set is called with this name.
| |
tile:com.adobe.mosaic.om.interfaces:ITile — The ITile with the reference to the attribute being watched
|
Related API Elements
getAttribute | () | method |
public function getAttribute(name:String):*| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns a named attribute from the context.
Parameters
name:String — The name of the attribute to retrieve.
|
* — The attribute stored in the context.
|
Related API Elements
getAttributes | () | method |
public function getAttributes(names:Array):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns an array of named attributes from the context.
Parameters
names:Array — The names of the attributes to retrieve.
|
Array — The objects stored in the context.
|
Related API Elements
removeAttributesWatcher | () | method |
public function removeAttributesWatcher(names:Array, listener:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Removes a watcher from a specific set of context attributes.
The watcher only triggers when all the attributes are set by a call to setAttributes that
matches the list of watched attributes.
Parameters
names:Array — The name of the context object to no longer watch.
| |
listener:Object — A function that takes in one parameter of type PropertyChangeEvent that will be
called any time a set is called with this name.
|
Related API Elements
removeAttributeWatcher | () | method |
public function removeAttributeWatcher(name:String, listener:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Removes a watcher from the context.
The context watchers behave similar to watchers in Flex, with the exception that the context attributes do not need to be set in advance of creating the watcher. This way a tile can watch for an attribute that has not previously been set.
Parameters
name:String — The name of the context object to no longer watch.
| |
listener:Object — A function that takes in one parameter of type PropertyChangeEvent that will be
called any time a set is called with this name.
|
Related API Elements
setAttribute | () | method |
public function setAttribute(name:String, value:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Sets a single attribute in the context to a value. Attribute names must follow the variable naming conventions in ActionScript (must start with a letter, etc).
Parameters
name:String — The name of the attribute to set.
| |
value:* — An object to store in the context.
|
Related API Elements
setAttributes | () | method |
public function setAttributes(names:Array, values:Array):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Sets an array of context attributes.
This method differs from setAttribute() in that it sets the values of many attributes at once. If a watcher for this set of attributes was previously added with addAttributesWatcher(), then this method will trigger a PropertyChangeEvent.
Example:
context.addAttributesWatcher(arrayAttributeNames, handleContextAttributesChanged, m_tileThis);
context.setAttributes(arrayAttributeNames, arrayAttributeValues);
// Handler for the multiple-attributes-changed event caused by IContext.setAttributes()
private function handleContextAttributesChanged(event:PropertyChangeEvent):void {
var nNumAttributesNames:int = event.property.length;
var strNewAttributeValuesInfo:String = "";
for (var nAttributeCounter:int = 0; nAttributeCounter < nNumAttributesNames; nAttributeCounter++) {
var strAttributeName:String = event.property[nAttributeCounter].toString();
var strOldAttributeValue:String = event.oldValue[nAttributeCounter].toString();
var strNewAttributeValue:String = event.newValue[nAttributeCounter].toString();
strNewAttributeValuesInfo += 'Attribute "' + strAttributeName + '" value changed from "' + strOldAttributeValue + '" to "' + strNewAttributeValue + '"';
}
Alert.show(strNewAttributeValuesInfo);
}
Parameters
names:Array — An array of the names of attributes to set in the context.
| |
values:Array — An array of the values to set for the attributes.
|
Related API Elements
Thu Dec 4 2014, 05:50 PM -08:00