DDIModelVariableResolver

Package	com.adobe.dct.exp
Class	public class DDIModelVariableResolver
Inheritance	DDIModelVariableResolver EventDispatcher Object
Implements	IVariableResolver

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Used by the Expression Manager for resolving any variable references encountered in an expression, for setting the values of variables which are targets of expressions and for being notified of externally triggered changes in variable values. A IVariableResolver implementation must dispatch a VariableChangeEvent of type "variableChangeEvent" whenever the value of a variable managed by the resolver changes. This variable resolver works with a list of data dictionary instance models.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataDictionaryInstanceModelList : IList The underlying list of data dictionary instance models.	DDIModelVariableResolver

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DDIModelVariableResolver(ddiModelList:IList = null) Constructor.	DDIModelVariableResolver
		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.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getValue(varName:String):Object Gets the value of data dictionary element of a particular data dictionary.	DDIModelVariableResolver
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setValue(varName:String, value:Object):void Sets the value of data dictionary element of a particular data dictionary.	DDIModelVariableResolver
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
variableChangeEvent	Dispatched when the value of a variable is changed.	DDIModelVariableResolver

Public Constants

	Constant		Defined By
		DD_PREFIX : String = "DD_" [static] Prefix for the key i.e.	DDIModelVariableResolver
		keyDelimiter : String = "_" [static] This key delimiter.	DDIModelVariableResolver

Property Detail

dataDictionaryInstanceModelList

property

dataDictionaryInstanceModelList:IList

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The underlying list of data dictionary instance models.

This property can be used as the source for data binding. When this property is modified, it dispatches the dataDictionaryInstanceListChanged event.

Implementation
public function get dataDictionaryInstanceModelList():IList
public function set dataDictionaryInstanceModelList(value:IList):void

Constructor Detail

()

Constructor

public function DDIModelVariableResolver(ddiModelList:IList = null)

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Constructor.

Parameters

ddiModelList:IList (default = null) — list of data dictionary instance models.

Method Detail

getValue

()

method

public function getValue(varName:String):Object

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Gets the value of data dictionary element of a particular data dictionary.

Parameters

varName:String — the variable name which can uniquely identify a data dictionary element. The variable has to comply with the format DD_DataDictionaryName_DDEReferenceName.

Returns

Object — A value of null if the value of data dictionary element is null. undefined if the data dictionary element key is missing in data dictionary instance. typed value if the value for data dictionary element is present in DDI.

setValue

()

method

public function setValue(varName:String, value:Object):void

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Sets the value of data dictionary element of a particular data dictionary.

Parameters

	`varName:String` — the variable name which can uniquely identify a data dictionary element. The variable has to comply with the format DD_DataDictionaryName_DDEReferenceName.

	`value:Object` — the value of data dictionary element to be set.

Event Detail

variableChangeEvent

Event

Event Object Type: com.adobe.solutions.exm.runtime.VariableChangeEvent
property VariableChangeEvent.type = com.adobe.solutions.exm.runtime.VariableChangeEvent

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Dispatched when the value of a variable is changed. This event, being bubbling in nature, can be leveraged by the UI to update itself.

Constant Detail

DD_PREFIX

Constant

public static const DD_PREFIX:String = "DD_"

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Prefix for the key i.e. ({DD_PREFIX}{DD name}.{DDE reference name}).

keyDelimiter

Constant

public static const keyDelimiter:String = "_"

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

This key delimiter. It is used to delimit the various parts of the key i.e DD_DataDictionaryName_DDEReferenceName.

DDIModelVariableResolver - AS3 Data Dictionary

Classes x

dataDictionaryInstanceModelList