net.sf.mmm.client.ui.api.common

Interface UiMode

public interface UiMode

This interface represents the available modes of a UI object. It can be either in the mode VIEW or in the mode EDIT.
NOTE:
This is intentionally NOT realized as an enum type in order to allow extension for custom needs.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static UiMode	EDIT The mode to edit content.
static Set<UiMode>	SET_EDIT The Set containing only VIEW.
static Set<UiMode>	SET_VIEW The Set containing only VIEW.
static Set<UiMode>	SET_VIEW_AND_EDIT The Set containing VIEW and EDIT.
static UiMode	VIEW The mode to show content in a read-only view.

Method Summary

Modifier and Type	Method and Description
boolean	isEditable() This method determines if this mode allows the end-user to modify values.

Field Detail

VIEW

static final UiMode VIEW

The mode to show content in a read-only view.

EDIT

static final UiMode EDIT

The mode to edit content.

SET_VIEW

static final Set<UiMode> SET_VIEW

The Set containing only VIEW.

SET_EDIT

static final Set<UiMode> SET_EDIT

The Set containing only VIEW.

SET_VIEW_AND_EDIT

static final Set<UiMode> SET_VIEW_AND_EDIT

The Set containing VIEW and EDIT.

Method Detail

isEditable

boolean isEditable()

This method determines if this mode allows the end-user to modify values.

Returns:

true if this UiMode allows editing, false otherwise (if the end-user can not modify values in this mode).