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

Interface AbstractDialog

All Superinterfaces:

AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadVisible

All Known Subinterfaces:

Dialog, PopupDialog

All Known Implementing Classes:

AbstractDialogController, AbstractMainDialogController, AbstractNavigationDialogController, AbstractPageDialogController, DialogController, RootDialogController

public interface AbstractDialog
extends AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadVisible

This is the abstract base interface for a dialog or screen of the client application. This should NOT be mixed with a popup.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATTERN_DIALOG_ID The regex pattern dialog IDs have to match.

Method Summary

Modifier and Type	Method and Description
String	getId() This method gets the ID used to identify this object.
String	getTitle() This method gets the title of this object.
boolean	isVisible() This method determines if this dialog is currently visible (opened).

Field Detail

PATTERN_DIALOG_ID

static final String PATTERN_DIALOG_ID

The regex pattern dialog IDs have to match.

See Also:

Constant Field Values

Method Detail

getTitle

String getTitle()

This method gets the title of this object.
NOTE:
For generic usage you need to use Object.toString() of the result if NOT null

Specified by:

getTitle in interface AttributeReadTitle<String>

Returns:

the title or null if not set. The string-representation of the result (if NOT null) needs to be suitable for end-users.

getId

String getId()

This method gets the ID used to identify this object. An ID should be unique. The ID of a dialog should only contain ASCII letters, Latin digits, hyphens or underscores. It must NOT contain ':', ';', '&', '?', '=', '/', '\\' or ' '.

Specified by:

getId in interface AttributeReadId<String>

Returns:

the object's ID.

See Also:

DialogConstants.DIALOG_ID_ROOT, DialogConstants.DIALOG_ID_PAGE, DialogConstants.DIALOG_ID_HOME

isVisible

boolean isVisible()

This method determines if this dialog is currently visible (opened).

Specified by:

isVisible in interface AttributeReadVisible

Returns:

true if visible, false otherwise.

See Also:

AttributeReadVisibleRecursive.isVisibleRecursive()