Package io.jmix.flowui.action.usermenu

Class UserMenuThemeSwitchAction

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.usermenu.UserMenuAction<UserMenuThemeSwitchAction,UserMenu>

io.jmix.flowui.action.usermenu.UserMenuThemeSwitchAction

All Implemented Interfaces:

ExecutableAction, SecuredAction, TargetAction<UserMenu>, Action, HasShortcutCombination

@ActionType("userMenu_themeSwitch")
public class UserMenuThemeSwitchAction
extends UserMenuAction<UserMenuThemeSwitchAction,UserMenu>

An action for switching visual themes in a user menu. It requires the @JsModule("./src/theme/color-scheme-switching-support.js") import to be added to the main application class.

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DARK_THEME
static final String	ID
protected static final String	LIGHT_THEME
protected final Map<String,UserMenuItem>	menuItems
protected static final String	MESSAGE_KEY
protected Messages	messages
protected UserMenuItem.HasSubMenu.SubMenu	subMenu
protected static final String	SYSTEM_THEME

Fields inherited from class io.jmix.flowui.action.usermenu.UserMenuAction

menuItem, target

Fields inherited from class io.jmix.flowui.action.SecuredBaseAction

enabledByUiPermissions, enabledRules, visibleByUiPermissions

Fields inherited from class io.jmix.flowui.kit.action.BaseAction

enabledExplicitly, visibleExplicitly

Fields inherited from class io.jmix.flowui.kit.action.AbstractAction

description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible

Fields inherited from interface io.jmix.flowui.kit.action.Action

PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
UserMenuThemeSwitchAction()
UserMenuThemeSwitchAction(String id)

Method Summary

Modifier and Type	Method	Description
protected void	checkJsImport()
protected com.vaadin.flow.component.icon.Icon	createIcon(String theme)
protected UserMenuItem	createItem(UserMenuItem.HasSubMenu.SubMenu subMenu, String theme, Consumer<UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem>> listener)
void	execute()	Executes the Action
protected void	initAction()
protected void	initItems(UserMenuItem.HasSubMenu.SubMenu subMenu)
protected void	selectDarkTheme(UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem> event)
protected void	selectLightTheme(UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem> event)
protected void	selectSystemTheme(UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem> event)
protected void	setMenuItemInternal(UserMenuItem menuItem)
void	setMessages(Messages messages)
protected void	updateState(String theme)

Methods inherited from class io.jmix.flowui.action.usermenu.UserMenuAction

actionPerform, checkTarget, getMenuItem, getTarget, setMenuItem, setTarget, setTargetInternal, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.action.SecuredBaseAction

addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabledByUiPermissions, setVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.kit.action.BaseAction

addActionPerformedListener, isApplicable, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withDescription

Methods inherited from class io.jmix.flowui.kit.action.AbstractAction

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setShortcutCombination, setText, setVariant

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.kit.action.Action

addPropertyChangeListener, getDescription, getIcon, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

SYSTEM_THEME

protected static final String SYSTEM_THEME

See Also:

• Constant Field Values

LIGHT_THEME

protected static final String LIGHT_THEME

See Also:

• Constant Field Values

DARK_THEME

protected static final String DARK_THEME

See Also:

• Constant Field Values

MESSAGE_KEY

protected static final String MESSAGE_KEY

See Also:

• Constant Field Values

messages

protected Messages messages

menuItems

protected final Map<String,UserMenuItem> menuItems

subMenu

protected UserMenuItem.HasSubMenu.SubMenu subMenu

Constructor Details

UserMenuThemeSwitchAction

public UserMenuThemeSwitchAction()

UserMenuThemeSwitchAction

public UserMenuThemeSwitchAction(String id)

Method Details

initAction

protected void initAction()

Overrides:

initAction in class UserMenuAction<UserMenuThemeSwitchAction,UserMenu>

checkJsImport

protected void checkJsImport()

setMessages

@Autowired
public void setMessages(Messages messages)

setMenuItemInternal

protected void setMenuItemInternal(@Nullable
 UserMenuItem menuItem)

Overrides:

setMenuItemInternal in class UserMenuAction<UserMenuThemeSwitchAction,UserMenu>

initItems

protected void initItems(UserMenuItem.HasSubMenu.SubMenu subMenu)

createItem

protected UserMenuItem createItem(UserMenuItem.HasSubMenu.SubMenu subMenu,
 String theme,
 Consumer<UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem>> listener)

createIcon

protected com.vaadin.flow.component.icon.Icon createIcon(String theme)

selectSystemTheme

protected void selectSystemTheme(UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem> event)

selectLightTheme

protected void selectLightTheme(UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem> event)

selectDarkTheme

protected void selectDarkTheme(UserMenuItem.HasClickListener.ClickEvent<TextUserMenuItem> event)

updateState

protected void updateState(@Nullable
 String theme)

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action