Package io.jmix.ui.action.filter

Class FilterAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.filter.FilterAction

All Implemented Interfaces:

Action, Action.ExecutableAction, Action.HasPrimaryState, Action.SecuredAction

Direct Known Subclasses:

FilterAddConditionAction, FilterClearValuesAction, FilterCopyAction, FilterEditAction, FilterMakeDefaultAction, FilterRemoveAction, FilterSaveAsAction

public abstract class FilterAction
extends BaseAction
implements Action.ExecutableAction

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.action.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.OperationResultAction, Action.ScreenAction<S extends Screen>, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected Filter	filter

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
FilterAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
Filter	getFilter()
protected boolean	isApplicable()	Callback method which is invoked by the action to determine its enabled state.
void	setFilter(Filter filter)

Methods inherited from class io.jmix.ui.action.BaseAction

addActionPerformedListener, addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setPrimary, setShortcut, setShortcutCombination

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.action.Action

addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setShortcut, setShortcutCombination, setVisible

Methods inherited from interface io.jmix.ui.action.Action.ExecutableAction

execute

Field Details

filter

protected Filter filter

Constructor Details

FilterAction

public FilterAction(String id)

Method Details

getFilter

@Nullable
public Filter getFilter()

setFilter

public void setFilter(@Nullable
 Filter filter)

isApplicable

protected boolean isApplicable()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isApplicable in class BaseAction

Returns:

true if the action is enabled for the current context, e.g. there is a selected row in a table

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component