IContext - BETA ActionScript® 3 (AS3 ADEP Composite Application) Reference for the Adobe® Flash® Platform API Reference

(Beta)

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.0.2, Flash Player 10.1

The 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 mosaicApp.parentView.context is shared for only the specific view.

View the examples

Public Methods

	Method		Defined By
		addAttributesWatcher(name:Array, listener:Object):void Adds a watcher to a specific set of context attributes.	IContext
		addAttributeWatcher(name:String, listener:Object):void Adds a watcher to the context.	IContext
		getAttribute(name:String):* Returns a named attribute from the context.	IContext
		getAttributes(names:Array):Array Returns an array of named attributes from the context.	IContext
		removeAttributesWatcher(names:Array, listener:Object):void Removes a watcher from a specific set of context attributes.	IContext
		removeAttributeWatcher(name:String, listener:Object):void Removes a watcher from the context.	IContext
		setAttribute(name:String, value:*):void Sets a single attribute in the context to a value.	IContext
		setAttributes(names:Array, values:Array):void Sets an array of context attributes.	IContext

Method Detail

Examples How to use this example

IContext_example.mxml

Copy

<?xml version="1.0" encoding="utf-8"?>
<mc:Tile xmlns:fx="http://ns.adobe.com/mxml/2009"
         xmlns:mx="library://ns.adobe.com/flex/halo"
         xmlns:s="library://ns.adobe.com/flex/spark"
         xmlns:mc="com.adobe.mosaic.core.*" xmlns:comps="*"
         layout="absolute" width="100%" height="100%"
         applicationComplete="{setMyAttributeValue();getMyAttributeValue()}"> 

    <fx:Script>
        <![CDATA[
        import com.adobe.mosaic.om.interfaces.IContext; 

        private const M_STR_MY_ATTRIBUTE_NAME:String = "MyAttribute";

        // Set the value of an application context variable
        private function setMyAttributeValue():void
        {
            var appContext:IContext = this.mosaicApp.context;
            appContext.setAttribute(M_STR_MY_ATTRIBUTE_NAME, "My attribute value");
        }  // setMyAttributeValue

        // Get the value of an application context variable
        private function getMyAttributeValue():void
        {
            var appContext:IContext = this.mosaicApp.context;
            var strMyAttributeValue:String = appContext.getAttribute(M_STR_MY_ATTRIBUTE_NAME);
            labelAttributeValue.text = strMyAttributeValue;
        }
        ]]>
    </fx:Script>

    <s:Label id="labelAttributeValue" text=""/>

</mc:Tile>

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

IContext - AS3 ADEP Composite Application

Packagesx

Language Elements

Appendixes

Package com.adobe.mosaic.om.interfaces

addAttributesWatcher

addAttributeWatcher

getAttribute

getAttributes

removeAttributesWatcher

removeAttributeWatcher

setAttribute

setAttributes

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

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

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

	`name:String` — The name of the attribute to set.

	`value:*` — An object to store in the context.

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