public class TextElement extends OnChangeResetElement implements PromptInterfaces.Caption, PromptInterfaces.Focus, PromptInterfaces.MultiSelect, PromptInterfaces.XmlKey, PromptInterfaces.XPath, PromptInterfaces.ValueRequired, PromptInterfaces.QuoteCharacter, PromptInterfaces.Locked, PromptInterfaces.DataReference
aliasMap, list, properties
Constructor and Description |
---|
TextElement(java.lang.String variableName,
UC4ObjectName reference) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCaption() |
UC4ObjectName |
getDataReference() |
int |
getMaxLength() |
java.lang.String |
getMultiSelectSeparator()
Returns the mulit select separator character.
|
char |
getQuoteCharacter()
Returns the character for a quote.
|
java.lang.String |
getRegExp()
Returns the Regular expression or an empty String if not set.
|
protected java.lang.String |
getTagName() |
java.lang.String |
getXmlKey()
Returns the key for XML Variables in the data reference.
|
java.lang.String |
getXPath()
Returns the XPath expression if XML variables are used as data reference.
|
boolean |
hasFocus()
Returns
true if the focus is set. |
boolean |
hasInputAssistance() |
boolean |
hasMultiSelect() |
boolean |
isLocked()
Returns
true if this Prompt Element is locked. |
boolean |
isMultiline()
Returns the value of the multi-line property.
|
boolean |
isShowAsPassword()
If set, this control shows asterisks instead of the text which was entered.
|
boolean |
isUpper()
Returns
true if the values should be converted to upper case. |
boolean |
isValueRequired()
Returns
true if the user has to use the default value or enter a value in this field. |
void |
setCaption(java.lang.String caption)
Sets the caption of this prompt element.
|
void |
setDataReference(UC4ObjectName vara)
Sets a UC4 VARA Object which contains a list of valid entries for this prompt element.
|
void |
setFocus(boolean value)
Sets the cursor focus: The cursor is placed at this control if the value is
true . |
void |
setInputAssistance(boolean value)
Enables or disables the input assistance for this field.
|
void |
setLocked(boolean locked)
Lock or unlocks this element.
|
void |
setMaxLength(int length)
Sets the maximal length for inputs in this text field.
|
void |
setMultiline(boolean value)
Enables or disables the multiline property.
|
void |
setMultiSelect(boolean value)
Enables or disables multi select.
|
void |
setMultiSelectSeparator(java.lang.String sep)
Sets the mulit select separator character.
|
void |
setQuoteCharacter(char c)
Sets the character for a quote, for example ' or ".
|
void |
setRegExp(java.lang.String regex)
Sets the Regular expression.
|
void |
setShowAsPassword(boolean value)
If set, this control shows asterisks instead of the text which was entered.
|
void |
setUpper(boolean value)
Sets the upper cause property.
|
void |
setValueRequired(boolean value)
Sets or clears the property which determines if this field requires a value.
|
void |
setXmlKey(java.lang.String key)
Sets the key in case XML Variables are used as data reference.
|
void |
setXPath(java.lang.String xpath)
Sets the XPath expression if XML variables are used as data reference.
|
addOnChangeResetElement, getAllOnChangeResetElementIterator, onChangeResetElementIterator, removeAllOnChangeResetElements, removeOnChangeResetElement, resetAllSubValues, sizeOfOnChangeResetElements, storeAdditionalPromptData
getCustomField, getMessageInsert, getMessageNumber, getMode, getProperty, getTooltip, getValue, getValues, getVariable, hasList, isAltView, listParam, setAltView, setCustomField, setTooltip, setValue, setValues, setVariable, store, storeDefaultValues, toString, updateDefaultValue, validateForExecute, validateId
public TextElement(java.lang.String variableName, UC4ObjectName reference)
variableName
- Name of the script variablereference
- Referencepublic void setXmlKey(java.lang.String key)
setXmlKey
in interface PromptInterfaces.XmlKey
key
- Keypublic java.lang.String getXmlKey()
getXmlKey
in interface PromptInterfaces.XmlKey
public void setXPath(java.lang.String xpath)
setXPath
in interface PromptInterfaces.XPath
xpath
- XPath/Query expressionpublic java.lang.String getXPath()
getXPath
in interface PromptInterfaces.XPath
public boolean isLocked()
true
if this Prompt Element is locked.
In this case a user cannot change the default value in the Prompt-Screen.isLocked
in interface PromptInterfaces.Locked
isLocked
in class PromptElement
public void setQuoteCharacter(char c)
setQuoteCharacter
in interface PromptInterfaces.QuoteCharacter
c
- Characterpublic char getQuoteCharacter()
getQuoteCharacter
in interface PromptInterfaces.QuoteCharacter
public void setLocked(boolean locked)
setLocked
in interface PromptInterfaces.Locked
setLocked
in class PromptElement
locked
- true if locked, false if the user can change the value of the Prompt Elementpublic void setRegExp(java.lang.String regex)
regex
- Regular expressionpublic java.lang.String getRegExp()
public boolean hasFocus()
true
if the focus is set.
The cursor is placed at this control if the value is true
.
It may only be defined for one control in the PromptSet.
If this flag is defined for several Controls of a PromptSet the last Control that got the flag wins.hasFocus
in interface PromptInterfaces.Focus
public void setFocus(boolean value)
true
.
It may only be defined for one control in the PromptSet.
If this flag is defined for several Controls of a PromptSet the last Control that got the flag wins.setFocus
in interface PromptInterfaces.Focus
value
- true if the cursor should be set in this Prompt Element, false otherwisepublic boolean isUpper()
true
if the values should be converted to upper case.public void setUpper(boolean value)
value
- true to enable the conversion to upper case, false to disable itpublic boolean isShowAsPassword()
public void setShowAsPassword(boolean value)
value
- true to enable the password field, false to disable itpublic boolean isValueRequired()
true
if the user has to use the default value or enter a value in this field.isValueRequired
in interface PromptInterfaces.ValueRequired
public void setValueRequired(boolean value)
setValueRequired
in interface PromptInterfaces.ValueRequired
value
- true if a value is required, false otherwisepublic boolean hasInputAssistance()
true
if input assistance is enabled, false otherwisepublic void setInputAssistance(boolean value)
value
- true
if input assistance should be enabled, false otherwisepublic java.lang.String getCaption()
getCaption
in interface PromptInterfaces.Caption
public void setCaption(java.lang.String caption)
setCaption
in interface PromptInterfaces.Caption
caption
- Captionpublic void setDataReference(UC4ObjectName vara)
setDataReference
in interface PromptInterfaces.DataReference
vara
- Name of a Variable Objectpublic UC4ObjectName getDataReference()
getDataReference
in interface PromptInterfaces.DataReference
public void setMultiSelect(boolean value)
setMultiSelect
in interface PromptInterfaces.MultiSelect
value
- true if mulit select should be enabledpublic boolean hasMultiSelect()
hasMultiSelect
in interface PromptInterfaces.MultiSelect
public void setMultiline(boolean value)
value
- true if this text field should contain more than one line, false if not.public boolean isMultiline()
public void setMultiSelectSeparator(java.lang.String sep)
setMultiSelectSeparator
in interface PromptInterfaces.MultiSelect
sep
- separator characterpublic java.lang.String getMultiSelectSeparator()
getMultiSelectSeparator
in interface PromptInterfaces.MultiSelect
public void setMaxLength(int length)
length
- Max lengthpublic int getMaxLength()
protected java.lang.String getTagName()
getTagName
in class PromptElement