Package io.jmix.uiexport.action

Class ExcelExportAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.uiexport.action.ExportAction

io.jmix.uiexport.action.ExcelExportAction

All Implemented Interfaces:

Action, Action.HasPrimaryState, Action.HasTarget, Action.SecuredAction, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Export selected entities to Excel")
@ActionType("excelExport")
public class ExcelExportAction
extends ExportAction

Action for export table content in XLSX or XLS formats

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

Fields inherited from class io.jmix.uiexport.action.ExportAction

applicationContext, downloader, messages, tableExporter

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

Method Summary

Modifier and Type	Method	Description
String	getIcon()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class io.jmix.uiexport.action.ExportAction

actionPerform, addColumnValueProvider, doExport, execute, getColumnValueProvider, getMessage, needExportAll, removeColumnValueProvider, setTableExporter, withExporter

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, 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, 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

icons

@Autowired
protected Icons icons

Constructor Details

ExcelExportAction

public ExcelExportAction(String id)

ExcelExportAction

public ExcelExportAction()

ExcelExportAction

public ExcelExportAction(String id,
 String shortcut)

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Overrides:

setApplicationContext in class ExportAction

getIcon

public String getIcon()

Specified by:

getIcon in interface Action

Overrides:

getIcon in class AbstractAction

Returns:

action's icon