Package com.uc4.api.prompt
Class OnChangeResetElement
- java.lang.Object
-
- com.uc4.api.objects.PromptElement
-
- com.uc4.api.prompt.OnChangeResetElement
-
- Direct Known Subclasses:
CheckGroupElement
,ComboElement
,TextElement
public abstract class OnChangeResetElement extends PromptElement
Abstract class which adds OnChangeReset-functionality to a PromptElement.
-
-
Field Summary
-
Fields inherited from class com.uc4.api.objects.PromptElement
aliasMap, list, properties
-
-
Constructor Summary
Constructors Constructor Description OnChangeResetElement()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOnChangeResetElement(OnChangeResetElement element)
Adds a OnChangeReset-children to thePromptElement
.java.util.Iterator<OnChangeResetElement>
getAllOnChangeResetElementIterator()
Returns ajava.util.Iterator
to get all OnChangeReset-children of thisPromptElement
and all related sub-children (=Recursive get).java.util.Iterator<OnChangeResetElement>
onChangeResetElementIterator()
Returns ajava.util.Iterator
to get all OnChangeReset-children of thisPromptElement
.void
removeAllOnChangeResetElements()
Removes all OnChangeReset-children from thePromptElement
.void
removeOnChangeResetElement(OnChangeResetElement element)
Removes the specified OnChangeReset-children from thePromptElement
.void
resetAllSubValues()
Resets all OnChangeReset-children of thisPromptElement
and all related sub-children (=Recursive reset).int
sizeOfOnChangeResetElements()
Returns the number ofOnChangeResetElement
's which are registered to thisPromptElement
protected void
storeAdditionalPromptData(org.w3c.dom.Element promptElement)
Subclasses can implement this method to store additional data into the prompt-element.-
Methods inherited from class com.uc4.api.objects.PromptElement
getCustomField, getMessageInsert, getMessageNumber, getMode, getProperty, getTagName, getTooltip, getValue, getValues, getVariable, hasList, isAltView, isLocked, listParam, setAltView, setCustomField, setLocked, setRawValue, setTooltip, setValue, setValues, setVariable, store, storeDefaultValues, toString, updateDefaultValue, validateForExecute, validateId
-
-
-
-
Method Detail
-
addOnChangeResetElement
public void addOnChangeResetElement(OnChangeResetElement element)
Adds a OnChangeReset-children to thePromptElement
. Will only be added if no reset-loop occurs.- Parameters:
element
-OnChangeResetElement
which should be added
-
removeOnChangeResetElement
public void removeOnChangeResetElement(OnChangeResetElement element)
Removes the specified OnChangeReset-children from thePromptElement
.- Parameters:
element
-OnChangeResetElement
which should be removed
-
onChangeResetElementIterator
public java.util.Iterator<OnChangeResetElement> onChangeResetElementIterator()
Returns ajava.util.Iterator
to get all OnChangeReset-children of thisPromptElement
.- Returns:
- Iterator
-
removeAllOnChangeResetElements
public void removeAllOnChangeResetElements()
Removes all OnChangeReset-children from thePromptElement
.
-
resetAllSubValues
public void resetAllSubValues()
Resets all OnChangeReset-children of thisPromptElement
and all related sub-children (=Recursive reset).
-
getAllOnChangeResetElementIterator
public java.util.Iterator<OnChangeResetElement> getAllOnChangeResetElementIterator()
Returns ajava.util.Iterator
to get all OnChangeReset-children of thisPromptElement
and all related sub-children (=Recursive get).- Returns:
- Iterator
-
sizeOfOnChangeResetElements
public int sizeOfOnChangeResetElements()
Returns the number ofOnChangeResetElement
's which are registered to thisPromptElement
- Returns:
- Number of elements. Can be zero.
-
storeAdditionalPromptData
protected void storeAdditionalPromptData(org.w3c.dom.Element promptElement)
Description copied from class:PromptElement
Subclasses can implement this method to store additional data into the prompt-element.- Overrides:
storeAdditionalPromptData
in classPromptElement
- Parameters:
promptElement
- xml-element from the prompt-element
-
-