Package com.storedobject.vaadin

Class ApplicationFrame

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.applayout.AppLayout

com.storedobject.vaadin.ApplicationFrame

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplicationFrame

@CssImport(value="./so/appframe/styles.css",
           themeFor="vaadin-app-layout")
public abstract class ApplicationFrame
extends com.vaadin.flow.component.applayout.AppLayout
implements ApplicationLayout

An implementation of ApplicationLayout using Vaadin's AppLayout. The "drawer" area acts as the "menu" area of the ApplicationLayout.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

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()	Constructor.

Method Summary

Modifier and Type	Method	Description
final void	addToDrawer(com.vaadin.flow.component.Component... components)
void	closeMenu()	Close the side menu ("drawer" part of the AppLayout) programmatically.
protected com.vaadin.flow.component.HasText	createCaptionComponent()	Get the component to display the "caption" of the application.
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.
String	getCaption()	Get the caption of the application.
final com.vaadin.flow.component.HasText	getCaptionComponent()	Get the component to display the "caption" of the application.
final com.vaadin.flow.component.Component	getComponent()	The component of the "layout".
String	getContentHeight()	Get the height of the content area.
String	getContentWidth()	Get the width of the content area.
final com.vaadin.flow.component.applayout.DrawerToggle	getDrawerToggle()	Get the drawer-toggle button.
String	getHeaderBackground()	Get the background color of the header area.
String	getHeaderColor()	Get the foreground color of the header area.
String	getHeaderHeight()	Get the height of the header area.
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.
final ApplicationMenu	getMenu()	The "menu" of the layout.
ButtonLayout	getToolbox()	Get the "toolbox" to display at the top-right corner of the screen (right most side of the "Nav Bar").
final com.vaadin.flow.component.HasText	getUserNameComponent()	Get the component to display the "User's name" for the application.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	openMenu()	Open the side menu ("drawer" part of the AppLayout) programmatically.
void	resizeContent()	Resize the "content" portion of the "layout" to the desired size.
void	setCaption(String caption)	Set the caption of the Application.
void	setDrawerOpened(boolean drawerOpened)	Workaround for the bug.
void	toggleMenu()	Toggle the side menu ("drawer" part of the AppLayout) programmatically.
void	viewSelected(View view)	Closes the menu if it is displayed as an overlay.

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.vaadin.ApplicationLayout

drawMenu, getMenuSearcher, loggedin, setContent

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()

Constructor.

Method Details

createMenu

protected ApplicationMenu createMenu()

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.

Returns:

Menu.

addToDrawer

public final void addToDrawer(com.vaadin.flow.component.Component... components)

Overrides:

addToDrawer in class com.vaadin.flow.component.applayout.AppLayout

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.applayout.AppLayout

resizeContent

public void resizeContent()

Description copied from interface: ApplicationLayout

Resize the "content" portion of the "layout" to the desired size. This default implementation is suitable for almost all the cases. Otherwise, your overridden method should invoke this as part of your implementation because this sets some important style variables for sizing the "content" area.

Specified by:

resizeContent in interface ApplicationLayout

getCaption

public String getCaption()

Description copied from interface: ApplicationLayout

Get the caption of the application.

Specified by:

getCaption in interface ApplicationLayout

Returns:

The default implementation returns "SO Application">.

getHeaderHeight

public String getHeaderHeight()

Get the height of the header area.

Returns:

Height. Default value is "9vh".

getHeaderBackground

public String getHeaderBackground()

Get the background color of the header area.

Returns:

Background color. Default is "var(--lumo-primary-color)";

getHeaderColor

public String getHeaderColor()

Get the foreground color of the header area.

Returns:

Color. Default is "var(--lumo-primary-contrast-color)";

getContentWidth

public String getContentWidth()

Description copied from interface: ApplicationLayout

Get the width of the content area.

Specified by:

getContentWidth in interface ApplicationLayout

Returns:

Width.

getContentHeight

public String getContentHeight()

Description copied from interface: ApplicationLayout

Get the height of the content area.

Specified by:

getContentHeight in interface ApplicationLayout

Returns:

Height.

setCaption

public void setCaption(String caption)

Set the caption of the Application.

Specified by:

setCaption in interface ApplicationLayout

Parameters:

caption - Caption

getLogo

public 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.

Returns:

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

getToolbox

public ButtonLayout getToolbox()

Get the "toolbox" to display at the top-right corner of the screen (right most side of the "Nav Bar").

Returns:

A default ButtonLayout is returned but one can override this too. Otherwise, one may add his/her "tool" buttons or icons into it.

getDrawerToggle

public final com.vaadin.flow.component.applayout.DrawerToggle getDrawerToggle()

Get the drawer-toggle button.

Returns:

The drawer-toggle button.

createCaptionComponent

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

Get the component to display the "caption" of the application. This will be displayed to the right of the "Logo" on the "Nav Bar" with "touchOptimized" as true (see AppLayout.addToNavbar(boolean, Component...)).

Returns:

The default implementation returns null so that an H2 component is created automatically.

getCaptionComponent

public final com.vaadin.flow.component.HasText getCaptionComponent()

Get the component to display the "caption" of the application. This will be displayed to the right of the "Logo" on the "Nav Bar" with "touchOptimized" as true (see AppLayout.addToNavbar(boolean, Component...)).

Returns:

The default implementation returns an H2 component if createCaptionComponent() is not overridden.

createUserNameComponent

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

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

Returns:

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

getUserNameComponent

public final com.vaadin.flow.component.HasText getUserNameComponent()

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

Returns:

The default implementation returns a Span component if createUserNameComponent() is not overridden.

getComponent

public final com.vaadin.flow.component.Component getComponent()

Description copied from interface: ApplicationLayout

The component of the "layout".

Specified by:

getComponent in interface ApplicationLayout

Returns:

The main layout component.

getMenu

public final ApplicationMenu getMenu()

Description copied from interface: ApplicationLayout

The "menu" of the layout.

Specified by:

getMenu in interface ApplicationLayout

Returns:

Menu of the layout.

openMenu

public void openMenu()

Open the side menu ("drawer" part of the AppLayout) programmatically.

Specified by:

openMenu in interface ApplicationLayout

closeMenu

public void closeMenu()

Close the side menu ("drawer" part of the AppLayout) programmatically.

Specified by:

closeMenu in interface ApplicationLayout

toggleMenu

public void toggleMenu()

Toggle the side menu ("drawer" part of the AppLayout) programmatically.

Specified by:

toggleMenu in interface ApplicationLayout

setDrawerOpened

public void setDrawerOpened(boolean drawerOpened)

Workaround for the bug.

Overrides:

setDrawerOpened in class com.vaadin.flow.component.applayout.AppLayout

Parameters:

drawerOpened - True or false

viewSelected

public void viewSelected(View view)

Closes the menu if it is displayed as an overlay.

Specified by:

viewSelected in interface ApplicationLayout

Parameters:

view - Currently selected view