ScanMode (Smart GWT EE API 13.1p (2026-01-27))

java.lang.Object
- java.lang.Enum<ScanMode>
- - com.smartgwt.client.types.ScanMode

All Implemented Interfaces:

ValueEnum, java.io.Serializable, java.lang.Comparable<ScanMode>
```
public enum ScanMode
extends java.lang.Enum<ScanMode>
implements ValueEnum
```
When discovering a tree, the scanMode determines how to scan for the childrenProperty "node": take each node individually "branch": scan direct siblings as a group, looking for best fit "level": scan entire tree levels as a group, looking for best fit

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BRANCH` scan direct siblings as a group, looking for best fit
`LEVEL` scan entire tree levels as a group, looking for best fit
`NODE` take each node individually

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getValue()`
`static ScanMode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ScanMode[]`	`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
  - NODE
```
public static final ScanMode NODE
```
    take each node individually
    If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "node".
  - BRANCH
```
public static final ScanMode BRANCH
```
    scan direct siblings as a group, looking for best fit
    If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "branch".
  - LEVEL
```
public static final ScanMode LEVEL
```
    scan entire tree levels as a group, looking for best fit
    If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "level".
- Method Detail
  - values
```
public static ScanMode[] 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 (ScanMode c : ScanMode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ScanMode 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

Enum ScanMode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NODE

BRANCH

LEVEL

Method Detail

values

valueOf

getValue