ContextData  - AS3 Asset Composer

Instance of a Data Dictionary.

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

True if nested empty conditions (nested conditional modules that produce no output) should be included in the resolved content list. This is essential when the client is trying to determine the full extent of the content that resulted when a condition was evaluated -- if the condition was nested and had no output, there would be no output for the outer condition but the client still needs to know that the nested condition was actually output from the outer condition.

Note: When this flag is true and an empty nested condition is encountered while resolving a list/condition, a ResolvedContent object with its empty property set to true will be included in the resolved content list. This ResolvedContent object's lineage will have the the empty nested condition as its youngest parent (meaning that the ResolvedContent object represents an "empty module content placeholder" within the empty nested condition).

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

Related API Elements

True if nested empty lists (nested list modules that produce no output) should be included in the resolved content list. This is essential when the caller is trying to determine the full extend of the content that resulted when a list was resolved. If a list contained an empty list and this flag is false, the nested empty list produces no resolved content. Otherwise (this flag is true) the nested empty list will produce a piece of empty content in the content set returned from the module resolver. Empty lists may also result from conditions. If this flag is true, empty nested lists will be included in condition results, if applicable.

Note: When this flag is true and an empty nested list is encountered while resolving a list/condition, a ResolvedContent object with its empty property set to true will be included in the resolved content list. This ResolvedContent object's lineage will have the the empty nested list as its youngest parent (meaning that the ResolvedContent object represents an "empty module content placeholder" within the empty nested list).

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

Related API Elements

Map of variable name (String) to variable value (String).

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

Content to use for module resolution instead of module's persisted content. This is typically set when the module's content has been edited on the client yet contains variable tokens that need to be resolved. The content specified is expected to be compatible with the textContentOverrideMimeType property. If this property is null, the module's original content is used. If empty, it is assumed that the module's content was edited and is now empty (which means the response will be empty content).

Note: This applies to any module type whose content can be edited as text by the user during letter filling.

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

MIME type for the text content override. One of MimeType.TYPE constant values.

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

True if XHTML content should be used when resolving text modules; false if Flex Rich Text should be used. Defaults to true.

Note: If textContentOverride is specified, the textContentOverrideMimeType type will override this property.

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

Collection of Variable objects to use for module resolution instead of the module's persisted set of variables. This is typically set when the module's content has been edited on the client and variables have been added/removed. If this property is null, the module's original persisted set of variables is used. If empty, it is assumed that the module's content was edited and no longer contains any variables to resolve.

Note: This applies to any module type whose content can be edited as text by the user during letter filling.

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

Maps a variable name to a &-delimited string of variable substution options and associated values that provide instructions specific to the substitution of the variable within the content. Supported options and values are as follows:

• keepToken: 0 (default; replace token whether the variable's value is empty or not), 1 (leave token if variable's value is empty).
• forcePlaceholder: 0 (default; DDE variables are treated normally and the data dictionary instance is used to retrieve their values), 1 (DDE variables are treated as normal placeholders: a value will be sought in the localVariables property instead of using the data dictionary).

The absense from this map of the name of a variable found in the localVariables property indicates that defaults should be used.

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

Constructor

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

Convenience method to apply the specified rule to the specified variable in the variableSubstitutionRules property. If the rule always exists, its value is updated.

Parameters

Related API Elements

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

Substitution rule for forcing a variable's type to placeholder. Values: 0 (default), 1.

Substitution rule for retaining the token of a variable with an empty value. Values: 0 (default), 1.