Package io.jmix.ui.action.filter

Class FilterEditAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.filter.FilterAction

io.jmix.ui.action.filter.FilterEditAction

All Implemented Interfaces:

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

@StudioAction(target="io.jmix.ui.component.Filter",
              description="Edits current run-time filter configuration")
@ActionType("filter_edit")
public class FilterEditAction
extends FilterAction

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 FilterComponents	filterComponents
protected FilterSupport	filterSupport
protected Fragments	fragments
static final String	ID
protected Messages	messages
protected ScreenBuilders	screenBuilders

Fields inherited from class io.jmix.ui.action.filter.FilterAction

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

Method Summary

Modifier and Type	Method	Description
protected void	applyScreenConfigurer(Screen editScreen)
protected Screen	createEditScreen(Class modelClass, LogicalFilterCondition model)
void	execute()	Executes the Action
protected boolean	isApplicable()	Callback method which is invoked by the action to determine its enabled state.
protected void	onEditScreenAfterCommit(ScreenFragment configurationFormFragment, LogicalFilterCondition filterCondition, FilterConverter converter, boolean isNewConfiguration, Filter.Configuration currentConfiguration, Map<String,Object> valuesMap)
void	setFilterComponents(FilterComponents filterComponents)
void	setFilterSupport(FilterSupport filterSupport)
void	setFragments(Fragments fragments)
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)
void	setScreenBuilders(ScreenBuilders screenBuilders)

Methods inherited from class io.jmix.ui.action.filter.FilterAction

actionPerform, getFilter, setFilter

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

filterComponents

protected FilterComponents filterComponents

filterSupport

protected FilterSupport filterSupport

screenBuilders

protected ScreenBuilders screenBuilders

fragments

protected Fragments fragments

messages

protected Messages messages

Constructor Details

FilterEditAction

public FilterEditAction()

FilterEditAction

public FilterEditAction(String id)

Method Details

setMessages

@Autowired
protected void setMessages(Messages messages)

setIcons

@Autowired
protected void setIcons(Icons icons)

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setFilterComponents

@Autowired
public void setFilterComponents(FilterComponents filterComponents)

setFilterSupport

@Autowired
public void setFilterSupport(FilterSupport filterSupport)

setFragments

@Autowired
public void setFragments(Fragments fragments)

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 FilterAction

Returns:

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

execute

public void execute()

Description copied from interface: Action.ExecutableAction

Executes the Action

createEditScreen

protected Screen createEditScreen(Class modelClass,
 LogicalFilterCondition model)

applyScreenConfigurer

protected void applyScreenConfigurer(Screen editScreen)

onEditScreenAfterCommit

protected void onEditScreenAfterCommit(ScreenFragment configurationFormFragment,
 LogicalFilterCondition filterCondition,
 FilterConverter converter,
 boolean isNewConfiguration,
 Filter.Configuration currentConfiguration,
 Map<String,Object> valuesMap)