UiNavigationEvent (JavaDocs for mmm-ui-api-controller 0.1.1)

java.lang.Object
- io.github.mmm.ui.api.controller.UiNavigationEvent

All Implemented Interfaces:: io.github.mmm.ui.api.attribute.AttributeReadProgrammatic

public class UiNavigationEvent
extends Object
implements io.github.mmm.ui.api.attribute.AttributeReadProgrammatic

Event for navigation.

Since:: 1.0.0

- Constructor Summary
  
  Constructors
  Constructor Description
  
  UiNavigationEvent(UiPlace oldPlace, UiPlace newPlace, boolean programmatic)
  The constructor.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  UiPlace getNewPlace()
  
  UiPlace getOldPlace()
  
  boolean isProgrammatic()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UiNavigationEvent
```
public UiNavigationEvent(UiPlace oldPlace,
                         UiPlace newPlace,
                         boolean programmatic)
```
    The constructor.
    
    Parameters:
    
    oldPlace - the old place.
    
    newPlace - the new place.
    
    programmatic - the programmatic flag.
- Method Detail
  - getOldPlace
```
public UiPlace getOldPlace()
```
    Returns:
    
    the old (previous) UiPlace that was left during the navigation. The very first navigation event will use UiPlace.NONE.
  - getNewPlace
```
public UiPlace getNewPlace()
```
    Returns:
    
    the new UiPlace that was entered during the navigation.
  - isProgrammatic
```
public boolean isProgrammatic()
```
    Specified by:
    
    isProgrammatic in interface io.github.mmm.ui.api.attribute.AttributeReadProgrammatic