Package io.jmix.ui.action.list

Class RefreshAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.ui.action.list.RefreshAction

All Implemented Interfaces:

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

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Reloads a list of entities from the database",
              availableInScreenWizard=true)
@ActionType("refresh")
public class RefreshAction
extends ListAction
implements Action.ExecutableAction

Standard action for reloading a list of entities from the database.

Should be defined for a list component (Table, DataGrid, etc.) in a screen XML descriptor.

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
static final String	ID

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

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

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
void	execute()	Executes the action.
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)

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

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

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

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

Constructor Details

RefreshAction

public RefreshAction()

RefreshAction

public RefreshAction(String id)

Method Details

setIcons

@Autowired
protected void setIcons(Icons icons)

setMessages

@Autowired
protected void setMessages(Messages messages)

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

execute

public void execute()

Executes the action.

Specified by:

execute in interface Action.ExecutableAction