Package io.jmix.ui.action

Class ListAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

All Implemented Interfaces:

Action, Action.HasPrimaryState, Action.HasTarget, Action.SecuredAction

Direct Known Subclasses:

AddAction, CreateAction, EditFetchPlanAction, ExecutionHistoryAction, ExportAction, RefreshAction, ResetRememberMeTokenAction, RunReportAction, SecuredListAction, ShowPivotAction

public class ListAction
extends BaseAction
implements Action.HasTarget

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 ListComponent	target

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
ListAction(String id)
ListAction(String id, String shortcut)

Method Summary

Modifier and Type	Method	Description
ListComponent	getTarget()
void	setTarget(ListComponent target)
ListAction	withCaption(String caption)	Set caption using fluent API method.
ListAction	withDescription(String description)	Set description using fluent API method.
ListAction	withHandler(Consumer<Action.ActionPerformedEvent> handler)	Set action performed event handler using fluent API method.
ListAction	withIcon(String icon)	Set icon using fluent API method.
ListAction	withPrimary(boolean primary)	Set whether this action is primary using fluent API method.
ListAction	withShortcut(String shortcut)	Set shortcut using fluent API method.

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

actionPerform, addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

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

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

Field Details

target

protected ListComponent target

Constructor Details

ListAction

public ListAction(String id)

ListAction

public ListAction(String id,
 @Nullable
 String shortcut)

Method Details

getTarget

@Nullable
public ListComponent getTarget()

Specified by:

getTarget in interface Action.HasTarget

setTarget

public void setTarget(@Nullable
 ListComponent target)

Specified by:

setTarget in interface Action.HasTarget

withCaption

public ListAction withCaption(@Nullable
 String caption)

Set caption using fluent API method.

Overrides:

withCaption in class BaseAction

Parameters:

caption - caption

Returns:

current instance of action

withDescription

public ListAction withDescription(@Nullable
 String description)

Set description using fluent API method.

Overrides:

withDescription in class BaseAction

Parameters:

description - description

Returns:

current instance of action

withIcon

public ListAction withIcon(@Nullable
 String icon)

Set icon using fluent API method.

Overrides:

withIcon in class BaseAction

Parameters:

icon - icon

Returns:

current instance of action

withShortcut

public ListAction withShortcut(@Nullable
 String shortcut)

Set shortcut using fluent API method.

Overrides:

withShortcut in class BaseAction

Parameters:

shortcut - shortcut

Returns:

current instance of action

withHandler

public ListAction withHandler(Consumer<Action.ActionPerformedEvent> handler)

Set action performed event handler using fluent API method. Can be used instead of subclassing BaseAction class.

Overrides:

withHandler in class BaseAction

Parameters:

handler - action performed handler

Returns:

current instance of action

withPrimary

public ListAction withPrimary(boolean primary)

Set whether this action is primary using fluent API method. Can be used instead of subclassing BaseAction class.

Overrides:

withPrimary in class BaseAction

Parameters:

primary - primary

Returns:

current instance of action