Package com.uc4.api

Class FormItemText

  • All Implemented Interfaces:
    IFormItem
    public class FormItemText
extends AbstractFormItem
    This class is used for text input fields and date fields.

    • Constructor Summary

      Constructors 
      Constructor Description
      FormItemText​(org.w3c.dom.Element textElement)
      Constructs a new FormItemText using the specified XML element.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getInputCheck()
      Returns a String containing the term that determines how the user input should be checked.
      int getMaxLength()
      Returns the maximum number of allowed characters.
      java.lang.String getValue()
      Returns the current value.
      boolean isDate()
      Returns true if this input field is a date field.
      boolean isPassword()
      Returns true if this input field is a password field.
      boolean isText()
      Returns true if this form item is a text input field.
      boolean isValid()
      Tests if the current value a valid input for this field.
      boolean isValid​(java.lang.String test)
      Tests if the parameter test is a valid input.
      void setValue​(java.lang.String value)
      Sets a new value for this field.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • FormItemText

        public FormItemText​(org.w3c.dom.Element textElement)
        Constructs a new FormItemText using the specified XML element.
        Parameters:
        textElement - XML element

    • Method Detail

      • isText

        public boolean isText()
        Description copied from interface: IFormItem
        Returns true if this form item is a text input field. A cast to FormItemText can be done if this method returns true.
        Specified by:
        isText in interface IFormItem
        Overrides:
        isText in class AbstractFormItem
        Returns:
        Boolean indicating if this item is a text input field

      • isPassword

        public boolean isPassword()
        Returns true if this input field is a password field. The entered value is not visible in the report if this input field is a password field
        Returns:
        Boolean which is set to true

      • isDate

        public boolean isDate()
        Returns true if this input field is a date field.
        Returns:
        Boolean indicating whether this field is a date

      • getInputCheck

        public java.lang.String getInputCheck()
        Returns a String containing the term that determines how the user input should be checked.
        Returns:
        Input Check

      • getMaxLength

        public int getMaxLength()
        Returns the maximum number of allowed characters.
        Returns:
        max length for value

      • isValid

        public boolean isValid​(java.lang.String test)
        Tests if the parameter test is a valid input.
        Parameters:
        test - Value which should be tested
        Returns:
        True if test is a valid

      • setValue

        public void setValue​(java.lang.String value)
        Description copied from interface: IFormItem
        Sets a new value for this field. This method can throw an exception if the input is not valid.
        Parameters:
        value - New value

      • getValue

        public java.lang.String getValue()
        Description copied from interface: IFormItem
        Returns the current value. If a default value is set this method can be used to read the default value.
        Returns:
        Value of this field

      • isValid

        public boolean isValid()
        Description copied from interface: IFormItem
        Tests if the current value a valid input for this field.
        Specified by:
        isValid in interface IFormItem
        Overrides:
        isValid in class AbstractFormItem
        Returns:
        Boolean indicating if this IFormItem is valid.