com.smartgwt.client.types

Enum SearchEditorMode

java.lang.Object

java.lang.Enum<SearchEditorMode>

com.smartgwt.client.types.SearchEditorMode

All Implemented Interfaces:

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

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

Affects the appearance and behavior of the builtin SavedSearchEditor.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GRID the editor shows only a field for naming (or renaming) a search, since the grid has built-in interfaces for editing criteria
NORMAL the editor shows a FilterBuilder for editing criteria

Method Summary

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

NORMAL

public static final SearchEditorMode NORMAL

the editor shows a FilterBuilder for editing criteria

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

GRID

public static final SearchEditorMode GRID

the editor shows only a field for naming (or renaming) a search, since the grid has built-in interfaces for editing criteria

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

Method Detail

values

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

Returns:

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

valueOf

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