Enum TourInputValidationMode

java.lang.Object
java.lang.Enum<TourInputValidationMode>
com.smartgwt.client.types.TourInputValidationMode
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<TourInputValidationMode>, Constable

public enum TourInputValidationMode extends Enum<TourInputValidationMode> implements ValueEnum
Policy for how inputValidation is performed for actionType:"change". When users enter incorrect values, they are informed via the Notify system, and the specific message displayed is controlled by inputValidationNotifyMessage.

The notification can be disabled for the step by setting TourStep.showInputValidationMessage to false.

  • Enum Constant Details

    • NOTIFY

      public static final TourInputValidationMode NOTIFY
      When there is a brief pause in typing, notify the user that they have typed something wrong. The pause delay is controlled by inputValidationNotifyDelay.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "notify".

    • STRICT

      public static final TourInputValidationMode STRICT
      Prevent the user from typing any characters that don't match the expectedValue, and tell them immediately when they have typed something wrong.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "strict".

    • ONEXIT

      public static final TourInputValidationMode ONEXIT
      text entry is only validated on field exit or click on afterInputTarget.

      If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "onExit".

  • Method Details

    • values

      public static TourInputValidationMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static TourInputValidationMode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getValue

      public String getValue()
      Specified by:
      getValue in interface ValueEnum