Package io.jmix.gridexportflowui.action

Class ExportAction

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.list.ListDataComponentAction<ExportAction,Object>

io.jmix.gridexportflowui.action.ExportAction

All Implemented Interfaces:

ExecutableAction, SecuredAction, TargetAction<ListDataComponent<Object>>, Action, HasShortcutCombination, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ExcelExportAction, JsonExportAction

@ActionType("grdexp_export")
public class ExportAction
extends ListDataComponentAction<ExportAction,Object>
implements org.springframework.context.ApplicationContextAware

Base action for export table content with defined exporter. dataGridExporter is required for this action

Should be defined for a list component (Table, DataGrid, etc.).

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected DataGridExporter	dataGridExporter
protected Dialogs	dialogs
protected Downloader	downloader
static final String	ID
protected Messages	messages

Fields inherited from class io.jmix.flowui.action.list.ListDataComponentAction

selectionListenerRegistration, target

Fields inherited from class io.jmix.flowui.action.SecuredBaseAction

enabledByUiPermissions, enabledRules, visibleByUiPermissions

Fields inherited from class io.jmix.flowui.kit.action.BaseAction

enabledExplicitly, visibleExplicitly

Fields inherited from class io.jmix.flowui.kit.action.AbstractAction

description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible

Fields inherited from interface io.jmix.flowui.kit.action.Action

PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
ExportAction()
ExportAction(String id)

Method Summary

Modifier and Type	Method	Description
void	addColumnValueProvider(String columnId, Function<DataGridExporter.ColumnValueContext,Object> columnValueProvider)	Adds a function to get value from the column.
protected Action	createCurrentPageAction()
protected Action	createExportAllAction()
protected Action	createExportSelectedAction()
protected void	doExport(ExportMode exportMode)
void	execute()	Executes the Action
Function<DataGridExporter.ColumnValueContext,Object>	getColumnValueProvider(String columnId)
protected String	getMessage(String id)
protected boolean	isDataLoaderExist(ListDataComponent<?> target)
void	removeColumnValueProvider(String columnId)	Removes an column value provider function by column id.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDataGridExporter(DataGridExporter dataGridExporter)	Sets the dataGrid exporter instance
void	setDialogs(Dialogs dialogs)
void	setDownloader(Downloader downloader)
void	setFileName(String fileName)	Sets a file name.
void	setMessages(Messages messages)
<T> T	withExporter(Class<T> exporterClass)
<T> T	withFileName(String fileName)	Sets a file name.

Methods inherited from class io.jmix.flowui.action.list.ListDataComponentAction

actionPerform, attachSelectionListener, checkTarget, checkTargetItems, getTarget, initAction, onSelectionChange, setTarget, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.action.SecuredBaseAction

addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabledByUiPermissions, setVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.kit.action.BaseAction

addActionPerformedListener, isApplicable, setEnabled, setEnabledInternal, setVisible, setVisibleInternal

Methods inherited from class io.jmix.flowui.kit.action.AbstractAction

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setShortcutCombination, setText, setVariant

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.flowui.kit.action.Action

addPropertyChangeListener, getDescription, getIcon, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

messages

protected Messages messages

downloader

protected Downloader downloader

dialogs

protected Dialogs dialogs

dataGridExporter

protected DataGridExporter dataGridExporter

Constructor Details

ExportAction

public ExportAction()

ExportAction

public ExportAction(String id)

Method Details

setApplicationContext

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

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setMessages

@Autowired
public void setMessages(Messages messages)

setDownloader

@Autowired
public void setDownloader(Downloader downloader)

setDialogs

@Autowired
public void setDialogs(Dialogs dialogs)

setDataGridExporter

public void setDataGridExporter(DataGridExporter dataGridExporter)

Sets the dataGrid exporter instance

withExporter

public <T> T withExporter(Class<T> exporterClass)

setFileName

public void setFileName(String fileName)

Sets a file name.

Parameters:

fileName - a file name

withFileName

public <T> T withFileName(String fileName)

Sets a file name.

Parameters:

fileName - a file name

Returns:

builder

addColumnValueProvider

public void addColumnValueProvider(String columnId,
 Function<DataGridExporter.ColumnValueContext,Object> columnValueProvider)

Adds a function to get value from the column.

Parameters:

columnId - column id

columnValueProvider - column value provider function

removeColumnValueProvider

public void removeColumnValueProvider(String columnId)

Removes an column value provider function by column id.

Parameters:

columnId - column id

getColumnValueProvider

@Nullable
public Function<DataGridExporter.ColumnValueContext,Object> getColumnValueProvider(String columnId)

Parameters:

columnId - column id

Returns:

column value provider function for the column id

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

Specified by:

execute in interface ExecutableAction

doExport

protected void doExport(ExportMode exportMode)

getMessage

protected String getMessage(String id)

createExportSelectedAction

protected Action createExportSelectedAction()

createExportAllAction

protected Action createExportAllAction()

createCurrentPageAction

protected Action createCurrentPageAction()

isDataLoaderExist

protected boolean isDataLoaderExist(ListDataComponent<?> target)