com.smartgwt.client.types

Enum TourActionType

java.lang.Object

java.lang.Enum<TourActionType>

com.smartgwt.client.types.TourActionType

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Interaction is allowed with the target but the user must click the next button to complete the step
CHANGE The target FormItem must change to complete the step.
CLICK The target must be clicked to complete the step
DOUBLECLICK The target must be double-clicked to complete the step
DRAG The target must be dragged to complete step.
MENUITEMOVER The target locator should resolve to an item within a Menu that has a sub-menu.
MENUITEMSELECT The target locator should resolve to an item within a Menu.
MOUSEDOWN The target will complete the step on mouseDown
MOUSEOVER The target must be moused-over to complete the step
NONE No interaction is allowed with the target and the user must click the next button to complete the step
RIGHTCLICK The target must be right-clicked to complete the step

Method Summary

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

CLICK

public static final TourActionType CLICK

The target must be clicked to complete the step

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

MOUSEDOWN

public static final TourActionType MOUSEDOWN

The target will complete the step on mouseDown

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

DOUBLECLICK

public static final TourActionType DOUBLECLICK

The target must be double-clicked to complete the step

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

RIGHTCLICK

public static final TourActionType RIGHTCLICK

The target must be right-clicked to complete the step

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

MOUSEOVER

public static final TourActionType MOUSEOVER

The target must be moused-over to complete the step

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

DRAG

public static final TourActionType DRAG

The target must be dragged to complete step. If dropTarget is also specified, the target component must be dropped onto the dropTarget.

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

CHANGE

public static final TourActionType CHANGE

The target FormItem must change to complete the step. Specify expectedValue if a specific value must be entered to continue. Depending on the FormItem type this may occur by the user typing or by selecting a value. See TourStep.inputValidation for how validation is performed. Note: for composite formItems such as DateItem or RadioGroupItem, you may specify either the item as a whole or a sub item as the target. Either way the tour will look for the expected value on the composite (parent) item.

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

MENUITEMOVER

public static final TourActionType MENUITEMOVER

The target locator should resolve to an item within a Menu that has a sub-menu. The submenu must be opened (by rolling over, or clicking the target) to complete the step.

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

MENUITEMSELECT

public static final TourActionType MENUITEMSELECT

The target locator should resolve to an item within a Menu. The item must be selected (clicked) to complete the step.

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

NONE

public static final TourActionType NONE

No interaction is allowed with the target and the user must click the next button to complete the step

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

ANY

public static final TourActionType ANY

Interaction is allowed with the target but the user must click the next button to complete the step

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

Method Detail

values

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

Returns:

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

valueOf

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