com.smartgwt.client.types

Enum TourMode

java.lang.Object

java.lang.Enum<TourMode>

com.smartgwt.client.types.TourMode

All Implemented Interfaces:

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

public enum TourMode
extends java.lang.Enum<TourMode>
implements ValueEnum

Enum Constant Summary

Enum Constants

Enum Constant and Description
TOUR For a tourStep if you only specify instructions and target, the pointer appearance is used and points at the target - no interaction is expected.
TUTORIAL For a tourStep if you only specify instructions and target, the actionType is defaulted and the big red arrow appearance is used.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue()
static TourMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TourMode[]	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

TOUR

public static final TourMode TOUR

For a tourStep if you only specify instructions and target, the pointer appearance is used and points at the target - no interaction is expected. To make the step require an interaction, set actionType.

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

TUTORIAL

public static final TourMode TUTORIAL

For a tourStep if you only specify instructions and target, the actionType is defaulted and the big red arrow appearance is used. Set actionType:"none" or "any" if your step has a target but doesn't require an interaction.

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

Method Detail

values

public static TourMode[] 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 (TourMode c : TourMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static TourMode 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