Package io.jmix.ui.action.filter

Class FilterAddConditionAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.filter.FilterAction

io.jmix.ui.action.filter.FilterAddConditionAction

All Implemented Interfaces:

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

@StudioAction(target="io.jmix.ui.component.Filter",
              description="Adds condition to current filter configuration")
@ActionType("filter_addCondition")
public class FilterAddConditionAction
extends FilterAction
implements Action.AdjustWhenScreenReadOnly

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.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field	Description
protected FilterConditionsBuilder	builder
protected FilterComponents	filterComponents
static final String	ID
protected Messages	messages
protected Notifications	notifications
protected ScreenBuilders	screenBuilders
protected Consumer<Collection<FilterCondition>>	selectHandler
protected Predicate<LookupScreen.ValidationContext<FilterCondition>>	selectValidator

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Action
protected void	initDefaultSelectHandler()
protected void	initDefaultSelectValidator()
protected boolean	isApplicable()	Callback method which is invoked by the action to determine its enabled state.
protected void	openAddConditionScreen(List<FilterCondition> filterConditions)
protected boolean	setFilterComponentDefaultValue(FilterComponent filterComponent, Filter.Configuration currentConfiguration)
void	setFilterComponents(FilterComponents filterComponents)
void	setFilterConditionsBuilder(FilterConditionsBuilder builder)
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)
void	setNotifications(Notifications notifications)
void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setSelectHandler(Consumer<Collection<FilterCondition>> selectHandler)
void	setSelectValidator(Predicate<LookupScreen.ValidationContext<FilterCondition>> selectValidator)

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

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

isDisabledWhenScreenReadOnly

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

filterComponents

protected FilterComponents filterComponents

builder

protected FilterConditionsBuilder builder

messages

protected Messages messages

notifications

protected Notifications notifications

screenBuilders

protected ScreenBuilders screenBuilders

selectValidator

protected Predicate<LookupScreen.ValidationContext<FilterCondition>> selectValidator

selectHandler

protected Consumer<Collection<FilterCondition>> selectHandler

Constructor Details

FilterAddConditionAction

public FilterAddConditionAction()

FilterAddConditionAction

public FilterAddConditionAction(String id)

Method Details

setMessages

@Autowired
protected void setMessages(Messages messages)

setIcons

@Autowired
protected void setIcons(Icons icons)

setFilterComponents

@Autowired
public void setFilterComponents(FilterComponents filterComponents)

setFilterConditionsBuilder

@Autowired
public void setFilterConditionsBuilder(FilterConditionsBuilder builder)

setNotifications

@Autowired
public void setNotifications(Notifications notifications)

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setSelectValidator

public void setSelectValidator(Predicate<LookupScreen.ValidationContext<FilterCondition>> selectValidator)

setSelectHandler

public void setSelectHandler(@Nullable
 Consumer<Collection<FilterCondition>> selectHandler)

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

Specified by:

execute in interface Action.ExecutableAction

initDefaultSelectValidator

protected void initDefaultSelectValidator()

initDefaultSelectHandler

protected void initDefaultSelectHandler()

setFilterComponentDefaultValue

protected boolean setFilterComponentDefaultValue(FilterComponent filterComponent,
 Filter.Configuration currentConfiguration)

openAddConditionScreen

protected void openAddConditionScreen(List<FilterCondition> filterConditions)