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

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

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

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

All Implemented Interfaces:

ExecutableAction, TargetAction<GenericFilter>, Action, HasShortcutCombination

Direct Known Subclasses:

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

public abstract class GenericFilterAction<A extends GenericFilterAction<A>>
extends SecuredBaseAction<A>
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

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

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)	Executes action logic.
protected void	bindFilterComponentsChangeListener(GenericFilter target)
protected void	bindListeners(GenericFilter target)
protected void	checkTarget()
protected View<?>	getParentView()
@Nullable GenericFilter	getTarget()
protected void	initAction()
protected boolean	isApplicable()
protected boolean	isPermitted()
protected boolean	isVisibleBySpecificUiPermission()
protected void	onConfigurationChanged(GenericFilter.ConfigurationChangeEvent event)
protected void	onFilterComponentsChanged(LogicalFilterComponent.FilterComponentsChangeEvent<?> event)
void	setTarget(@Nullable GenericFilter target)
protected void	setTargetInternal(@Nullable GenericFilter target)
protected void	setVisibleInternal(boolean visible)
protected void	unbindFilterComponentsChange()
protected void	unbindListeners()
A	withTarget(@Nullable GenericFilter target)

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

addEnabledRule, isEnabledByRule, refreshState, removeEnabledRule

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

getUiObservationSupport

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

addActionPerformedListener, self, setEnabled, setEnabledInternal, setVisible, 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 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

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

Description copied from interface: Action

Executes action logic.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class ObservableBaseAction<A extends GenericFilterAction<A>>

Parameters:

component - Component that triggered this action

isApplicable

protected boolean isApplicable()

Overrides:

isApplicable in class BaseAction<A extends GenericFilterAction<A>>

isPermitted

protected boolean isPermitted()

Overrides:

isPermitted in class SecuredBaseAction<A extends GenericFilterAction<A>>

isVisibleBySpecificUiPermission

protected boolean isVisibleBySpecificUiPermission()

setVisibleInternal

protected void setVisibleInternal(boolean visible)

Overrides:

setVisibleInternal in class BaseAction<A extends GenericFilterAction<A>>

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)

checkTarget

protected void checkTarget()

getParentView

protected View<?> getParentView()