public class ComboElement extends OnChangeResetElement implements PromptInterfaces.Caption, PromptInterfaces.DataReference, PromptInterfaces.Focus, PromptInterfaces.XmlKey, PromptInterfaces.XPath, PromptInterfaces.QuoteCharacter, PromptInterfaces.ItemList, PromptInterfaces.Locked
aliasMap, list, properties
Constructor and Description |
---|
ComboElement(java.lang.String variableName,
UC4ObjectName reference) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCaption() |
UC4ObjectName |
getDataReference() |
java.util.List<java.lang.String> |
getItemList()
When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.
|
char |
getQuoteCharacter()
Returns the character for a quote.
|
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 |
isDynamic()
Returns
true if the "dynamic" property is set. |
boolean |
isLocked()
Returns
true if this Prompt Element is locked. |
void |
setCaption(java.lang.String caption)
Sets the caption of this prompt element.
|
void |
setDataReference(UC4ObjectName vara)
Sets a VARA Object which contains a list of valid entries for this prompt element.
|
void |
setDynamic(boolean value)
Sets the "dynamic" property.
|
void |
setFocus(boolean value)
Sets the cursor focus: The cursor is placed at this control if the value is
true . |
void |
setLocked(boolean locked)
Lock or unlocks this element.
|
void |
setQuoteCharacter(char c)
Sets the character for a quote, for example ' or ".
|
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, setRawValue, setTooltip, setValue, setValues, setVariable, store, storeDefaultValues, toString, updateDefaultValue, validateForExecute, validateId
public ComboElement(java.lang.String variableName, UC4ObjectName reference)
variableName
- Name of the script variablereference
- Name of the referencepublic void setQuoteCharacter(char c)
setQuoteCharacter
in interface PromptInterfaces.QuoteCharacter
c
- Characterpublic char getQuoteCharacter()
getQuoteCharacter
in interface PromptInterfaces.QuoteCharacter
public 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 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 java.util.List<java.lang.String> getItemList()
getItemList
in interface PromptInterfaces.ItemList
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 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 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 java.lang.String getCaption()
getCaption
in interface PromptInterfaces.Caption
public void setCaption(java.lang.String caption)
setCaption
in interface PromptInterfaces.Caption
caption
- Captionpublic boolean isDynamic()
true
if the "dynamic" property is set.public void setDynamic(boolean value)
value
- true if this combo uses other variables in the same or previous prompts for its value list, false if the value list is not
depended on other variables.public void setDataReference(UC4ObjectName vara)
setDataReference
in interface PromptInterfaces.DataReference
vara
- Name of a Variable Objectpublic UC4ObjectName getDataReference()
getDataReference
in interface PromptInterfaces.DataReference
protected java.lang.String getTagName()
getTagName
in class PromptElement