TextModuleInstance

Package	com.adobe.icc.dc.domain
Class	public class TextModuleInstance
Inheritance	TextModuleInstance BaseModuleInstance EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

This class is the runtime representation of the text module present in the letter.

Public Properties

	Property		Defined By
		assignedPosition : int [read-only] The assigned position of the module within its container.	BaseModuleInstance
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contentVariables : IList [read-only] The set of active variables for the module.	BaseModuleInstance
		description : String [read-only] Description associated with this ModuleInstance.	BaseModuleInstance
		editable : Boolean [read-only] True if this module is editable in its container (based on the assignment).	BaseModuleInstance
		extra : Boolean [read-only] The flag indicating if this module was not assigned while creating the letter.	BaseModuleInstance
		freeText : Boolean [read-only] Checks if given module is added as free form text	TextModuleInstance
		hasConflict : Boolean [read-only] The flag indicating if this module is conflicting with its latest version.	BaseModuleInstance
		id : String [read-only] Unique identification associated with this ModuleInstance.	BaseModuleInstance
		indentationLevel : Number The level of indentation of the module with respect to the container holding the module instance.	BaseModuleInstance
		moduleType : String [override] [read-only] Module type represented by this ModuleInstance: Text,Image,List,Condition	TextModuleInstance
		moduleVo : DataModule [override] [read-only] The instance of DataModule associated with this module instance.	TextModuleInstance
		name : String [read-only] Name associated with this ModuleInstance.	BaseModuleInstance
		newLine : Boolean [read-only] Checks if given module is newline module	TextModuleInstance
		newMandatory : Boolean [read-only] The flag indicating if this module was not mandatory earlier but is now mandatory when considering the latest version of the module instance.	BaseModuleInstance
		nonEditableOverride : Boolean [read-only] The flag indicating if this module was editable earlier but is now non-editable when considering the latest version of the module instance.	BaseModuleInstance
		occur : int The occurrence index of this content within its parent container.	BaseModuleInstance
		optional : Boolean [read-only] True if this module is optional in its container (based on the assignment, not the selected state).	BaseModuleInstance
		parentContainer : IContainerInstance [read-only] Parent container instance containing this ModuleInstance	BaseModuleInstance
		preSelected : Boolean [read-only] True if this module is pre-selected/removable in its container (based on the assignment, not the selected state).	BaseModuleInstance
		rawContent : String [read-only] he raw content on a text module.	TextModuleInstance
		rawContentFormat : String [read-only] Returns the module's raw content type.	TextModuleInstance
		resolvedContent : String [read-only] The module's resolved content value.	TextModuleInstance
		resolvedContentFormat : String [read-only] Returns the module's resolved content type.	TextModuleInstance
		selected : Boolean Is the module is selected to be included in letter	BaseModuleInstance
		selectedPosition : int Position of the content in it's container among all the selected contents of the container.	BaseModuleInstance
		skipStyle : Boolean [read-only] Skip Style of the module.	BaseModuleInstance
		tooltip : String [read-only] Tooltip associated with this ModuleInstance.	BaseModuleInstance
		valid : Boolean [read-only] Boolean indicating whether the content is valid	BaseModuleInstance

Public Methods

	Method		Defined By
		TextModuleInstance(moduleData:ModuleData, vParentContainer:IContainerInstance = null, remod:ReloadModule = null) Constructor	TextModuleInstance
		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
		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
		refresh():void Refresh should be called when item is selected.	BaseModuleInstance
		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
		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

Protected Methods

	Method		Defined By
		moduleDataChangeHandler(event:ModuleDataEvent):void Called when the module content's associated data object changes.	BaseModuleInstance

Events

Click for more information on events

	Event		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

Property Detail

freeText

property

freeText:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Checks if given module is added as free form text

Implementation
public function get freeText():Boolean

moduleType

property

moduleType:String [read-only] [override]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Module type represented by this ModuleInstance: Text,Image,List,Condition

Implementation
override public function get moduleType():String

Related API Elements

com.adobe.icc.dc.domain.ModuleInstancefactory.MODULETYPE_TEXT

moduleVo

property

moduleVo:DataModule [read-only] [override]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The instance of DataModule associated with this module instance.

Implementation
override public function get moduleVo():DataModule

newLine

property

newLine:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Checks if given module is newline module

Implementation
public function get newLine():Boolean

rawContent

property

rawContent:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

he raw content on a text module.

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 rawContent():String

rawContentFormat

property

rawContentFormat:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Returns the module's raw content type.

Implementation
public function get rawContentFormat():String

resolvedContent

property

resolvedContent:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The module's resolved content value. Note that the module's isValid property should always be considered along with its value to properly interpret the meaning of the value, empty or not. It's possible to be in a state where the content isn't valid but there's still a resolve value (e.g. a mandatory variable doesn't have a value so its token is still in the content; therefore the module's content is invalid but it still has a value).

To get/set the module's raw content, use the rawContent property.

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 resolvedContent():String

Related API Elements

rawContent

resolvedContentFormat

property

resolvedContentFormat:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10.0

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Returns the module's resolved content type.

Implementation
public function get resolvedContentFormat():String

Constructor Detail