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.
  • Constructor Details

    • OnChangeResetElement

      public OnChangeResetElement()
  • Method Details

    • addOnChangeResetElement

      public void addOnChangeResetElement(OnChangeResetElement element)
      Adds a OnChangeReset-children to the PromptElement. 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 the PromptElement.
      Parameters:
      element - OnChangeResetElement which should be removed
    • onChangeResetElementIterator

      public Iterator<OnChangeResetElement> onChangeResetElementIterator()
      Returns a java.util.Iterator to get all OnChangeReset-children of this PromptElement.
      Returns:
      Iterator
    • removeAllOnChangeResetElements

      public void removeAllOnChangeResetElements()
      Removes all OnChangeReset-children from the PromptElement.
    • resetAllSubValues

      public void resetAllSubValues()
      Resets all OnChangeReset-children of this PromptElement and all related sub-children (=Recursive reset).
    • getAllOnChangeResetElementIterator

      public Iterator<OnChangeResetElement> getAllOnChangeResetElementIterator()
      Returns a java.util.Iterator to get all OnChangeReset-children of this PromptElement and all related sub-children (=Recursive get).
      Returns:
      Iterator
    • sizeOfOnChangeResetElements

      public int sizeOfOnChangeResetElements()
      Returns the number of OnChangeResetElement's which are registered to this PromptElement
      Returns:
      Number of elements. Can be zero.
    • storeAdditionalPromptData

      protected void storeAdditionalPromptData(Element promptElement)
      Description copied from class: PromptElement
      Subclasses can implement this method to store additional data into the prompt-element.
      Overrides:
      storeAdditionalPromptData in class PromptElement
      Parameters:
      promptElement - xml-element from the prompt-element