java.lang.Object
- io.github.mmm.event.AbstractEventSource<UiNavigationEvent,UiNavigationEventListener>
- - io.github.mmm.ui.spi.controller.AbstractUiNavigationManager

All Implemented Interfaces:

EventSource<UiNavigationEvent,UiNavigationEventListener>, UiNavigationManager

Direct Known Subclasses:

AbstractUiNavigationManagerImpl
```
public abstract class AbstractUiNavigationManager
extends AbstractEventSource<UiNavigationEvent,UiNavigationEventListener>
implements UiNavigationManager
```
Abstract base implementation of UiNavigationManager.

Since:

1.0.0

Constructor Summary

Constructors
Constructor Description

AbstractUiNavigationManager()
The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`addHistory(UiPlace place)`
`protected abstract void`	`doInit()`
`<W extends UiRegularWidget> AbstractUiController<W>`	`getController(String id)`
`UiPlace`	`getCurrentPlace()`
`<W extends UiRegularWidget> AbstractUiController<W>`	`getRequiredController(String id)`
`void`	`init()`	Initializes this navigation manager and navigates to the initial `UiPlace`.
`protected AbstractUiController<?>`	`navigateRecursive(UiPlace place, UiEmbedding embedding)`
`void`	`navigateTo(UiPlace place, boolean replace)`	Navigates to the given `UiPlace`.
`protected void`	`navigateTo(UiPlace place, UiNavigationMode mode, boolean programmatic)`
`protected void`	`onEmbedded(UiEmbedding embedding, AbstractUiController<?> controller)`	Called from `AbstractUiController.embed(UiEmbedding, UiController)` to register `UiController`s in their current `UiEmbedding`s and hide previous `UiController`s when replaced in that `slot`.
`protected abstract void`	`replaceHistory(UiPlace place)`
`void`	`updatePlace(UiPlace place)`	Replaces the `current place` with the given `UiPlace` without creating a new entry in the navigation history.

Methods inherited from class io.github.mmm.event.AbstractEventSource
addListener, fireEvent, getEventAdapter, hasListeners, removeListener

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.event.EventSource
addListener, addListener, addWeakListener, removeListener

Methods inherited from interface io.github.mmm.ui.api.controller.UiNavigationManager
navigateBack, navigateForward, navigateTo

- Constructor Detail
  - AbstractUiNavigationManager
```
public AbstractUiNavigationManager()
```
    The constructor.
- Method Detail
  - getController
```
public <W extends UiRegularWidget> AbstractUiController<W> getController(String id)
```
    Specified by:
    
    getController in interface UiNavigationManager
    
    Type Parameters:
    
    W - type of the view.
    
    Parameters:
    
    id - the ID of the requested UiController.
    
    Returns:
    
    the requested UiController or null if no such UiController exists.
  - getRequiredController
```
public <W extends UiRegularWidget> AbstractUiController<W> getRequiredController(String id)
```
    Specified by:
    
    getRequiredController in interface UiNavigationManager
    
    Type Parameters:
    
    W - type of the view.
    
    Parameters:
    
    id - the ID of the requested UiController.
    
    Returns:
    
    the requested UiController.
  - init
```
public final void init()
```
    Initializes this navigation manager and navigates to the initial UiPlace.
  - doInit
```
protected abstract void doInit()
```
    See Also:
    
    init()
  - getCurrentPlace
```
public UiPlace getCurrentPlace()
```
    Specified by:
    
    getCurrentPlace in interface UiNavigationManager
    
    Returns:
    
    the current UiPlace. Will be null until initialized by first navigation.
  - navigateTo
```
public void navigateTo(UiPlace place,
                       boolean replace)
```
    Description copied from interface: UiNavigationManager
    
    Navigates to the given UiPlace.
    
    Specified by:
    
    navigateTo in interface UiNavigationManager
    
    Parameters:
    
    place - is the UiPlace identifying the UiController to open.
    
    replace - - if true the current place will be replaced with the given UiPlace, false otherwise (default). Replacing is e.g. helpful for UiControllers that do logical decisions and only redirect to the actual UiPlace.
  - navigateTo
```
protected void navigateTo(UiPlace place,
                          UiNavigationMode mode,
                          boolean programmatic)
```
    Parameters:
    
    place - is the UiPlace identifying the UiController to open.
    
    mode - the UiNavigationMode.
    
    programmatic - the programmatic flag.
    
    See Also:
    
    UiNavigationManager.navigateTo(UiPlace)
  - addHistory
```
protected abstract void addHistory(UiPlace place)
```
    Parameters:
    
    place - is the UiPlace to add to the history.
    
    See Also:
    
    UiNavigationManager.navigateTo(UiPlace)
  - replaceHistory
```
protected abstract void replaceHistory(UiPlace place)
```
    Parameters:
    
    place - is the UiPlace to replace the current place in the history.
    
    See Also:
    
    UiNavigationManager.navigateTo(UiPlace)
  - updatePlace
```
public void updatePlace(UiPlace place)
```
    Description copied from interface: UiNavigationManager
    
    Replaces the current place with the given UiPlace without creating a new entry in the navigation history.
    
    Specified by:
    
    updatePlace in interface UiNavigationManager
    
    Parameters:
    
    place - the updated UiPlace. Currently the ID of the current place may not change. This is only to update parameters. E.g. if you want to represent the selection of a master-detail dialog in the location (URL) you can use a parameter. This method allows to update the UiPlace and therefore the location without adding it to the history so UiNavigationManager.navigateBack() navigating back} is not replaying the entire history of the end-users selection what is typically undesired.
  - navigateRecursive
```
protected AbstractUiController<?> navigateRecursive(UiPlace place,
                                                    UiEmbedding embedding)
```
    Parameters:
    
    place - the UiPlace.
    
    embedding - the optional UiEmbedding.
    
    Returns:
    
    the AbstractUiController that has been shown.
  - onEmbedded
```
protected void onEmbedded(UiEmbedding embedding,
                          AbstractUiController<?> controller)
```
    Called from AbstractUiController.embed(UiEmbedding, UiController) to register UiControllers in their current UiEmbeddings and hide previous UiControllers when replaced in that slot.
    
    Parameters:
    
    embedding - the UiEmbedding.
    
    controller - the AbstractUiController.

Class AbstractUiNavigationManager

Constructor Summary

Method Summary

Methods inherited from class io.github.mmm.event.AbstractEventSource

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.event.EventSource

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

Constructor Detail

AbstractUiNavigationManager

Method Detail

getController

getRequiredController

init

doInit

getCurrentPlace

navigateTo

navigateTo

addHistory

replaceHistory

updatePlace

navigateRecursive

onEmbedded