TBX

Package	com.adobe.consulting.pst.vo
Class	public class TBX
Inheritance	TBX DataModule Object

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 value object for a text module. Extends basic attributes from the DataModule class.

Related API Elements

com.adobe.icc.vo.DataModule

Public Properties

	Property		Defined By
		activeEndDate : Date	DataModule
		activeStartDate : Date	DataModule
		comment : String Specifies a comment associated with the last change or update to the data module.	DataModule
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		crxVersion : String Version of the data module in repository	DataModule
		dataDictionaryRef : String Data Dictionary Reference	DataModule
		dataDictionaryRefs : ArrayCollection	DataModule
		desc : String Gets the description for this data module.	DataModule
		dmType : int [read-only] Fetch the type of data module 0 : Text 2 : Image 3 : Condition 4 : List	DataModule
		extendedProperties : Object extendedProperties Map for AssetManager Backend use case	DataModule
		fileName : String	TBX
		flashHtml : String Get/set the Flash HTML/Flex Rich Text version of the content.	TBX
		hasVariables : Boolean [read-only] True if the module has variables in its content.	DataModule
		id : String Specifies the unique identifier for this data module.	DataModule
		lastChangeBy : String Specifies the last user who completed a change.	DataModule
		lastPublishDate : Date Specifies the last publish date of the data module	DataModule
		lastUpdateDate : Date	DataModule
		lcat : Category Specifies the subcategory for the data module.	DataModule
		lcatName : String [read-only] Speifies the sub category associated with this data Module.	DataModule
		name : String Specifies the name of the data module.	DataModule
		plainText : String Get/set the plain text version of the content.	TBX
		state : int Specifies the state of the data module	DataModule
		TBXXML : String Get/set the TBXXML content: XML serialized as a String.	TBX
		TBXXMLBytes : ByteArray	TBX
		tlfText : String Get/set the TLF Markup Text version of the content.	TBX
		ucat : Category Specifies the main category for the data module.	DataModule
		ucatName : String [read-only] Speifies the main category associated with this data Module.	DataModule
		updatedBy : String Specifies the constant string indicating the data module was updated by UPDATED_BY_NONE The asset has not been updated after publishing. UPDATED_BY_USER The asset has been updated by only user. UPDATED_BY_SYSTEM The asset has been updated by only system. UPDATED_BY_USER_AND_SYSTEM The asset has been updated by both user and system.	DataModule
		variableList : ArrayCollection List of Variable objects for each variable used by this module.	DataModule
		version : int	DataModule
		xhtml : String Get/set the XFA XHTML version of the content.	TBX

Public Methods

	Method		Defined By
		TBX() Constructor	TBX
		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.	DataModule
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	DataModule
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	DataModule
		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.	DataModule
		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 [override] Returns the string representation of the specified object.	TBX
		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.	DataModule

Public Constants

	Constant		Defined By
		BINDEVENT_FLASH_CHANGE : String = "bindFlashChange" [static] Binding event dispatched when the Flash HTML content changes.	TBX
		BINDEVENT_PLAIN_CHANGE : String = "bindPlainChange" [static] Binding event dispatched when the Plain Text content changes.	TBX
		BINDEVENT_TBXXML_CHANGE : String = "bindTbxxmlChange" [static] Binding event dispatched when the TBXXML property changes.	TBX
		BINDEVENT_TLF_CHANGE : String = "bindTLFChange" [static] Binding event dispatched when the TLF content changes.	TBX
		BINDEVENT_XHTML_CHANGE : String = "bindXhtmlChange" [static] Binding event dispatched when the XHTML content changes.	TBX
		PROTECTED_VAR_POSTFIX : String = "unknown" [static] Protected variable postfix.	TBX
		PROTECTED_VAR_PREFIX : String = "unknown" [static] Protected variable prefix.	TBX
		UNPROTECTED_VARIABLE_POSTFIX : String = "unknown" [static] Unprotected variable postfix.	TBX
		UNPROTECTED_VAR_PREFIX : String = "unknown" [static] Unprotected variable prefix.	TBX

Property Detail

fileName

property

fileName:String

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

flashHtml

property

flashHtml:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Get/set the Flash HTML/Flex Rich Text version of the content. Note that this value will contain mutliple top-level entities such as <TEXTFORMAT> elements. This is the nature of Flex Rich Text and helps with concatenation.

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 flashHtml():String
public function set flashHtml(value:String):void

plainText

property

plainText:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Get/set the plain text version of the 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 plainText():String
public function set plainText(value:String):void

TBXXML

property

TBXXML:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Get/set the TBXXML content: XML serialized as a String. Combination of xhtml, flashHtml,tlfText and plainText content for the module.

Note: Rather than reading or setting this property directly, we encourage the use of the xhtml, flashHtml,tlfText and plainText properties which will get/set this property correctly.

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 TBXXML():String
public function set TBXXML(value:String):void

TBXXMLBytes

property

TBXXMLBytes:ByteArray

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

tlfText

property

tlfText:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Get/set the TLF Markup Text version of the 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 tlfText():String
public function set tlfText(value:String):void

xhtml

property

xhtml:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Get/set the XFA XHTML version of the content. Note that this value is never wrapped in a <body ...> node and may contain multiple top-level entities such as <p> elements. This is essential such that text module values can be easily concatenated together.

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 xhtml():String
public function set xhtml(value:String):void

Constructor Detail

TBX

()

Constructor

public function TBX()

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Constructor

Method Detail

toString

()

method

override public function toString():String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Returns the string representation of the specified object.

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, a subclass of Object implements function toString():String instead of using an override of the base class.

Returns

String — A string representation of the object.

Constant Detail

BINDEVENT_FLASH_CHANGE

Constant

public static const BINDEVENT_FLASH_CHANGE:String = "bindFlashChange"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Binding event dispatched when the Flash HTML content changes.

BINDEVENT_PLAIN_CHANGE

Constant

public static const BINDEVENT_PLAIN_CHANGE:String = "bindPlainChange"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Binding event dispatched when the Plain Text content changes.

BINDEVENT_TBXXML_CHANGE

Constant

public static const BINDEVENT_TBXXML_CHANGE:String = "bindTbxxmlChange"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Binding event dispatched when the TBXXML property changes.

BINDEVENT_TLF_CHANGE

Constant

public static const BINDEVENT_TLF_CHANGE:String = "bindTLFChange"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Binding event dispatched when the TLF content changes.

BINDEVENT_XHTML_CHANGE

Constant

public static const BINDEVENT_XHTML_CHANGE:String = "bindXhtmlChange"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Binding event dispatched when the XHTML content changes.

PROTECTED_VAR_POSTFIX

Constant

public static const PROTECTED_VAR_POSTFIX:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Protected variable postfix.

PROTECTED_VAR_PREFIX

Constant

public static const PROTECTED_VAR_PREFIX:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Protected variable prefix.

UNPROTECTED_VAR_PREFIX

Constant

public static const UNPROTECTED_VAR_PREFIX:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Unprotected variable prefix.

UNPROTECTED_VARIABLE_POSTFIX

Constant

public static const UNPROTECTED_VARIABLE_POSTFIX:String = "unknown"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Unprotected variable postfix.

Legal Notices | Online Privacy Policy

TBX - AS3 Asset Composer

Classes x

fileName

flashHtml

plainText

TBXXML

TBXXMLBytes

tlfText

xhtml

TBX

toString

BINDEVENT_FLASH_CHANGE

BINDEVENT_PLAIN_CHANGE

BINDEVENT_TBXXML_CHANGE

BINDEVENT_TLF_CHANGE

BINDEVENT_XHTML_CHANGE

PROTECTED_VAR_POSTFIX

PROTECTED_VAR_PREFIX

UNPROTECTED_VAR_PREFIX

UNPROTECTED_VARIABLE_POSTFIX