io.jmix.ui.component.mainwindow

Interface UserActionsButton

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon

All Known Implementing Classes:

UserActionsButtonImpl

@StudioComponent(caption="UserActionsButton",
                 category="Main window",
                 xmlElement="userActionsButton",
                 icon="io/jmix/ui/icon/mainwindow/userActionsButton.svg",
                 canvasBehaviour=BUTTON,
                 unsupportedProperties={"box.expandRatio","css","responsive"})
public interface UserActionsButton
extends Component.BelongToFrame, Component.HasIcon, Component.HasCaption

A component that combines link to Login screen and authenticated user menu.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserActionsButton.LoginHandlerContext
static class	UserActionsButton.LogoutHandlerContext

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	setLoginHandler(java.util.function.Consumer<UserActionsButton.LoginHandlerContext> loginHandler) Sets the given Consumer as custom login action handler.
void	setLogoutHandler(java.util.function.Consumer<UserActionsButton.LogoutHandlerContext> logoutHandler) Sets the given Consumer as custom logout action handler.

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

getFrame, setFrame

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

getIcon, setIcon, setIconFromSet

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

getCaption, setCaption

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

getDescription, setDescription

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setLoginHandler

void setLoginHandler(@Nullable
                     java.util.function.Consumer<UserActionsButton.LoginHandlerContext> loginHandler)

Sets the given Consumer as custom login action handler.

setLogoutHandler

void setLogoutHandler(@Nullable
                      java.util.function.Consumer<UserActionsButton.LogoutHandlerContext> logoutHandler)

Sets the given Consumer as custom logout action handler.