java.lang.Object
- io.github.mmm.ui.spi.controller.AbstractUiController<V>

Type Parameters:

V - type of the view.

All Implemented Interfaces:

AttributeReadId, AttributeReadTitle, AttributeReadVisible, UiController<V>

Direct Known Subclasses:

AbstractUiControllerContent, AbstractUiControllerNavigation, UiControllerRoot
```
public abstract class AbstractUiController<V extends UiRegularWidget>
extends Object
implements UiController<V>
```
Abstract base implementation of UiController.

Since:

1.0.0

Field Summary
- Fields inherited from interface io.github.mmm.ui.api.controller.UiController
  ID_CONTENT, ID_FOOTER, ID_HEADER, ID_HOME, ID_MARGIN, ID_NAVIGATION, ID_PAGE, ID_ROOT

Constructor Summary

Constructors
Constructor Description

AbstractUiController()
The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract V`	`createView()`
`protected boolean`	`doEmbed(String slotId, UiController<?> childController)`	Override this method for parent controllers to embed children.
`protected abstract UiEmbedding`	`doShow(UiPlace newPlace, UiEmbedding newSlot)`
`void`	`embed(UiEmbedding newEmbedding, UiController<?> childController)`	Embeds the `view` of the given child `UiController` into the `specified slot` of this controllers `view`.
`protected UiEmbedding`	`getEmbedding()`
`String`	`getTitle()`
`V`	`getView()`
`void`	`hide()`	This method is called when this controller was hidden (its `view` is replaced in the slot it was embedded by another controller).
`boolean`	`isVisible()`
`protected void`	`onHide()`	This method gets called whenever the `view` is hidden from the screen.
`protected void`	`onReset()`	This method gets called whenever this controller is `reseted`.
`protected void`	`onShow()`	This method gets called whenever the `view` is shown on the screen.
`void`	`reset()`	This method resets this `AbstractUiController` and disposes its `view`.
`UiEmbedding`	`show(UiPlace newPlace)`	Shows this controller (creates/updates and opens its `view`) as triggered by the given `UiPlace`.
`UiEmbedding`	`show(UiPlace newPlace, UiEmbedding newEmbedding)`	Shows this controller (creates/updates and opens its `view`) as triggered by the given `UiPlace`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.mmm.ui.api.controller.UiController
getId, isNavigable

- Constructor Detail
  - AbstractUiController
```
public AbstractUiController()
```
    The constructor.
- Method Detail
  - getView
```
public V getView()
```
    Specified by:
    
    getView in interface UiController<V extends UiRegularWidget>
    
    Returns:
    
    the view of this UiController. The view is the actual UI represented by a UiWidget, typically a regular widget.
  - createView
```
protected abstract V createView()
```
    Returns:
    
    the new instance of the view.
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface AttributeReadTitle
    
    Specified by:
    
    getTitle in interface UiController<V extends UiRegularWidget>
    
    Returns:
    
    the title of this object. Similar to text but more exposed (e.g. displayed in title-bar in case of a window). Will be the empty String if not set.
  - getEmbedding
```
protected UiEmbedding getEmbedding()
```
    Returns:
    
    the UiEmbedding where this controller is embedded into its parent controller.
  - show
```
public final UiEmbedding show(UiPlace newPlace)
```
    Shows this controller (creates/updates and opens its view) as triggered by the given UiPlace.
    
    Parameters:
    
    newPlace - the UiPlace identifying this UiController and providing potential parameters.
    
    Returns:
    
    the UiEmbedding where to embed this controller into a parent controller or null if this is the root controller.
  - show
```
public final UiEmbedding show(UiPlace newPlace,
                              UiEmbedding newEmbedding)
```
    Shows this controller (creates/updates and opens its view) as triggered by the given UiPlace.
    
    Parameters:
    
    newPlace - the UiPlace to open. It identifies the leaf child UiController and provides potential parameters.
    
    newEmbedding - the optional UiEmbedding where to embed the child controller.
    
    Returns:
    
    the UiEmbedding where to embed this controller into a parent controller or null if this is the root controller.
  - doShow
```
protected abstract UiEmbedding doShow(UiPlace newPlace,
                                      UiEmbedding newSlot)
```
    Parameters:
    
    newPlace - the UiPlace to open. It identifies the leaf child UiController and provides potential parameters.
    
    newSlot - the optional UiEmbedding where to embed the child controller.
    
    Returns:
    
    the UiEmbedding where to embed this controller into a parent controller or null if this is the root controller.
  - embed
```
public final void embed(UiEmbedding newEmbedding,
                        UiController<?> childController)
```
    Description copied from interface: UiController
    
    Embeds the view of the given child UiController into the specified slot of this controllers view.
    
    Specified by:
    
    embed in interface UiController<V extends UiRegularWidget>
    
    Parameters:
    
    newEmbedding - the slotId where to embed the given child UiControllers view.
    
    childController - the child controller to embed.
  - doEmbed
```
protected boolean doEmbed(String slotId,
                          UiController<?> childController)
```
    Override this method for parent controllers to embed children.
    
    Parameters:
    
    slotId - the slot ID where to embed the given child UiControllers view.
    
    childController - the child controller to embed.
    
    Returns:
    
    true if the embedded slot is dynamic (e.g. a new closable tab), false otherwise if static and reusable slot in the UI (default).
    
    See Also:
    
    embed(UiEmbedding, UiController)
  - isVisible
```
public boolean isVisible()
```
    Specified by:
    
    isVisible in interface AttributeReadVisible
    
    Returns:
    
    true if visible, false if hidden.
  - reset
```
public final void reset()
```
    This method resets this AbstractUiController and disposes its view.
  - hide
```
public final void hide()
```
    This method is called when this controller was hidden (its view is replaced in the slot it was embedded by another controller).
  - onReset
```
protected void onReset()
```
    This method gets called whenever this controller is reseted. If you keep custom state information you need to override and reset your state.
  - onShow
```
protected void onShow()
```
    This method gets called whenever the view is shown on the screen. It can be overridden to trigger custom logic - e.g. to update data.
  - onHide
```
protected void onHide()
```
    This method gets called whenever the view is hidden from the screen. It can be overridden to trigger custom logics or to clean up resources.

Class AbstractUiController<V extends UiRegularWidget>

Field Summary

Fields inherited from interface io.github.mmm.ui.api.controller.UiController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.ui.api.controller.UiController

Constructor Detail

AbstractUiController

Method Detail

getView

createView

getTitle

getEmbedding

show

show

doShow

embed

doEmbed

isVisible

reset

hide

onReset

onShow

onHide