io.jmix.ui.component.mainwindow

Interface Drawer

All Superinterfaces:

Component, Component.BelongToFrame, ComponentContainer, HasComponents, OrderedContainer

All Known Implementing Classes:

DrawerImpl

@StudioComponent(caption="Drawer",
                 category="Main window",
                 xmlElement="drawer",
                 canvasBehaviour=CONTAINER,
                 containerType=VERTICAL,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/containers/drawer.html",
                 unsupportedProperties={"align","enable","expand","responsive","width","height","visible"},
                 icon="io/jmix/ui/icon/mainwindow/drawer.svg")
public interface Drawer
extends OrderedContainer, Component.BelongToFrame

A panel that can be collapsed to the left hand side.

Typically used as a side menu container.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
void	collapse() Collapses the drawer.
void	expand() Expands the drawer.
boolean	isCollapsed()
boolean	isExpandOnHover()
void	setExpandOnHover(boolean expandOnHover) Sets a mode when drawer is expanded on hover.
void	toggle() Toggles the drawer.

Methods inherited from interface io.jmix.ui.component.OrderedContainer

add, getComponent, getComponentNN, indexOf

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

add, add, remove, remove, removeAll

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.HasComponents

focusFirstComponent, getComponent, getComponentNN, getComponents, getOwnComponent, getOwnComponents, getOwnComponentsStream

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

collapse

void collapse()

Collapses the drawer.

expand

void expand()

Expands the drawer.

toggle

void toggle()

Toggles the drawer.

setExpandOnHover

@StudioProperty(defaultValue="false")
void setExpandOnHover(boolean expandOnHover)

Sets a mode when drawer is expanded on hover. Note that collapse state is not changed. false by default.

Parameters:

expandOnHover - a boolean value specifying if drawer should be expanded on hover.

isExpandOnHover

boolean isExpandOnHover()

Returns:

whether the drawer should be expanded on hover.

isCollapsed

boolean isCollapsed()

Returns:

whether the drawer is collapsed.