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

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.list.ListDataComponentAction<A,E>

All Implemented Interfaces:

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

Direct Known Subclasses:

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

public abstract class ListDataComponentAction<A extends ListDataComponentAction<A,E>,E>
extends SecuredBaseAction
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

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

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)
protected void	attachSelectionListener()
protected void	checkTarget()
protected void	checkTargetItems(Class<?> itemsType)
ListDataComponent<E>	getTarget()
protected void	initAction()
protected void	onSelectionChange(com.vaadin.flow.data.selection.SelectionEvent<?,E> event)
void	setTarget(ListDataComponent<E> target)
A	withEnabled(boolean enabled)
A	withEnabledByUiPermissions(boolean enabledByUiPermissions)
A	withHandler(Consumer<ActionPerformedEvent> handler)
A	withIcon(com.vaadin.flow.component.icon.Icon icon)
A	withIcon(com.vaadin.flow.component.icon.VaadinIcon icon)
A	withShortcutCombination(KeyCombination shortcutCombination)
A	withTarget(ListDataComponent<E> target)
A	withText(String text)
A	withTitle(String title)
A	withVariant(ActionVariant actionVariant)
A	withVisible(boolean visible)
A	withVisibleByUiPermissions(boolean visibleByUiPermissions)

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

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

@Nullable
public 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)

withText

public A withText(@Nullable
 String text)

Overrides:

withText in class SecuredBaseAction

withEnabled

public A withEnabled(boolean enabled)

Overrides:

withEnabled in class SecuredBaseAction

withVisible

public A withVisible(boolean visible)

Overrides:

withVisible in class SecuredBaseAction

withIcon

public A withIcon(@Nullable
 com.vaadin.flow.component.icon.Icon icon)

Overrides:

withIcon in class SecuredBaseAction

withIcon

public A withIcon(@Nullable
 com.vaadin.flow.component.icon.VaadinIcon icon)

Overrides:

withIcon in class SecuredBaseAction

withTitle

public A withTitle(@Nullable
 String title)

Overrides:

withTitle in class SecuredBaseAction

withVariant

public A withVariant(ActionVariant actionVariant)

Overrides:

withVariant in class SecuredBaseAction

withShortcutCombination

public A withShortcutCombination(@Nullable
 KeyCombination shortcutCombination)

Overrides:

withShortcutCombination in class SecuredBaseAction

withHandler

public A withHandler(@Nullable
 Consumer<ActionPerformedEvent> handler)

Overrides:

withHandler in class SecuredBaseAction

withEnabledByUiPermissions

public A withEnabledByUiPermissions(boolean enabledByUiPermissions)

Overrides:

withEnabledByUiPermissions in class SecuredBaseAction

withVisibleByUiPermissions

public A withVisibleByUiPermissions(boolean visibleByUiPermissions)

Overrides:

withVisibleByUiPermissions in class SecuredBaseAction

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)

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

checkTarget

protected void checkTarget()

checkTargetItems

protected void checkTargetItems(Class<?> itemsType)