Package io.jmix.ui.component.impl

Class DrawerImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractOrderedLayout<com.vaadin.ui.CssLayout>

io.jmix.ui.component.impl.CssLayoutImpl

io.jmix.ui.component.impl.DrawerImpl

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, CssLayout, HasComponents, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasRequiredIndicator, LayoutClickNotifier, Drawer, OrderedContainer, ShortcutNotifier, org.springframework.beans.factory.InitializingBean

public class DrawerImpl
extends CssLayoutImpl
implements Drawer, org.springframework.beans.factory.InitializingBean

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

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

HasContextHelp.ContextHelpIconClickEvent

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

LayoutClickNotifier.LayoutClickEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	collapsed
protected static final String	COLLAPSED_SYLENAME
protected static final String	DRAWER_STYLENAME
protected static final String	EXPAND_ON_HOVER_SYLENAME
protected boolean	expandOnHover

Fields inherited from class io.jmix.ui.component.impl.AbstractOrderedLayout

layoutClickRegistration, ownComponents, shortcuts

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

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

NAME

Fields inherited from interface io.jmix.ui.component.mainwindow.Drawer

NAME

Constructor Summary

Constructors

Constructor	Description
DrawerImpl()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	collapse()	Collapses the drawer.
void	expand()	Expands the drawer.
protected void	initComponent(com.vaadin.ui.CssLayout component)
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 class io.jmix.ui.component.impl.CssLayoutImpl

createComponent, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Methods inherited from class io.jmix.ui.component.impl.AbstractOrderedLayout

add, add, addLayoutClickListener, addShortcutAction, attached, detached, findChildComponent, getComponent, getComponent, getComponents, getDescription, getOwnComponent, getOwnComponents, getOwnComponentsStream, indexOf, internalRemoveLayoutClickListener, remove, removeAll, removeShortcutAction, setDescription, setFrame

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescriptionAsHtml, setEnabled, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getFrame, setFrame

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

getCaption, setCaption

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

getDescription, setDescription

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

getIcon, setIcon, setIconFromSet

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

add, add, remove, remove, removeAll

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

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

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

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

isCaptionAsHtml, setCaptionAsHtml

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

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

addLayoutClickListener

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

add, getComponent, getComponentNN, indexOf

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

addShortcutAction, removeShortcutAction

Field Details

DRAWER_STYLENAME

protected static final String DRAWER_STYLENAME

See Also:

• Constant Field Values

COLLAPSED_SYLENAME

protected static final String COLLAPSED_SYLENAME

See Also:

• Constant Field Values

EXPAND_ON_HOVER_SYLENAME

protected static final String EXPAND_ON_HOVER_SYLENAME

See Also:

• Constant Field Values

collapsed

protected boolean collapsed

expandOnHover

protected boolean expandOnHover

Constructor Details

DrawerImpl

public DrawerImpl()

Method Details

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

initComponent

protected void initComponent(com.vaadin.ui.CssLayout component)

collapse

public void collapse()

Description copied from interface: Drawer

Collapses the drawer.

Specified by:

collapse in interface Drawer

expand

public void expand()

Description copied from interface: Drawer

Expands the drawer.

Specified by:

expand in interface Drawer

isExpandOnHover

public boolean isExpandOnHover()

Specified by:

isExpandOnHover in interface Drawer

Returns:

whether the drawer should be expanded on hover.

setExpandOnHover

public void setExpandOnHover(boolean expandOnHover)

Description copied from interface: Drawer

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

Specified by:

setExpandOnHover in interface Drawer

Parameters:

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

toggle

public void toggle()

Description copied from interface: Drawer

Toggles the drawer.

Specified by:

toggle in interface Drawer

isCollapsed

public boolean isCollapsed()

Specified by:

isCollapsed in interface Drawer

Returns:

whether the drawer is collapsed.