net.sf.mmm.client.ui.api.dialog

Interface DialogConstants

public interface DialogConstants

This interface is (mis)used to define the constants for common dialog IDs, dialog types, DialogSlots and DialogPlaces.
Technically mandatory for the core implementation are only TYPE_ROOT and TYPE_MAIN. However, you find the entire common sense here and there are (base) implementations for DialogController that depend on these predefined constants and will make your life a lot easier.
We recommend that you extend this interface with your own MyProjectDialogConstants to define the constants for your dialogs. In most cases you should avoid defining constants for parameterized DialogPlaces.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIALOG_ID_HOME The dialog-id of the main dialog that defines the home screen or start page.
static String	DIALOG_ID_NAVIGATION The dialog-id of the (default) navigation dialog.
static String	DIALOG_ID_PAGE The dialog-id of the page dialog.
static String	DIALOG_ID_ROOT The dialog-id of the root dialog.
static DialogPlace	PLACE_HOME The DialogPlace for the home dialog.
static DialogSlot	SLOT_PAGE_MAIN The DialogSlot for the main dialog.
static DialogSlot	SLOT_PAGE_NAVIGATION The DialogSlot for the navigation dialog.
static DialogSlot	SLOT_ROOT_PAGE The DialogSlot of the root dialog where the page dialog is DialogController.embed(net.sf.mmm.client.ui.base.dialog.DialogController<?>, net.sf.mmm.client.ui.base.dialog.DialogSlot) embedded.
static String	TYPE_FOOTER The type of a footer dialog.
static String	TYPE_HEADER The type of a header dialog.
static String	TYPE_MAIN The type of a main dialog.
static String	TYPE_NAVIGATION The type of a navigation dialog.
static String	TYPE_PAGE The type of the page dialog.
static String	TYPE_ROOT The type of the root dialog.
static String	TYPE_SIDE The type of a side dialog.

Field Detail

TYPE_ROOT

static final String TYPE_ROOT

The type of the root dialog. This is the top-level dialog of the application and represents the UiWidgetMainWindow.

See Also:

RootDialogController, Constant Field Values

TYPE_PAGE

static final String TYPE_PAGE

The type of the page dialog. This is the first custom dialog that defines the structure of the application page (main window). It is supposed to embed itself into the root page and provide slots for child dialogs, at least a main slot. For an example see DialogController.

See Also:

AbstractPageDialogController, Constant Field Values

TYPE_MAIN

static final String TYPE_MAIN

The type of a main dialog. This is a regular dialog displayed in the main content area of the client application window.

See Also:

Constant Field Values

TYPE_HEADER

static final String TYPE_HEADER

The type of a header dialog. This is a dialog displayed at the top of the main content area of the client application window above a main dialog.

See Also:

Constant Field Values

TYPE_FOOTER

static final String TYPE_FOOTER

The type of a footer dialog. This is a dialog displayed at the bottom of the main content area of the client application window below a main dialog.

See Also:

Constant Field Values

TYPE_NAVIGATION

static final String TYPE_NAVIGATION

The type of a navigation dialog. The navigation offers a structured way for the user to navigate through the application. This can happen in form of a menu-bar that is typically placed below the header and above the main dialog. However it is often realized as a list or tree of links that is displayed beside the main dialog (typically on the left).

See Also:

Constant Field Values

TYPE_SIDE

static final String TYPE_SIDE

The type of a side dialog. This is a dialog typically displayed at on the right of the main content area of the client application window beside a main dialog. It typically shows additional information or a summary of the current state (e.g. shopping cart). However, it may also be used to display advertisements.

See Also:

Constant Field Values

DIALOG_ID_ROOT

static final String DIALOG_ID_ROOT

The dialog-id of the root dialog.

See Also:

Constant Field Values

DIALOG_ID_PAGE

static final String DIALOG_ID_PAGE

The dialog-id of the page dialog.

See Also:

Constant Field Values

DIALOG_ID_NAVIGATION

static final String DIALOG_ID_NAVIGATION

The dialog-id of the (default) navigation dialog.

See Also:

Constant Field Values

SLOT_ROOT_PAGE

static final DialogSlot SLOT_ROOT_PAGE

The DialogSlot of the root dialog where the page dialog is DialogController.embed(net.sf.mmm.client.ui.base.dialog.DialogController<?>, net.sf.mmm.client.ui.base.dialog.DialogSlot) embedded.

SLOT_PAGE_MAIN

static final DialogSlot SLOT_PAGE_MAIN

The DialogSlot for the main dialog.

SLOT_PAGE_NAVIGATION

static final DialogSlot SLOT_PAGE_NAVIGATION

The DialogSlot for the navigation dialog.

DIALOG_ID_HOME

static final String DIALOG_ID_HOME

The dialog-id of the main dialog that defines the home screen or start page. It is just a recommendation to make your life easier. You can also define your own ID and place and just ignore these constant if you have a reason to do so.

See Also:

DialogManager.initialize(DialogPlace), Constant Field Values

PLACE_HOME

static final DialogPlace PLACE_HOME

The DialogPlace for the home dialog.

See Also:

DialogManager.initialize(DialogPlace)