Module io.github.mmm.ui.api.controller

Package io.github.mmm.ui.api.controller

Interface UiController<V extends io.github.mmm.ui.api.widget.UiRegularWidget>

Type Parameters:

V - type of the view.

All Superinterfaces:

io.github.mmm.ui.api.attribute.AttributeReadId, io.github.mmm.ui.api.attribute.AttributeReadTitle, io.github.mmm.ui.api.attribute.AttributeReadVisible

public interface UiController<V extends io.github.mmm.ui.api.widget.UiRegularWidget>
extends io.github.mmm.ui.api.attribute.AttributeReadTitle, io.github.mmm.ui.api.attribute.AttributeReadId, io.github.mmm.ui.api.attribute.AttributeReadVisible

This is the interface for a dialog of the client application. It displays itself in the page of the main application window. It is a singleton instance that is addressed via a UiPlace. A UiController is not a UiWidget should NOT be mixed with a winodw or popup.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID_CONTENT	The id of the content UiController.
static String	ID_FOOTER	The id of the header UiController.
static String	ID_HEADER	The id of the header UiController.
static String	ID_HOME	The id of the UiController for the home page.
static String	ID_MARGIN	The id of the margin UiController.
static String	ID_NAVIGATION	The id of the navigation UiController.
static String	ID_PAGE	The id of the page UiController.
static String	ID_ROOT	The id of the root UiController.

Method Summary

Modifier and Type	Method	Description
void	embed(UiEmbedding embedding, UiController<?> childController)	Embeds the view of the given child UiController into the specified slot of this controllers view.
String	getId()	The ID of a controller should only contain ASCII letters, Latin digits, hyphens or underscores.
String	getTitle()
V	getView()
default boolean	isNavigable()

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadVisible

isVisible

Field Detail

ID_ROOT

static final String ID_ROOT

The id of the root UiController.

See Also:

Constant Field Values

ID_HOME

static final String ID_HOME

The id of the UiController for the home page.

See Also:

Constant Field Values

ID_PAGE

static final String ID_PAGE

The id of the page UiController.

See Also:

Constant Field Values

ID_CONTENT

static final String ID_CONTENT

The id of the content UiController.

See Also:

Constant Field Values

ID_NAVIGATION

static final String ID_NAVIGATION

The id of the navigation UiController.

See Also:

Constant Field Values

ID_HEADER

static final String ID_HEADER

The id of the header UiController. Its view is supposed to be embedded at the top of the page.

See Also:

Constant Field Values

ID_FOOTER

static final String ID_FOOTER

The id of the header UiController. Its view is supposed to be embedded at the bottom of the page.

See Also:

Constant Field Values

ID_MARGIN

static final String ID_MARGIN

The id of the margin UiController. Its view is supposed to be embedded at the right of the page (in the margin column).

See Also:

Constant Field Values

Method Detail

getId

String getId()

The ID of a controller should only contain ASCII letters, Latin digits, hyphens or underscores. It may also contain slashes ('/') or the hash sign ('#'). It must not contain '?', '&', '=', ':', ';', '\\' or ' '.

Specified by:

getId in interface io.github.mmm.ui.api.attribute.AttributeReadId

See Also:

ID_ROOT, ID_PAGE, ID_HOME

getTitle

String getTitle()

Specified by:

getTitle in interface io.github.mmm.ui.api.attribute.AttributeReadTitle

isNavigable

default boolean isNavigable()

Returns:

true if this UiController can be navigated directly (default), false otherwise. Override this method for internal parent controllers than may not be navigated directly.

getView

V getView()

Returns:

the view of this UiController. The view is the actual UI represented by a UiWidget, typically a regular widget.

embed

void embed(UiEmbedding embedding,
           UiController<?> childController)

Embeds the view of the given child UiController into the specified slot of this controllers view.

Parameters:

embedding - the slotId where to embed the given child UiControllers view.

childController - the child controller to embed.