public class TdbTextField extends TdbField
Constructor and Description |
---|
TdbTextField(java.lang.String name)
Constructor, creates a blank instance based on the name provided
|
TdbTextField(TdbFieldTemplate tmpl)
Constructor, creates a blank instance based on the template provided
|
Modifier and Type | Method and Description |
---|---|
void |
appendText(java.lang.String val)
Text-specific function to append to the current value of a text field.
|
void |
appendValue(java.lang.String val)
Append the provided paragraph text to the field's value
This method cannot be used after any calls have been made to setText() or appendText() as the field is no longer defined in terms of paragraphs at that point. |
void |
clear()
Clear any existing state the field might have
|
int |
getFieldSize()
Retrieve the size of the value in the field.
|
java.lang.String |
getText()
Get the complete content of the field.
|
TdbTextExtractionInfo |
getTextExtractionInfo()
Provides access to an object that allows control and enabling of
text extraction operations on this TExt field.
|
TdbFieldType |
getType()
Retrieve the field type
|
java.lang.String |
getValue(int index)
Retrieve the value of the n'th paragraph.
|
int |
getValueCount()
Retrieve the number of paragraphs in the field.
|
void |
insertValue(int index,
java.lang.String value)
Inserts a new paragraph into the field.
|
boolean |
isChanged()
Returns the change status for the field.
|
java.util.List<java.lang.String> |
originalValues()
Retrieve the display form of the field, with the paragraphs being elements
within the collection returned.
|
void |
removeValue(int index)
Removes a paragraph from the field.
|
void |
setText(java.lang.String val)
Text-specific function to set the initial value of a text field to that provided.
|
void |
setValue(int index,
java.lang.String val)
Set the value of a specific paragraph to that provided.
|
java.lang.String |
toString()
Retrieves a two newline-delimited string representation of the display content
of the field
|
java.util.List<java.lang.String> |
values()
Retrieve the current content of the field -- refer to
TdbField.Values for more detail.
|
getName, getOwnerComponent
public TdbTextField(TdbFieldTemplate tmpl)
tmpl
- Field templatepublic TdbTextField(java.lang.String name)
name
- Name of fieldpublic boolean isChanged()
public java.util.List<java.lang.String> originalValues()
originalValues
in class TdbField
public java.util.List<java.lang.String> values()
values
in class TdbField
TdbField.values()
public java.lang.String getText()
public TdbFieldType getType()
public TdbTextExtractionInfo getTextExtractionInfo()
public void clear()
public int getFieldSize()
getFieldSize
in class TdbField
TdbField.getFieldSize()
public java.lang.String getValue(int index) throws TdbException
getValue
in class TdbField
index
- The index of the paragraph to retrieveTdbException
public void setValue(int index, java.lang.String val) throws TdbException
setValue
in class TdbField
index
- The offset of the paragraph to updateval
- The value to establish as the paragraph's valueTdbException
public void appendValue(java.lang.String val) throws TdbException
appendValue
in class TdbField
val
- The paragraph value to append to the fieldTdbException
public int getValueCount() throws TdbException
getValueCount
in class TdbField
TdbException
public void insertValue(int index, java.lang.String value) throws TdbException
insertValue
in class TdbField
index
- Zero-based index at which to insert the new paragraph.value
- The value to insert into the field.TdbException
public void removeValue(int index) throws TdbException
removeValue
in class TdbField
index
- Zero-based index of paragraph to remove.TdbException
public void setText(java.lang.String val)
val
- The value the field should initially takepublic void appendText(java.lang.String val)
val
- The value to append to the field's current value