Package org.eclipse.nebula.widgets.nattable.style

Enum DisplayMode

java.lang.Object

java.lang.Enum<DisplayMode>

org.eclipse.nebula.widgets.nattable.style.DisplayMode

All Implemented Interfaces:

Serializable, Comparable<DisplayMode>

public enum DisplayMode
extends Enum<DisplayMode>

The various modes the table can be under.

1. During normal display a cell is in NORMAL mode.
2. If the contents of the cell are being edited, its in EDIT mode.
3. If a cell has been selected, its in SELECT mode.

These modes are used to bind different settings to different modes. For example, a different style can be registered for a cell when it is in SELECT mode.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EDIT	The state that shows that a cell is currently edited.
HOVER	The state that shows that currently the mouse hovers over the cell.
NORMAL	The normal state a cell is in if no other state applies.
SELECT	The state that shows that a cell is currently selected.
SELECT_HOVER	The state that shows that currently the mouse hovers over the cell that is currently selected.

Method Summary

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

The normal state a cell is in if no other state applies.

SELECT

public static final DisplayMode SELECT

The state that shows that a cell is currently selected.

EDIT

public static final DisplayMode EDIT

The state that shows that a cell is currently edited. Never applied to a cell, only used for configuration purposes.

HOVER

public static final DisplayMode HOVER

The state that shows that currently the mouse hovers over the cell.

SELECT_HOVER

public static final DisplayMode SELECT_HOVER

The state that shows that currently the mouse hovers over the cell that is currently selected.

Method Detail

values

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

Returns:

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

valueOf

public static DisplayMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null