com.vaadin.flow.component.applayout

Class AppLayout

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.applayout.AppLayout

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable

@Tag(value="vaadin-app-layout")
 @HtmlImport(value="frontend://bower_components/vaadin-app-layout/src/vaadin-app-layout.html")
public class AppLayout
extends com.vaadin.flow.component.Component

Server-side component for the <vaadin-app-layout> element. Provides a quick and easy way to get a common application layout.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AppLayout()

Method Summary

Modifier and Type	Method and Description
AppLayoutMenu	createMenu() Creates a new empty AppLayoutMenu and sets it as the menu for this AppLayout instance.
com.vaadin.flow.dom.Element	getContent() Returns the Element
com.vaadin.flow.dom.Element	getMenu()
void	removeBranding() Clears the branding area
void	removeContent() Removes the displayed content.
void	removeMenu() Remove the menu.
void	setBranding(com.vaadin.flow.component.Component branding) Sets the component into branding area
void	setBranding(com.vaadin.flow.dom.Element branding) Sets the element into branding area
void	setContent(com.vaadin.flow.component.Component content) Sets the displayed content.
void	setContent(com.vaadin.flow.dom.Element content) Sets the displayed content.
void	setMenu(com.vaadin.flow.dom.Element menu) Sets the element to be placed in the menu slot.
void	setMenu(com.vaadin.flow.component.HasElement menu) Sets the component to be placed in the menu slot.

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.vaadin.flow.component.AttachNotifier

addAttachListener

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

addDetachListener

Constructor Detail

AppLayout

public AppLayout()

Method Detail

setBranding

public void setBranding(com.vaadin.flow.component.Component branding)

Sets the component into branding area

Parameters:

branding - Component to set into branding area

setBranding

public void setBranding(com.vaadin.flow.dom.Element branding)

Sets the element into branding area

Parameters:

branding - Element to set into branding area

removeBranding

public void removeBranding()

Clears the branding area

getContent

public com.vaadin.flow.dom.Element getContent()

Returns the Element

setContent

public void setContent(com.vaadin.flow.component.Component content)

Sets the displayed content.

Parameters:

content - Component to display in the content area

setContent

public void setContent(com.vaadin.flow.dom.Element content)

Sets the displayed content.

Parameters:

content - Element to display in the content area

removeContent

public void removeContent()

Removes the displayed content.

getMenu

public com.vaadin.flow.dom.Element getMenu()

Returns:

Element displayed at the content area.

setMenu

public void setMenu(com.vaadin.flow.component.HasElement menu)

Sets the component to be placed in the menu slot.

Parameters:

menu - HasElement to placed in the menu slot.

setMenu

public void setMenu(com.vaadin.flow.dom.Element menu)

Sets the element to be placed in the menu slot.

Parameters:

menu - Element to placed in the menu slot.

createMenu

public AppLayoutMenu createMenu()

Creates a new empty AppLayoutMenu and sets it as the menu for this AppLayout instance.

Returns:

AppLayoutMenu created.

removeMenu

public void removeMenu()

Remove the menu.