Package io.jmix.flowui.action.genericfilter

Class GenericFilterAction<A extends GenericFilterAction<A>>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.genericfilter.GenericFilterAction<A>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractGenericFilterSaveAction, GenericFilterAddConditionAction, GenericFilterClearValuesAction, GenericFilterCopyAction, GenericFilterEditAction, GenericFilterRemoveAction, GenericFilterResetAction

public abstract class GenericFilterAction<A extends GenericFilterAction<A>>
extends SecuredBaseAction
implements TargetAction<GenericFilter>, 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	configurationChangeRegistration
protected com.vaadin.flow.shared.Registration	filterComponentsChangeRegistration
protected GenericFilter	target
protected boolean	visibleBySpecificUiPermission

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

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)
protected void	bindFilterComponentsChangeListener(GenericFilter target)
protected void	bindListeners(GenericFilter target)
protected void	checkTarget()
protected View<?>	getParentView()
GenericFilter	getTarget()
protected void	initAction()
protected boolean	isApplicable()
protected boolean	isPermitted()
boolean	isVisibleByUiPermissions()
protected void	onConfigurationChanged(GenericFilter.ConfigurationChangeEvent event)
protected void	onFilterComponentsChanged(LogicalFilterComponent.FilterComponentsChangeEvent<?> event)
void	setTarget(GenericFilter target)
protected void	setTargetInternal(GenericFilter target)
protected void	unbindFilterComponentsChange()
protected void	unbindListeners()
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(GenericFilter 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, refreshState, removeEnabledRule, setEnabledByUiPermissions, setVisibleByUiPermissions

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

addActionPerformedListener, 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 GenericFilter target

visibleBySpecificUiPermission

protected boolean visibleBySpecificUiPermission

configurationChangeRegistration

protected com.vaadin.flow.shared.Registration configurationChangeRegistration

filterComponentsChangeRegistration

protected com.vaadin.flow.shared.Registration filterComponentsChangeRegistration

Constructor Details

GenericFilterAction

public GenericFilterAction(String id)

Method Details

initAction

protected void initAction()

getTarget

@Nullable
public GenericFilter getTarget()

Specified by:

getTarget in interface TargetAction<A extends GenericFilterAction<A>>

setTarget

public void setTarget(@Nullable
 GenericFilter target)

Specified by:

setTarget in interface TargetAction<A extends GenericFilterAction<A>>

setTargetInternal

protected void setTargetInternal(@Nullable
 GenericFilter target)

actionPerform

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

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

isApplicable

protected boolean isApplicable()

Overrides:

isApplicable in class BaseAction

isPermitted

protected boolean isPermitted()

Overrides:

isPermitted in class SecuredBaseAction

isVisibleByUiPermissions

public boolean isVisibleByUiPermissions()

Specified by:

isVisibleByUiPermissions in interface SecuredAction

Overrides:

isVisibleByUiPermissions in class SecuredBaseAction

bindListeners

protected void bindListeners(GenericFilter target)

bindFilterComponentsChangeListener

protected void bindFilterComponentsChangeListener(GenericFilter target)

unbindListeners

protected void unbindListeners()

unbindFilterComponentsChange

protected void unbindFilterComponentsChange()

onConfigurationChanged

protected void onConfigurationChanged(GenericFilter.ConfigurationChangeEvent event)

onFilterComponentsChanged

protected void onFilterComponentsChanged(LogicalFilterComponent.FilterComponentsChangeEvent<?> event)

withTarget

public A withTarget(@Nullable
 GenericFilter 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

checkTarget

protected void checkTarget()

getParentView

protected View<?> getParentView()