Package io.jmix.flowui.component.sidepanellayout

Class SidePanelLayout

java.lang.Object

com.vaadin.flow.component.Component

io.jmix.flowui.kit.component.sidepanellayout.JmixSidePanelLayout

io.jmix.flowui.component.sidepanellayout.SidePanelLayout

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, ComponentContainer, HasSubParts, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class SidePanelLayout
extends JmixSidePanelLayout
implements ComponentContainer, HasSubParts, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

The side panel layout component provides a container for a main content area and a side panel.

See Also:

• SidePanelLayoutCloser
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.kit.component.sidepanellayout.JmixSidePanelLayout

JmixSidePanelLayout.ComponentInertManager

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext

Fields inherited from class io.jmix.flowui.kit.component.sidepanellayout.JmixSidePanelLayout

componentInertManager, content, sidePanelContent

Constructor Summary

Constructors

Constructor	Description
SidePanelLayout()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected Optional<com.vaadin.flow.component.Component>	findComponent(com.vaadin.flow.component.Component component, String id)
Optional<com.vaadin.flow.component.Component>	findOwnComponent(String id)	Finds a component within immediate children of the container by its unique identifier.
Collection<com.vaadin.flow.component.Component>	getOwnComponents()	Returns a collection of components that are direct children (immediate descendants) of the container.
Object	getSubPart(String name)	Returns a sub part object by its name.
protected void	initComponent()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class io.jmix.flowui.kit.component.sidepanellayout.JmixSidePanelLayout

addComponent, addModalityCurtainClickListener, addSidePanelAfterOpenListener, addSidePanelBeforeOpenListener, addSidePanelCloseListener, attachSidePanelOpenedChangedListener, closeSidePanel, createComponentInertManager, doSetOpened, fireSidePanelBeforeOpenEvent, fireSidePanelCloseEvent, getContent, getOverlayAriaLabel, getSidePanelContent, getSidePanelHorizontalMaxSize, getSidePanelHorizontalMinSize, getSidePanelHorizontalSize, getSidePanelPosition, getSidePanelVerticalMaxSize, getSidePanelVerticalMinSize, getSidePanelVerticalSize, isCloseOnOutsideClick, isDisplayAsOverlayOnSmallDevices, isModal, isSidePanelOpened, isSidePanelOverlay, onAttach, onDetach, onSidePanelOpenedChanged, openSidePanel, removeComponent, setCloseOnOutsideClick, setContent, setDisplayAsOverlayOnSmallDevices, setModal, setOverlayAriaLabel, setSidePanelContent, setSidePanelHorizontalMaxSize, setSidePanelHorizontalMinSize, setSidePanelHorizontalSize, setSidePanelOverlay, setSidePanelPosition, setSidePanelVerticalMaxSize, setSidePanelVerticalMinSize, setSidePanelVerticalSize, toggleSidePanel, updateContentInert, updateSlot

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, 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.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface io.jmix.flowui.component.ComponentContainer

findComponent, getComponent, getComponents, getOwnComponent

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

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

Constructor Details

SidePanelLayout

public SidePanelLayout()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

initComponent

protected void initComponent()

findOwnComponent

public Optional<com.vaadin.flow.component.Component> findOwnComponent(String id)

Description copied from interface: ComponentContainer

Finds a component within immediate children of the container by its unique identifier.

Specified by:

findOwnComponent in interface ComponentContainer

Parameters:

id - the unique identifier of the component to find

Returns:

an Optional containing the found component if it exists within the immediate children of the container, or an empty Optional if no component with the given identifier is found

getOwnComponents

public Collection<com.vaadin.flow.component.Component> getOwnComponents()

Description copied from interface: ComponentContainer

Returns a collection of components that are direct children (immediate descendants) of the container.

Specified by:

getOwnComponents in interface ComponentContainer

Returns:

a collection of Component instances representing the immediate children of the container, or an empty collection if no such components exist

getSubPart

@Nullable
public Object getSubPart(String name)

Description copied from interface: HasSubParts

Returns a sub part object by its name.

Specified by:

getSubPart in interface HasSubParts

Parameters:

name - sub part name, e.g. component id

Returns:

a sub part object by its name, or null if not found

findComponent

protected Optional<com.vaadin.flow.component.Component> findComponent(com.vaadin.flow.component.Component component,
 String id)