Package com.vaadin.navigator

Class ViewChangeListener.ViewChangeEvent

java.lang.Object

java.util.EventObject

com.vaadin.navigator.ViewChangeListener.ViewChangeEvent

All Implemented Interfaces:

Serializable

Enclosing interface:

ViewChangeListener

public static class ViewChangeListener.ViewChangeEvent
extends EventObject

Event received by the listener for attempted and executed view changes.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ViewChangeEvent(Navigator navigator, View oldView, View newView, String viewName, String parameters)	Create a new view change event.

Method Summary

Modifier and Type	Method	Description
Navigator	getNavigator()	Returns the navigator that triggered this event.
View	getNewView()	Returns the view being activated.
View	getOldView()	Returns the view being deactivated.
Map<String,String>	getParameterMap()	Returns the parameters for the view being activated parsed to a map, using & as the parameter separator character.
Map<String,String>	getParameterMap(String separator)	Returns the parameters for the view being activated parsed to a map, using the given string as the parameter separator character.
String	getParameters()	Returns the parameters for the view being activated.
String	getViewName()	Returns the view name of the view being activated.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewChangeEvent

public ViewChangeEvent(Navigator navigator,
                       View oldView,
                       View newView,
                       String viewName,
                       String parameters)

Create a new view change event.

Parameters:

navigator - Navigator that triggered the event, not null

Method Detail

getNavigator

public Navigator getNavigator()

Returns the navigator that triggered this event.

Returns:

Navigator (not null)

getOldView

public View getOldView()

Returns the view being deactivated.

Returns:

old View

getNewView

public View getNewView()

Returns the view being activated.

Returns:

new View

getViewName

public String getViewName()

Returns the view name of the view being activated.

Returns:

view name of the new View

getParameters

public String getParameters()

Returns the parameters for the view being activated.

Returns:

navigation parameters (potentially bookmarkable) for the new view

getParameterMap

public Map<String,String> getParameterMap()

Returns the parameters for the view being activated parsed to a map, using & as the parameter separator character.

Returns:

navigation parameters (potentially bookmarkable) for the new view

Since:

8.1

getParameterMap

public Map<String,String> getParameterMap(String separator)

Returns the parameters for the view being activated parsed to a map, using the given string as the parameter separator character.

Parameters:

separator - the parameter separator string to use

Returns:

navigation parameters (potentially bookmarkable) for the new view

Since:

8.1