Class VAppLayout

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.applayout.AppLayout
org.vaadin.firitin.appframework.VAppLayout
All Implemented Interfaces:
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:
MainLayout
public abstract class VAppLayout extends com.vaadin.flow.component.applayout.AppLayout
Opinionated helpers and defaults for Vaadin AppLayout. Provides subviews and a slot for view specific components in navbar (will be automatically cleaned up on navigation).
See Also:

  • 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected com.vaadin.flow.component.orderedlayout.HorizontalLayout
    navbarHelpers
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    VAppLayout()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addDrawerContent()
     
    void
    addNavbarHelper(com.vaadin.flow.component.Component component)
    Places a component by the view to the navbar.
    protected void
    afterNavigation()
     
    void
    closeSubView()
     
    void
    closeSubView(com.vaadin.flow.component.Component component)
     
    com.vaadin.flow.component.html.Footer
    getDrawerFooter()
     
    protected abstract Object
    getDrawerHeader()
     
    AdvancedSideNav
    getMenu()
     
    com.vaadin.flow.component.orderedlayout.Scroller
    getMenuScroller()
     
    protected com.vaadin.flow.component.HasComponents
    getNavbarHelpers()
     
    com.vaadin.flow.component.HasText
    getViewTitle()
     
    void
    openSubView(com.vaadin.flow.component.Component component)
     
    void
    openSubView(com.vaadin.flow.component.Component component, String viewTitle)
     
    protected com.vaadin.flow.component.html.Footer
    prepareDrawerFooter()
    Deprecated.
    protected AdvancedSideNav
    prepareNav()
    Deprecated, for removal: This API element is subject to removal in a future version.
    void
    setContent(com.vaadin.flow.component.Component content)
     
    void
    setViewTitle(String title)
    Manually override the current view title.
    protected void
    updateViewTitle()
     

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

    addToDrawer, addToNavbar, addToNavbar, getContent, getI18n, getPrimarySection, isDrawerOpened, isOverlay, onAttach, remove, setDrawerOpened, 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 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

    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

  • Field Details

  • Constructor Details

    • VAppLayout

      public VAppLayout()

  • Method Details

    • getDrawerHeader

      protected abstract Object getDrawerHeader()
      Returns:
      a Component to show as "drawer header" or a simple string.

    • prepareNav

      @Deprecated(forRemoval=true) protected AdvancedSideNav prepareNav()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addDrawerContent

      protected void addDrawerContent()

    • getMenu

      public AdvancedSideNav getMenu()

    • getMenuScroller

      public com.vaadin.flow.component.orderedlayout.Scroller getMenuScroller()

    • prepareDrawerFooter

      @Deprecated protected com.vaadin.flow.component.html.Footer prepareDrawerFooter()
      Deprecated.

    • getDrawerFooter

      public com.vaadin.flow.component.html.Footer getDrawerFooter()

    • setViewTitle

      public void setViewTitle(String title)
      Manually override the current view title.
      Parameters:
      title - the title to set

    • getViewTitle

      public com.vaadin.flow.component.HasText getViewTitle()

    • getNavbarHelpers

      protected com.vaadin.flow.component.HasComponents getNavbarHelpers()

    • addNavbarHelper

      public void addNavbarHelper(com.vaadin.flow.component.Component component)
      Places a component by the view to the navbar. Components are placed to a div at the right edge. The helper component is automatically cleared when navigating away from the view.
      Parameters:
      component - the helper component.

    • updateViewTitle

      protected void updateViewTitle()

    • setContent

      public void setContent(com.vaadin.flow.component.Component content)
      Overrides:
      setContent in class com.vaadin.flow.component.applayout.AppLayout

    • openSubView

      public void openSubView(com.vaadin.flow.component.Component component, String viewTitle)

    • openSubView

      public void openSubView(com.vaadin.flow.component.Component component)

    • closeSubView

      public void closeSubView(com.vaadin.flow.component.Component component)

    • closeSubView

      public void closeSubView()

    • afterNavigation

      protected void afterNavigation()
      Overrides:
      afterNavigation in class com.vaadin.flow.component.applayout.AppLayout