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

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

Class UiEmbedding

java.lang.Object

io.github.mmm.ui.api.controller.UiEmbedding

public class UiEmbedding
extends Object

A UiEmbedding represents a location within the view of a UiController where a sub-dialog shall be embedded.

Since:

1.0.0

See Also:

UiController.embed(UiEmbedding, UiController)

Field Summary

Fields

Modifier and Type	Field	Description
static UiEmbedding	CONTENT	UiEmbedding for the footer UiController.
static UiEmbedding	FOOTER	UiEmbedding for the footer UiController.
static UiEmbedding	HEADER	UiEmbedding for the header UiController.
static UiEmbedding	HOME	UiEmbedding for the home UiController.
static UiEmbedding	MARGIN	UiEmbedding for the margin column UiController.
static UiEmbedding	NAVIGATION	UiEmbedding for the navigation UiController.
static UiEmbedding	PAGE	UiEmbedding for the page UiController.

Constructor Summary

Constructors

Constructor	Description
UiEmbedding(String controllerId, String slotId)	The constructor.

Method Summary

Modifier and Type	Method	Description
String	getControllerId()
String	getSlotId()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PAGE

public static final UiEmbedding PAGE

UiEmbedding for the page UiController.

HEADER

public static final UiEmbedding HEADER

UiEmbedding for the header UiController.

FOOTER

public static final UiEmbedding FOOTER

UiEmbedding for the footer UiController.

NAVIGATION

public static final UiEmbedding NAVIGATION

UiEmbedding for the navigation UiController.

CONTENT

public static final UiEmbedding CONTENT

UiEmbedding for the footer UiController.

MARGIN

public static final UiEmbedding MARGIN

UiEmbedding for the margin column UiController.

HOME

public static final UiEmbedding HOME

UiEmbedding for the home UiController.

Constructor Detail

UiEmbedding

public UiEmbedding(String controllerId,
                   String slotId)

The constructor.

Parameters:

controllerId - the controller ID.

slotId - the slot ID.

Method Detail

getControllerId

public final String getControllerId()

Returns:

the ID of the UiController owning the referenced slot.

getSlotId

public String getSlotId()

Returns:

the ID of the slot where to embed. The name slot refers to UiSlot that is a dedicated widget for generic embedding. However, any composite widget may be used as slot to embed child views.

toString

public String toString()

Overrides:

toString in class Object