Package org.neotropic.util.visual.general

Class ModuleLayout

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.orderedlayout.FlexLayout

org.neotropic.util.visual.general.ModuleLayout

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.orderedlayout.FlexLayout>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents<com.vaadin.flow.component.orderedlayout.FlexLayout>, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.orderedlayout.FlexComponent<com.vaadin.flow.component.orderedlayout.FlexLayout>, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.internal.BeforeEnterHandler, com.vaadin.flow.router.RouterLayout, Serializable

Direct Known Subclasses:

AuditTrailLayout, ConfigurationVariablesLayout, ContactManagerLayout, ContainmentManagerLayout, ContractManagerLayout, DataModelManagerLayout, FilterDefinitionLayout, IpamLayout, LayoutEditorLayout, ListTypeManagerLayout, MplsLayout, NavigationLayout, OutsidePlantManagerLayout, PoolsLayout, ProcessEditorLayout, ProcessManagerLayout, ProjectsLayout, ProxyManagerLayout, QueriesLayout, ReportsLayout, SchedulingLayout, SdhLayout, ServiceManagerLayout, SessionManagerLayout, SoftwareManagerLayout, SynchronizationLayout, TaskManagerLayout, TemplateManagerLayout, TopologyDesignerLayout, UserManagerLayout, ValidatorDefinitionLayout, WarehousesManagerLayout

@StyleSheet("css/main.css") @StyleSheet("css/main-layout.css")
public class ModuleLayout
extends com.vaadin.flow.component.orderedlayout.FlexLayout
implements com.vaadin.flow.router.RouterLayout, com.vaadin.flow.router.BeforeEnterObserver

The super class of all flex layouts used in every module of the application.

Author:

Charles Edward Bedon Cortazar <charles.bedon@kuwaiba.org>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.orderedlayout.FlexLayout

com.vaadin.flow.component.orderedlayout.FlexLayout.ContentAlignment, com.vaadin.flow.component.orderedlayout.FlexLayout.FlexDirection, com.vaadin.flow.component.orderedlayout.FlexLayout.FlexWrap, com.vaadin.flow.component.orderedlayout.FlexLayout.WrapMode

Nested classes/interfaces inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

com.vaadin.flow.component.orderedlayout.FlexComponent.Alignment, com.vaadin.flow.component.orderedlayout.FlexComponent.JustifyContentMode

Field Summary

Fields

Modifier and Type	Field	Description
protected ApplicationEntityManager	aem	Reference to the Application Entity Manager so we can check if the Vaadin session is still valid.
protected ModuleRegistry	moduleRegistry	Reference to the module registry.
protected TranslationService	ts	Reference to the translation service.

Constructor Summary

Constructors

Constructor	Description
ModuleLayout()

Method Summary

Modifier and Type	Method	Description
void	beforeEnter(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)	Validates the privileges assigned to the user to access the application modules.
void	buildHeader(Session session)
void	buildTopMenu(Session session)	Builds the menu inside the header section that contains the options organized in categories (each category is a top-level menu).
protected String	getModuleId()
void	showRouterLayoutContent(com.vaadin.flow.component.HasElement content)

Methods inherited from class com.vaadin.flow.component.orderedlayout.FlexLayout

getAlignContent, getFlexBasis, getFlexDirection, getFlexShrink, getFlexWrap, getOrder, getWrapMode, setAlignContent, setFlexBasis, setFlexDirection, setFlexShrink, setFlexWrap, setOrder, setWrapMode

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, 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.ClickNotifier

addClickListener, addClickShortcut

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

addDetachListener

Methods inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

expand, getAlignItems, getAlignSelf, getFlexGrow, getJustifyContentMode, replace, setAlignItems, setAlignSelf, setFlexGrow, setJustifyContentMode

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

add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

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

getElement

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

isEnabled, setEnabled

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

getChildren, getComponentAt, getComponentCount, indexOf

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

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

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 Detail

ts

@Autowired
protected TranslationService ts

Reference to the translation service.

aem

@Autowired
protected ApplicationEntityManager aem

Reference to the Application Entity Manager so we can check if the Vaadin session is still valid.

moduleRegistry

@Autowired
protected ModuleRegistry moduleRegistry

Reference to the module registry.

Constructor Detail

ModuleLayout

public ModuleLayout()

Method Detail

buildHeader

public void buildHeader(Session session)

buildTopMenu

public void buildTopMenu(Session session)

Builds the menu inside the header section that contains the options organized in categories (each category is a top-level menu).

Parameters:

session - The session object. This object is used to validate the sections available according to the user privileges.

beforeEnter

public void beforeEnter(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)

Validates the privileges assigned to the user to access the application modules.

Specified by:

beforeEnter in interface com.vaadin.flow.router.internal.BeforeEnterHandler

showRouterLayoutContent

public void showRouterLayoutContent(com.vaadin.flow.component.HasElement content)

Specified by:

showRouterLayoutContent in interface com.vaadin.flow.router.RouterLayout

getModuleId

protected String getModuleId()