ResolvedContent

Package	com.adobe.icc.vo.render
Class	public class ResolvedContent
Inheritance	ResolvedContent Object
Implements	IEventDispatcher

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

A value object for the resolved content of a module. It is returned after resolution via the IModuleResolverService.

Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		data : Object	ResolvedContent
		dataArray : ByteArray Resolved content.	ResolvedContent
		empty : Boolean True if the content is explicitly empty (e.g.	ResolvedContent
		isImage : Boolean [read-only] True if the resolved content is an image.	ResolvedContent
		isText : Boolean [read-only] True if the resolved content is text.	ResolvedContent
		lineage : Array Array of Array objects (sub-array element 0 is a String representing a module GUID, sub-array element 1 is an int representing the module's identifier) representing every parent module in the result's lineage if the content was nested in a list or condition.	ResolvedContent
		mimeType : String MIME type for the resolved content.	ResolvedContent
		moduleId : String GUID of the data module that was the source of the resolved content.	ResolvedContent
		moduleIdent : int The identifier of the module (in its container) from which this content is resolved.	ResolvedContent
		moduleType : String One of the MODULETYPEconst values.	ResolvedContent
		toolTip : String Tooltip associated with the content.	ResolvedContent

Public Methods

	Method		Defined By
		ResolvedContent() Constructor	ResolvedContent
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ResolvedContent
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ResolvedContent
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ResolvedContent
		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.	ResolvedContent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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.	ResolvedContent

Public Constants

	Constant		Defined By
		MODULETYPE_IMAGE : String = "image" [static] Specifies a resolved image module.	ResolvedContent
		MODULETYPE_TEXT : String = "text" [static] Specifies a resolved text module.	ResolvedContent

Property Detail

data

property

data:Object

Implementation
public function get data():Object
public function set data(value:Object):void

dataArray

property

dataArray:ByteArray

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Resolved content.

For text modules, this will be UTF-8 data (though not a proper UTF-8 byte stream so to read, you need to do dataArray.readUTFBytes(dataArray.length); as opposed to dataArray.readUTF(); which will throw an EOF error. Also note that for a text module, the resolved content will always be XHTML wrapped in the XFA Rich Text Body node, so it will be <body ...>{XHTML}</body>.

For image modules, this will be a base64-encoded string. To read it as string content, do so just like you would read the content of a text module (as above).

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

Implementation
public function get dataArray():ByteArray
public function set dataArray(value:ByteArray):void

empty

property

empty:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if the content is explicitly empty (e.g. represents a condition that had no output but was still included in the result set).

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

Implementation
public function get empty():Boolean
public function set empty(value:Boolean):void

isImage

property

isImage:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if the resolved content is an image.

Implementation
public function get isImage():Boolean

isText

property

isText:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

True if the resolved content is text.

Implementation
public function get isText():Boolean

lineage

property

lineage:Array

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Array of Array objects (sub-array element 0 is a String representing a module GUID, sub-array element 1 is an int representing the module's identifier) representing every parent module in the result's lineage if the content was nested in a list or condition. The array lists every parent in order from oldest to youngest. If the content was not nested, this property is null.

Example 1: If text module TM was the result of condition module CM, this array would contain a single entry: {{CM.id, 0}}.

Example 2: If text module TM was the result of list module LM which was, in turn, the result of condition module CM, this array would contain two entries in the following order: {{CM.id, 0}, {LM.id, 0}}.

Example 3: If list module LM was the result of condition module CM, LM had two instances of the same nested list NL which contained text module TM, the lineage for the first TM result would be as follows (note the identifiers): TM result #1: {{CM.id, 0}, {LM.id, 0}, {NL.id, 0}} TM result #2: {{CM.id, 0}, {LM.id, 0}, {NL.id, 1}} -- identifier is 1 to mark a second instance of NL, otherwise the client could only interpret the lineage as both instances of TM being contained in a single instance of NL which isn't reality.

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

Implementation
public function get lineage():Array
public function set lineage(value:Array):void

mimeType

property

mimeType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

MIME type for the resolved content. 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.

Implementation
public function get mimeType():String
public function set mimeType(value:String):void

moduleId

property

moduleId:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

GUID of the data module that was the source of the resolved content.

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

Implementation
public function get moduleId():String
public function set moduleId(value:String):void

moduleIdent

property

moduleIdent:int

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The identifier of the module (in its container) from which this content is resolved.

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

Implementation
public function get moduleIdent():int
public function set moduleIdent(value:int):void

moduleType

property

moduleType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

One of the MODULETYPEconst values.

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

Implementation
public function get moduleType():String
public function set moduleType(value:String):void

toolTip

property

toolTip:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Tooltip associated with the content. For an image module, this should be identical to the image module's caption.

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

Implementation
public function get toolTip():String
public function set toolTip(value:String):void

Constructor Detail

ResolvedContent

()

Constructor

public function ResolvedContent()

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Constructor

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

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

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

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

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

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

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

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

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

willTrigger

()

method

public function 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. 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.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Constant Detail

MODULETYPE_IMAGE

Constant

public static const MODULETYPE_IMAGE:String = "image"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies a resolved image module.

MODULETYPE_TEXT

Constant

public static const MODULETYPE_TEXT:String = "text"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

Specifies a resolved text module.

Legal Notices | Online Privacy Policy

ResolvedContent - AS3 Asset Composer

Classes x

data

dataArray

empty

isImage

isText

lineage

mimeType

moduleId

moduleIdent

moduleType

toolTip

ResolvedContent

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger

MODULETYPE_IMAGE

MODULETYPE_TEXT