com.smartgwt.client.types

Enum FireStyle

java.lang.Object

java.lang.Enum<FireStyle>

com.smartgwt.client.types.FireStyle

All Implemented Interfaces:

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

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

Flags to set automatic removal of events from the page event registry.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRE_ONCE Call the registered handler the first time the event occurs, then unregister the handler as though Page.clearEvent() had been called
NULL Call the registered handler any time the event occurs

Method Summary

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

NULL

public static final FireStyle NULL

Call the registered handler any time the event occurs

FIRE_ONCE

public static final FireStyle FIRE_ONCE

Call the registered handler the first time the event occurs, then unregister the handler as though Page.clearEvent() had been called

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

Method Detail

values

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

Returns:

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

valueOf

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