Package com.storedobject.ui.util

Class ApplicationFrame

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.applayout.AppLayout

com.storedobject.vaadin.ApplicationFrame

com.storedobject.ui.util.ApplicationFrame

All Implemented Interfaces:

ApplicationLayout, ApplicationLayout, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.RouterLayout, Serializable

@CssImport("./so/shared-styles.css") @CssImport("./so/animation/animation.css")
public class ApplicationFrame
extends ApplicationFrame
implements ApplicationLayout

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplicationFrame.EntitySelector

Nested classes/interfaces inherited from class com.vaadin.flow.component.applayout.AppLayout

com.vaadin.flow.component.applayout.AppLayout.AppLayoutI18n, com.vaadin.flow.component.applayout.AppLayout.Section

Constructor Summary

Constructors

Constructor	Description
ApplicationFrame()

Method Summary

Modifier and Type	Method	Description
protected ApplicationMenu	createMenu()	Create the menu.
protected com.vaadin.flow.component.HasText	createUserNameComponent()	Create the component to display the "User's name" for the application.
com.vaadin.flow.component.Component	getLogo()	Get the Logo (typically an Image component) to be displayed on the "Nav Bar", next to the "drawer menu" icon.
com.vaadin.flow.component.Component	getMenuSearcher()	Get the "menu searcher" component.
com.vaadin.flow.component.html.Div	getProgressBarHolder()
void	initialized()
boolean	isMenuOpened()
boolean	isMenuVisible()
void	loggedin(Application application)	This method is invoked when user authentication completed.
void	viewDetached(View view)
void	viewSelected(View view)	Closes the menu if it is displayed as an overlay.

Methods inherited from class com.storedobject.vaadin.ApplicationFrame

addToDrawer, closeMenu, createCaptionComponent, getCaption, getCaptionComponent, getComponent, getContentHeight, getContentWidth, getDrawerToggle, getHeaderBackground, getHeaderColor, getHeaderHeight, getMenu, getToolbox, getUserNameComponent, onAttach, openMenu, resizeContent, setCaption, setDrawerOpened, toggleMenu

Methods inherited from class com.vaadin.flow.component.applayout.AppLayout

addToNavbar, addToNavbar, afterNavigation, getContent, getI18n, getPrimarySection, isDrawerOpened, isOverlay, remove, setContent, setI18n, setPrimarySection, showRouterLayoutContent

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.ui.ApplicationLayout

drawMenu

Methods inherited from interface com.storedobject.vaadin.ApplicationLayout

closeMenu, getCaption, getComponent, getContentHeight, getContentWidth, getMenu, openMenu, resizeContent, setCaption, setContent, toggleMenu

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.router.RouterLayout

removeRouterLayoutContent

Constructor Details

ApplicationFrame

public ApplicationFrame()

Method Details

createMenu

protected ApplicationMenu createMenu()

Description copied from class: ApplicationFrame

Create the menu. The component of the menu should be added to the appropriate place within this method. The default implementation adds the menu to the "drawer" area along with the "menu searcher" ApplicationLayout.getMenuSearcher() if one is available.

Overrides:

createMenu in class ApplicationFrame

Returns:

Menu.

getProgressBarHolder

public com.vaadin.flow.component.html.Div getProgressBarHolder()

Specified by:

getProgressBarHolder in interface ApplicationLayout

getMenuSearcher

public com.vaadin.flow.component.Component getMenuSearcher()

Description copied from interface: ApplicationLayout

Get the "menu searcher" component.

Specified by:

getMenuSearcher in interface ApplicationLayout

Returns:

Default implementation returns null.

viewDetached

public void viewDetached(View view)

Specified by:

viewDetached in interface ApplicationLayout

viewSelected

public void viewSelected(View view)

Description copied from class: ApplicationFrame

Closes the menu if it is displayed as an overlay.

Specified by:

viewSelected in interface ApplicationLayout

Overrides:

viewSelected in class ApplicationFrame

Parameters:

view - Currently selected view

isMenuOpened

public boolean isMenuOpened()

Specified by:

isMenuOpened in interface ApplicationLayout

getLogo

public com.vaadin.flow.component.Component getLogo()

Description copied from class: ApplicationFrame

Get the Logo (typically an Image component) to be displayed on the "Nav Bar", next to the "drawer menu" icon.

Overrides:

getLogo in class ApplicationFrame

Returns:

Default implementation returns null so that no icon will be displayed.

loggedin

public void loggedin(Application application)

Description copied from interface: ApplicationLayout

This method is invoked when user authentication completed. Typically, its used to display the user names and other details in some part of the screen.

Specified by:

loggedin in interface ApplicationLayout

Parameters:

application - Application.

createUserNameComponent

protected com.vaadin.flow.component.HasText createUserNameComponent()

Description copied from class: ApplicationFrame

Create the component to display the "User's name" for the application. This will be displayed just before the "toolbox" on the "Nav Bar".

Overrides:

createUserNameComponent in class ApplicationFrame

Returns:

The default implementation returns null so that a Span component is created automatically.

isMenuVisible

public boolean isMenuVisible()

Specified by:

isMenuVisible in interface ApplicationLayout

initialized

public void initialized()

Specified by:

initialized in interface ApplicationLayout