com.adobe.icc.dbforms.obj
Class TextModule

java.lang.Object
  extended by com.adobe.icc.dbforms.obj.Asset
      extended by com.adobe.icc.dbforms.obj.DataModule
          extended by com.adobe.icc.dbforms.obj.TextModule
All Implemented Interfaces:
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"> <P ALIGN="LEFT"><FONT FACE="Times New Roman" SIZE="12" COLOR="#000000" LETTERSPACING="0" KERNING="0"> This is a paragraph with a variable: {^var^}</FONT></P></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/"> <p xml:space="preserve" style="text-align:left"><span style="letter-spacing: 0px; color: #000000; font-size: 12px; font-family: Times New Roman; xfa-spacerun:yes"> This is a paragraph with a variable: {^var^}</span></p></body></xfaXhtml>
</content>

See Also:
Serialized Form

Field Summary
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
 
Constructor Summary
TextModule()
          Default constructor
TextModule(String textModuleName, String desc, int version, String comment, int state, Date start, Date end, String lastChange, Category ucat, Category lcat, String dataDictionaryRef, String fileName, String tbxXml)
          Constructor from parameters.
 
Method Summary
 String getFileName()
          Get the file name of the Text module.
 String getTBXXML()
          Get the XML content of the Text module as a String.
 byte[] getTBXXMLBytes()
          Get the XML content of the Text module as a byte array.
 void setFileName(String fileName)
          Sets the file name of the Text module.
 void setTBXXML(String string)
          Sets the XML content of the Text module as a String.
 void setTBXXMLBytes(byte[] tBXXMLBytes)
          Sets the XML content of the Text module as a byte array.
 
Methods inherited from class com.adobe.icc.dbforms.obj.DataModule
addVariable, getDataDictionaryRef, getDataDictionaryRefs, getVariableList, removeVariable, setDataDictionaryRef, setDataDictionaryRefs, setVariableList
 
Methods inherited from class com.adobe.icc.dbforms.obj.Asset
getActiveEndDate, getActiveStartDate, getComment, getDesc, getExtendedProperties, getId, getLastChangeBy, getLastUpdateDate, getLcat, getName, getState, getUcat, getVersion, setActiveEndDate, setActiveStartDate, setComment, setDesc, setExtendedProperties, setId, setLastChangeBy, setLastUpdateDate, setLcat, setName, setState, setUcat, setVersion
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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,
                  Category ucat,
                  Category lcat,
                  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.
ucat - Category of the Text module.
lcat - Subcategory of the Text module.
dataDictionaryRef - DataDictionary (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.

getTBXXML

public String getTBXXML()
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

setTBXXML

public void setTBXXML(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.

getTBXXMLBytes

public byte[] getTBXXMLBytes()
Get the XML content of the Text module as a byte array.

Returns:
The XML content of the Text module as a byte array.

setTBXXMLBytes

public void setTBXXMLBytes(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.