org.apache.tamaya.ui

Interface ViewProvider

All Known Implementing Classes:

ConfigUpdaterView.Provider, ConfigView.Provider, EventView.Provider, HomeView.Provider, SystemView.Provider

public interface ViewProvider

Interface to register Tamaya UI parts. For priorization also use the @Priority annotations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ViewProvider.ViewLifecycle View lifecycle options that determine when a view is created and how long an instance is used.

Method Summary

Modifier and Type	Method and Description
com.vaadin.navigator.View	createView() Method that is called to create a new view instance.
String	getDisplayName() Get the name to be displayed for this view.
ViewProvider.ViewLifecycle	getLifecycle() Get the view lifecycle model.
String	getUrlPattern() Get the url pattern where this view should be accessible.

Method Detail

getLifecycle

ViewProvider.ViewLifecycle getLifecycle()

Get the view lifecycle model.

Returns:

the lifecycle model, not null.

getUrlPattern

String getUrlPattern()

Get the url pattern where this view should be accessible.

Returns:

the url pattern, not null.

getDisplayName

String getDisplayName()

Get the name to be displayed for this view. This value will also be used to lookup a name from the /ui/lang/tamaya bundle. If not found the value returned will be used for display.

Returns:

the name to be displayed, or its resource bundle key, not null.

createView

com.vaadin.navigator.View createView()

Method that is called to create a new view instance.

Returns:

a new view instance, not null.

See Also:

getLifecycle()