Package io.jmix.flowui.action.list

Class ListDataComponentAction<A extends ListDataComponentAction<A,E>,E>

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.list.ListDataComponentAction<A,E>

All Implemented Interfaces:

ExecutableAction, TargetAction<ListDataComponent<E>>, Action, HasShortcutCombination

Direct Known Subclasses:

AddAction, CreateAction, ExportAction, ListDynamicLocalizedMessageEditAction, RefreshAction, RunListEntityReportAction, RunReportAction, SecuredListDataComponentAction, ShowExecutionReportHistoryAction, ShowPivotTableAction

public abstract class ListDataComponentAction<A extends ListDataComponentAction<A,E>,E>
extends SecuredBaseAction<A>
implements TargetAction<ListDataComponent<E>>, ExecutableAction

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 com.vaadin.flow.shared.Registration	selectionListenerRegistration
protected ListDataComponent<E>	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
ListDataComponentAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)	Executes action logic.
protected void	attachSelectionListener()
protected void	checkTarget()
protected void	checkTargetItems(Class<?> itemsType)
@Nullable ListDataComponent<E>	getTarget()
protected void	initAction()
protected void	onSelectionChange(com.vaadin.flow.data.selection.SelectionEvent<?,E> event)
void	setTarget(@Nullable ListDataComponent<E> target)
A	withTarget(@Nullable ListDataComponent<E> 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 ListDataComponent<E> target

selectionListenerRegistration

protected com.vaadin.flow.shared.Registration selectionListenerRegistration

Constructor Details

ListDataComponentAction

public ListDataComponentAction(String id)

Method Details

initAction

protected void initAction()

getTarget

public @Nullable ListDataComponent<E> getTarget()

Specified by:

getTarget in interface TargetAction<A extends ListDataComponentAction<A,E>>

setTarget

public void setTarget(@Nullable ListDataComponent<E> target)

Specified by:

setTarget in interface TargetAction<A extends ListDataComponentAction<A,E>>

withTarget

public A withTarget(@Nullable ListDataComponent<E> target)

attachSelectionListener

protected void attachSelectionListener()

onSelectionChange

protected void onSelectionChange(com.vaadin.flow.data.selection.SelectionEvent<?,E> event)

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 ListDataComponentAction<A,E>>

Parameters:

component - Component that triggered this action

checkTarget

protected void checkTarget()

checkTargetItems

protected void checkTargetItems(Class<?> itemsType)