org.linkki.framework.ui.application

Class ApplicationFrame

java.lang.Object

org.linkki.framework.ui.application.ApplicationFrame

All Implemented Interfaces:

Serializable

public class ApplicationFrame
extends Object
implements Serializable

Overall layout frame for the application. Contains the application header, the main work area and a footer.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationFrame()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.navigator.Navigator	createNavigator(com.vaadin.ui.UI ui, com.vaadin.ui.ComponentContainer componentContainer)
com.vaadin.ui.VerticalLayout	getContent() Returns the vertical layout that displays all content.
Optional<com.vaadin.ui.Component>	getCurrentView() Returns the view that is currently displayed if there is any.
protected com.vaadin.ui.VerticalLayout	getMainArea()
protected com.vaadin.navigator.Navigator	getNavigator()
protected com.vaadin.navigator.ViewProvider	getViewProvider()
void	init(com.vaadin.ui.UI ui) Initializes the layout for the given UI.
void	refreshCurrentView() Navigates to the same view as the current view.
<T extends com.vaadin.navigator.View> void	showView(Class<T> clazz) Attempts to show a view of the given class.
<T extends com.vaadin.navigator.View> void	showView(Class<T> clazz, String pathAndParameters) Attempts to show a view of the given class, appending pathAndParameters to the URL to provide information to the called view.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationFrame

public ApplicationFrame()

Method Detail

init

public void init(com.vaadin.ui.UI ui)

Initializes the layout for the given UI.

Can't be done in a layout's constructor as we need the other beans to be injected and also the UI which is still under construction at this point in time.

createNavigator

protected com.vaadin.navigator.Navigator createNavigator(com.vaadin.ui.UI ui,
                                                         com.vaadin.ui.ComponentContainer componentContainer)

getMainArea

protected com.vaadin.ui.VerticalLayout getMainArea()

getViewProvider

protected com.vaadin.navigator.ViewProvider getViewProvider()

getNavigator

protected com.vaadin.navigator.Navigator getNavigator()

getContent

public com.vaadin.ui.VerticalLayout getContent()

Returns the vertical layout that displays all content. Make sure that it was initialized using init(UI) method before calling this method.

showView

public <T extends com.vaadin.navigator.View> void showView(Class<T> clazz)

Attempts to show a view of the given class.

Note that navigation to a view might not be performed if there is a ViewChangeListener that prohibits the navigation. Thus there is no guarantee that a view of the given class is displayed after this method returns.

showView

public <T extends com.vaadin.navigator.View> void showView(Class<T> clazz,
                                                           String pathAndParameters)

Attempts to show a view of the given class, appending pathAndParameters to the URL to provide information to the called view.

Note that navigation to a view might not be performed if there is a ViewChangeListener that prohibits the navigation. Thus there is no guarantee that a view of the given class is displayed after this method returns.

Parameters:

pathAndParameters - a string containing an URL-Like path as well as URL parameters. Must not start with "/". Example: "part1/part2/arg1=23&arg2=42".

getCurrentView

public Optional<com.vaadin.ui.Component> getCurrentView()

Returns the view that is currently displayed if there is any.

refreshCurrentView

public void refreshCurrentView()

Navigates to the same view as the current view. The complete URL will be preserved. This will clear all objects in ViewScoped of dependency injection but will keep the UIScoped. As long as all your state is in UIScoped objects you can call this method to reload the whole UI while keeping current state.

Note: You will get two Page.UriFragmentChangedEvent because we switch to the EmptyCdiView and back to the current view!