Package com.uc4.api

Interface IFormItem

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getId()
      Returns the internal ID of this field.
      java.lang.String getLabel()
      Returns the label of the field.
      java.lang.String getValue()
      Returns the current value.
      boolean isFixed()
      Returns true if this IFormItem is fixed.
      boolean isLabel()
      Returns true if this form item is a label.
      boolean isList()
      Returns true if this form item is a list.
      boolean isNewLine()
      Returns true if this IFormItem is full sized.
      boolean isNumber()
      Returns true if this form item is a number field.
      boolean isRequired()
      Returns true if an input is required.
      boolean isText()
      Returns true if this form item is a text input field.
      boolean isUppercase()
      Returns true if this IFormItem is uppercase.
      boolean isValid()
      Tests if the current value a valid input for this field.
      void setValue​(java.lang.String value)
      Sets a new value for this field.
    • Method Detail

      • isLabel

        boolean isLabel()
        Returns true if this form item is a label.
        Returns:
        Boolean indicating if this item is label
      • isText

        boolean isText()
        Returns true if this form item is a text input field. A cast to FormItemText can be done if this method returns true.
        Returns:
        Boolean indicating if this item is a text input field
      • isNumber

        boolean isNumber()
        Returns true if this form item is a number field. A cast to FormItemNumber can be done if this method returns true.
        Returns:
        Boolean indicating if this item is a number field
      • isList

        boolean isList()
        Returns true if this form item is a list. A cast to FormItemList can be done if this method returns true.
        Returns:
        Boolean indicating if this item is a list
      • getLabel

        java.lang.String getLabel()
        Returns the label of the field.
        Returns:
        Label of the field
      • setValue

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

        java.lang.String getValue()
        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
      • isRequired

        boolean isRequired()
        Returns true if an input is required. In this case the value cannot be an empty String.
        Returns:
        Boolean indicating if a value is required to process the form
      • getId

        java.lang.String getId()
        Returns the internal ID of this field.
        Returns:
        String representing the ID
      • isValid

        boolean isValid()
        Tests if the current value a valid input for this field.
        Returns:
        Boolean indicating if this IFormItem is valid.
      • isFixed

        boolean isFixed()
        Returns true if this IFormItem is fixed. E.g. parameter "F" is set in UC-Script.
        Returns:
        Boolean indicating if this IFormItem is fixed.
      • isUppercase

        boolean isUppercase()
        Returns true if this IFormItem is uppercase.
        Returns:
        Boolean indicating if this IFormItem is uppercase.
      • isNewLine

        boolean isNewLine()
        Returns true if this IFormItem is full sized.
        Returns:
        Boolean indicating if this IFormItem is fully sized.