Package com.uc4.api.prompt
Class CheckGroupElement
java.lang.Object
com.uc4.api.objects.PromptElement
com.uc4.api.prompt.OnChangeResetElement
com.uc4.api.prompt.CheckGroupElement
- All Implemented Interfaces:
PromptInterfaces.Caption
,PromptInterfaces.DataReference
,PromptInterfaces.Focus
,PromptInterfaces.ItemList
,PromptInterfaces.Locked
,PromptInterfaces.MultiSelect
,PromptInterfaces.QuoteCharacter
,PromptInterfaces.ValueRequired
,PromptInterfaces.XmlKey
,PromptInterfaces.XPath
- Direct Known Subclasses:
CheckListElement
public class CheckGroupElement
extends OnChangeResetElement
implements PromptInterfaces.Caption, PromptInterfaces.DataReference, PromptInterfaces.Focus, PromptInterfaces.MultiSelect, PromptInterfaces.XmlKey, PromptInterfaces.XPath, PromptInterfaces.ValueRequired, PromptInterfaces.QuoteCharacter, PromptInterfaces.ItemList, PromptInterfaces.Locked
This class represents a group of check boxes.
-
Field Summary
Fields inherited from class com.uc4.api.objects.PromptElement
aliasMap, list, properties
-
Constructor Summary
ConstructorsConstructorDescriptionCheckGroupElement
(String variableName, UC4ObjectName reference) Creates a newCheckGroupElement
. -
Method Summary
Modifier and TypeMethodDescriptionWhen a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.Returns the mulit select separator character.char
Returns the character for a quote.protected String
Returns the key for XML Variables in the data reference.getXPath()
Returns the XPath expression if XML variables are used as data reference.boolean
hasFocus()
Returnstrue
if the focus is set.boolean
boolean
isLocked()
Returnstrue
if this Prompt Element is locked.boolean
Returnstrue
if this prompt element has a multi select array.boolean
Returnstrue
if the user has to use the default value or check at least one box.void
setCaption
(String caption) Sets the caption of this prompt element.void
Sets a 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 istrue
.void
setLocked
(boolean locked) Lock or unlocks this element.void
setMultiSelect
(boolean value) Enables or disables multi select.void
setMultiSelectArray
(boolean value) Enables or disables the array property for multi select values.void
Sets the mulit select separator character.void
setQuoteCharacter
(char c) Sets the character for a quote, for example ' or ".void
setValueRequired
(boolean value) Sets or clears the property which determines if this field requires a value.void
Sets the key in case XML Variables are used as data reference.void
Sets the XPath expression if XML variables are used as data reference.Methods inherited from class com.uc4.api.prompt.OnChangeResetElement
addOnChangeResetElement, getAllOnChangeResetElementIterator, onChangeResetElementIterator, removeAllOnChangeResetElements, removeOnChangeResetElement, resetAllSubValues, sizeOfOnChangeResetElements, storeAdditionalPromptData
Methods inherited from class com.uc4.api.objects.PromptElement
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
-
Constructor Details
-
CheckGroupElement
Creates a newCheckGroupElement
.- Parameters:
variableName
- Name of the script variablereference
- Name of the reference
-
-
Method Details
-
setQuoteCharacter
public void setQuoteCharacter(char c) Sets the character for a quote, for example ' or ".- Specified by:
setQuoteCharacter
in interfacePromptInterfaces.QuoteCharacter
- Parameters:
c
- Character
-
getQuoteCharacter
public char getQuoteCharacter()Returns the character for a quote.- Specified by:
getQuoteCharacter
in interfacePromptInterfaces.QuoteCharacter
- Returns:
- for example ' or "
-
hasFocus
public boolean hasFocus()Returnstrue
if the focus is set. The cursor is placed at this control if the value istrue
. 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.- Specified by:
hasFocus
in interfacePromptInterfaces.Focus
- Returns:
- true if the cursor should be set in this Prompt Element, false otherwise
-
getItemList
When a Prompt is executed (see request TaskPromptSetContent) this method returns a list of valid items.- Specified by:
getItemList
in interfacePromptInterfaces.ItemList
- Returns:
- List of items
-
setFocus
public void setFocus(boolean value) Sets the cursor focus: The cursor is placed at this control if the value istrue
. 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.- Specified by:
setFocus
in interfacePromptInterfaces.Focus
- Parameters:
value
- true if the cursor should be set in this Prompt Element, false otherwise
-
isLocked
public boolean isLocked()Returnstrue
if this Prompt Element is locked. In this case a user cannot change the default value in the Prompt-Screen.- Specified by:
isLocked
in interfacePromptInterfaces.Locked
- Overrides:
isLocked
in classPromptElement
- Returns:
- true if locked, false if the user can change the value of the Prompt Element
-
setLocked
public void setLocked(boolean locked) Lock or unlocks this element. A user cannot change the default value in the Prompt-Screen if a control is locked.- Specified by:
setLocked
in interfacePromptInterfaces.Locked
- Overrides:
setLocked
in classPromptElement
- Parameters:
locked
- true if locked, false if the user can change the value of the Prompt Element
-
getCaption
- Specified by:
getCaption
in interfacePromptInterfaces.Caption
- Returns:
- Caption of this prompt element
-
setCaption
Sets the caption of this prompt element.- Specified by:
setCaption
in interfacePromptInterfaces.Caption
- Parameters:
caption
- Caption
-
setDataReference
Sets a VARA Object which contains a list of valid entries for this prompt element.- Specified by:
setDataReference
in interfacePromptInterfaces.DataReference
- Parameters:
vara
- Name of a Variable Object
-
setXmlKey
Sets the key in case XML Variables are used as data reference.- Specified by:
setXmlKey
in interfacePromptInterfaces.XmlKey
- Parameters:
key
- Key
-
getXmlKey
Returns the key for XML Variables in the data reference.- Specified by:
getXmlKey
in interfacePromptInterfaces.XmlKey
- Returns:
- Key or an empty String if not set.
-
setXPath
Sets the XPath expression if XML variables are used as data reference.- Specified by:
setXPath
in interfacePromptInterfaces.XPath
- Parameters:
xpath
- XPath/Query expression
-
getXPath
Returns the XPath expression if XML variables are used as data reference.- Specified by:
getXPath
in interfacePromptInterfaces.XPath
- Returns:
- XPath/Query expression or an empty String if not set.
-
getDataReference
- Specified by:
getDataReference
in interfacePromptInterfaces.DataReference
- Returns:
- Name of a Variable Object
-
setMultiSelect
public void setMultiSelect(boolean value) Enables or disables multi select.- Specified by:
setMultiSelect
in interfacePromptInterfaces.MultiSelect
- Parameters:
value
- true if mulit select should be enabled
-
hasMultiSelect
public boolean hasMultiSelect()- Specified by:
hasMultiSelect
in interfacePromptInterfaces.MultiSelect
- Returns:
- true if multi select is enabled
-
setMultiSelectSeparator
Sets the mulit select separator character.- Specified by:
setMultiSelectSeparator
in interfacePromptInterfaces.MultiSelect
- Parameters:
sep
- separator character
-
getMultiSelectSeparator
Returns the mulit select separator character.- Specified by:
getMultiSelectSeparator
in interfacePromptInterfaces.MultiSelect
- Returns:
- separator character
-
isMultiSelectArray
public boolean isMultiSelectArray()Returnstrue
if this prompt element has a multi select array.- Returns:
- true if an array is provided as value list
-
setMultiSelectArray
public void setMultiSelectArray(boolean value) Enables or disables the array property for multi select values.- Parameters:
value
- true if the array property should be set, false otherwise
-
isValueRequired
public boolean isValueRequired()Returnstrue
if the user has to use the default value or check at least one box.- Specified by:
isValueRequired
in interfacePromptInterfaces.ValueRequired
- Returns:
- true if a value is required, false otherwise
-
setValueRequired
public void setValueRequired(boolean value) Sets or clears the property which determines if this field requires a value.- Specified by:
setValueRequired
in interfacePromptInterfaces.ValueRequired
- Parameters:
value
- true if a value is required, false otherwise
-
getTagName
- Specified by:
getTagName
in classPromptElement
-