TextModule (AEM Forms API)

java.lang.Object
- com.adobe.icc.dbforms.obj.Asset
- - com.adobe.icc.dbforms.obj.DataModule
  - - com.adobe.icc.dbforms.obj.TextModule

All Implemented Interfaces:

ILocalizable, ILocalizationResourceContainer, Serializable
```
public final class TextModule
extends DataModule
```
POJO representation of a Text module.
Extends basic attributes from Asset, and contains the text content (bytes), file name, etc.
The Text content is in the form of a well defined XML. A sample XML content:

<content>
 <guid/>
 <name>text_test</name>
 <desc>the description</desc>
 <plainText>This is a paragraph with a variable: {^var^}</plainText>
 <flashRichText><TEXTFORMAT LEADING="2" TABSTOPS="36,72,108,144,180,216,252,288,324,360,396,432,468,504,540,576,612,648,684,720"> This is a paragraph with a variable: {^var^}</TEXTFORMAT></flashRichText>
 <xfaXhtml><body xfa:APIVersion="2.4.5277.0" xmlns="http://www.w3.org/1999/xhtml" xmlns:xfa="http://www.xfa.org/schema/xfa-data/1.0/"> This is a paragraph with a variable: {^var^}</body></xfaXhtml>
</content>

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String ASSOCIATION_CUTPOINT

static String FIRST_LEVEL_CUTPOINT

static String HIERARCHY_CUTPOINT

static String TM_CLASS
- Fields inherited from class com.adobe.icc.dbforms.obj.DataModule
  DM_CLASS
- Fields inherited from class com.adobe.icc.dbforms.obj.Asset
  activeEndDate, activeStartDate, ASSET_CLASS, comment, crxVersion, desc, extendedProperties, FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT, folderId, id, lastChangeBy, lastPublishDate, lastPublishedBy, lastReplicationAction, lastUpdateDate, lastVersionDate, lcat, name, PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_TITLE, PROPERTY_NAME_VERSION, READY_TO_PUBLISH_CUTPOINT, state, tags, title, transientProperties, ucat, updatedBy, version

Fields
Modifier and Type	Field and Description
`static String`	`ASSOCIATION_CUTPOINT`
`static String`	`FIRST_LEVEL_CUTPOINT`
`static String`	`HIERARCHY_CUTPOINT`
`static String`	`TM_CLASS`

Constructor Summary

Constructors
Constructor and Description
`TextModule()` Default constructor
`TextModule(String textModuleName, String desc, int version, String comment, int state, Date start, Date end, String lastChange, String dataDictionaryRef, String fileName, String tbxXml)` Constructor from parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getContentXML()` Get the XML content of the Text module as a `String`.
`byte[]`	`getContentXMLBytes()` Get the XML content of the Text module as a byte array.
`String`	`getFileName()` Get the file name of the Text module.
`boolean`	`isNoPageBreak()`
`void`	`setContentXML(String string)` Sets the XML content of the Text module as a `String`.
`void`	`setContentXMLBytes(byte[] tBXXMLBytes)` Sets the XML content of the Text module as a byte array.
`void`	`setFileName(String fileName)` Sets the file name of the Text module.
`void`	`setNoPageBreak(boolean noPageBreak)`

Methods inherited from class com.adobe.icc.dbforms.obj.DataModule
addVariable, getDataDictionaryRef, getDataDictionaryRefs, getSchemaRef, getSchemaRefType, getVariableList, removeVariable, setDataDictionaryRef, setDataDictionaryRefs, setSchemaRef, setVariableList

Methods inherited from class com.adobe.icc.dbforms.obj.Asset
equals, getActiveEndDate, getActiveStartDate, getComment, getCrxVersion, getDesc, getDisplayField, getExtendedProperties, getFolderId, getId, getLastChangeBy, getLastPublishDate, getLastPublishedBy, getLastReplicationAction, getLastUpdateDate, getLastVersionDate, getLcat, getLocalizationPrefix, getLocalizationResourceInfoList, getName, getState, getTags, getTitle, getTransientProperties, getUcat, getUpdatedBy, getVersion, hashCode, setActiveEndDate, setActiveStartDate, setComment, setCrxVersion, setDesc, setExtendedProperties, setFolderId, setId, setLastChangeBy, setLastPublishDate, setLastPublishedBy, setLastReplicationAction, setLastUpdateDate, setLastVersionDate, setLcat, setLocalizationPrefix, setLocalizationResourceInfoList, setName, setState, setTags, setTitle, setTransientProperties, setUcat, setUpdatedBy, setVersion

- Field Detail
  - TM_CLASS
```
public static final String TM_CLASS
```
  - ASSOCIATION_CUTPOINT
```
public static final String ASSOCIATION_CUTPOINT
```
  - HIERARCHY_CUTPOINT
```
public static final String HIERARCHY_CUTPOINT
```
  - FIRST_LEVEL_CUTPOINT
```
public static final String FIRST_LEVEL_CUTPOINT
```
- Constructor Detail
  - TextModule
```
public TextModule()
```
    Default constructor
  - TextModule
```
public TextModule(String textModuleName,
                  String desc,
                  int version,
                  String comment,
                  int state,
                  Date start,
                  Date end,
                  String lastChange,
                  String dataDictionaryRef,
                  String fileName,
                  String tbxXml)
```
    Constructor from parameters.
    
    Parameters:
    
    textModuleName - name of the Text module.
    
    desc - description of the Text module.
    
    version - version of the Text module.
    
    comment - comment for the Text module.
    
    state - state of the Text module.
    
    start - activation start date of the Text module.
    
    end - activation end date of the Text module.
    
    lastChange - user creating the Text module.
    
    dataDictionaryRef - SchemaRef (name) associated with the Text module.
    
    fileName - file name of the Text module.
    
    tbxXml - XML representing text module content. See the class level documentation for the XML structure.
- Method Detail
  - getFileName
```
public String getFileName()
```
    Get the file name of the Text module.
    
    Returns:
    
    The file name of the Text module.
  - setFileName
```
public void setFileName(String fileName)
```
    Sets the file name of the Text module.
    
    Parameters:
    
    fileName - The file name of the Text module.
  - getContentXML
```
public String getContentXML()
```
    Get the XML content of the Text module as a String.
    
    Returns:
    
    The XML content of the Text module as a String.
    
    See Also:
    
    TextModule
  - setContentXML
```
public void setContentXML(String string)
```
    Sets the XML content of the Text module as a String.
    
    Parameters:
    
    string - The XML content of the Text module as a String.
  - getContentXMLBytes
```
public byte[] getContentXMLBytes()
```
    Get the XML content of the Text module as a byte array.
    
    Returns:
    
    The XML content of the Text module as a byte array.
  - setContentXMLBytes
```
public void setContentXMLBytes(byte[] tBXXMLBytes)
```
    Sets the XML content of the Text module as a byte array.
    
    Parameters:
    
    tBXXMLBytes - The XML content of the Text module as a byte array.
  - isNoPageBreak
```
public boolean isNoPageBreak()
```
    Returns:
    
    the noPageBreak
  - setNoPageBreak
```
public void setNoPageBreak(boolean noPageBreak)
```
    Parameters:
    
    noPageBreak - the noPageBreak to set

Class TextModule

Field Summary

Fields inherited from class com.adobe.icc.dbforms.obj.DataModule

Fields inherited from class com.adobe.icc.dbforms.obj.Asset

Constructor Summary

Method Summary

Methods inherited from class com.adobe.icc.dbforms.obj.DataModule

Methods inherited from class com.adobe.icc.dbforms.obj.Asset

Field Detail

TM_CLASS

ASSOCIATION_CUTPOINT

HIERARCHY_CUTPOINT

FIRST_LEVEL_CUTPOINT

Constructor Detail

TextModule

TextModule

Method Detail

getFileName

setFileName

getContentXML

setContentXML

getContentXMLBytes

setContentXMLBytes

isNoPageBreak

setNoPageBreak