com.smartgwt.client.types

Enum RecordType

java.lang.Object

java.lang.Enum<RecordType>

com.smartgwt.client.types.RecordType

All Implemented Interfaces:

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

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

Defines the various types of record that can be present in a ListGrid.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GRIDSUMMARY a record showing summaries for all records in the grid
GROUPHEADER a special collapsable record containing related regular records
GROUPSUMMARY a record showing summaries for all records in a parent groupNode
NORMAL regular data-records

Method Summary

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

regular data-records

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

GROUPHEADER

public static final RecordType GROUPHEADER

a special collapsable record containing related regular records

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

GROUPSUMMARY

public static final RecordType GROUPSUMMARY

a record showing summaries for all records in a parent groupNode

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

GRIDSUMMARY

public static final RecordType GRIDSUMMARY

a record showing summaries for all records in the grid

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

Method Detail

values

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

Returns:

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

valueOf

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