com.smartgwt.client.types

Enum TourInputValidationMode

java.lang.Object

java.lang.Enum<TourInputValidationMode>

com.smartgwt.client.types.TourInputValidationMode

All Implemented Interfaces:

ValueEnum, java.io.Serializable, java.lang.Comparable<TourInputValidationMode>

public enum TourInputValidationMode
extends java.lang.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 Summary

Enum Constants

Enum Constant and Description
NOTIFY When there is a brief pause in typing, notify the user that they have typed something wrong.
ONEXIT text entry is only validated on field exit or click on afterInputTarget.
STRICT Prevent the user from typing any characters that don't match the expectedValue, and tell them immediately when they have typed something wrong.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue()
static TourInputValidationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TourInputValidationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static TourInputValidationMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TourInputValidationMode c : TourInputValidationMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TourInputValidationMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()

Specified by:

getValue in interface ValueEnum