Package io.jmix.flowui.action.usermenu

Class UserMenuAction<A extends UserMenuAction<A,C>,C extends JmixUserMenu<?>>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction<A>

io.jmix.flowui.action.ObservableBaseAction<A>

io.jmix.flowui.action.SecuredBaseAction<A>

io.jmix.flowui.action.usermenu.UserMenuAction<A,C>

Type Parameters:

A - the type of the concrete action class extending UserMenuAction

C - the type of the JmixUserMenu that the action can be associated with

All Implemented Interfaces:

ExecutableAction, TargetAction<C>, Action, HasShortcutCombination

Direct Known Subclasses:

UserMenuSubstituteUserAction, UserMenuThemeSwitchAction

public abstract class UserMenuAction<A extends UserMenuAction<A,C>,C extends JmixUserMenu<?>>
extends SecuredBaseAction<A>
implements TargetAction<C>, ExecutableAction

An abstract base class for actions that can be associated with a specific JmixUserMenu.

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 UserMenuItem	menuItem
protected C	target

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

enabledRules

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

uiObservationSupport

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
UserMenuAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)	Executes action logic.
protected void	checkTarget()
@Nullable UserMenuItem	getMenuItem()	Returns the UserMenuItem associated with this action.
@Nullable C	getTarget()
protected void	initAction()
void	setMenuItem(@Nullable UserMenuItem menuItem)	Sets the UserMenuItem associated with this action.
protected void	setMenuItemInternal(@Nullable UserMenuItem menuItem)
void	setTarget(@Nullable C target)
protected void	setTargetInternal(@Nullable C target)
A	withTarget(@Nullable C target)

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

addEnabledRule, isEnabledByRule, isPermitted, refreshState, removeEnabledRule

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

getUiObservationSupport

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

addActionPerformedListener, isApplicable, self, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withDescription, withEnabled, withHandler, withIcon, withShortcutCombination, withText, withVariant, withVisible

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

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getIconComponent, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setIconComponent, 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, getIconComponent, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setIconComponent, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.action.ExecutableAction

execute

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

getShortcutCombination, setShortcutCombination

Field Details

target

protected C extends JmixUserMenu<?> target

menuItem

protected UserMenuItem menuItem

Constructor Details

UserMenuAction

public UserMenuAction(String id)

Method Details

initAction

protected void initAction()

getTarget

public @Nullable C getTarget()

Specified by:

getTarget in interface TargetAction<A extends UserMenuAction<A,C>>

setTarget

public void setTarget(@Nullable C target)

Specified by:

setTarget in interface TargetAction<A extends UserMenuAction<A,C>>

getMenuItem

public @Nullable UserMenuItem getMenuItem()

Returns the UserMenuItem associated with this action.

Returns:

the associated UserMenuItem, or null if no menu item is associated

setMenuItem

public void setMenuItem(@Nullable UserMenuItem menuItem)

Sets the UserMenuItem associated with this action.

Parameters:

menuItem - the new UserMenuItem to associate with this action, or null to disassociate the current menu item

setMenuItemInternal

protected void setMenuItemInternal(@Nullable UserMenuItem menuItem)

setTargetInternal

protected void setTargetInternal(@Nullable C target)

actionPerform

public void actionPerform(com.vaadin.flow.component.Component component)

Description copied from interface: Action

Executes action logic.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class ObservableBaseAction<A extends UserMenuAction<A,C>>

Parameters:

component - Component that triggered this action

withTarget

public A withTarget(@Nullable C target)

checkTarget

protected void checkTarget()