com.haulmont.cuba.gui.actions.list

Class ExcelAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

com.haulmont.cuba.gui.components.actions.BaseAction

com.haulmont.cuba.gui.components.actions.ListAction

com.haulmont.cuba.gui.actions.list.ExcelAction

All Implemented Interfaces:

Action, Action.HasTarget, Action.SecuredAction

@ActionType(value="excel")
public class ExcelAction
extends ListAction

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Action

Action.ActionPerformedEvent, Action.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected BeanLocator	beanLocator
protected boolean	exportAggregation If true and table is aggregatable will export aggregation row to excel document.
protected java.lang.String	fileName
static java.lang.String	ID
protected Messages	messages

Fields inherited from class com.haulmont.cuba.gui.components.actions.ListAction

target

Fields inherited from class com.haulmont.cuba.gui.components.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface com.haulmont.cuba.gui.components.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
ExcelAction()
ExcelAction(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component when an action occurs.
protected void	export(ExcelExporter.ExportMode exportMode) Export via ExcelExporter.
java.lang.String	getFileName()
boolean	isExportAggregation()
protected boolean	needExportAll()
protected void	setBeanLocator(BeanLocator beanLocator)
void	setExportAggregation(boolean exportAggregation)
void	setFileName(java.lang.String fileName)
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)

Methods inherited from class com.haulmont.cuba.gui.components.actions.ListAction

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

Methods inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

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

Methods inherited from class com.haulmont.cuba.gui.components.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDefaultCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setIconFromSet, 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 com.haulmont.cuba.gui.components.Action

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

messages

protected Messages messages

beanLocator

protected BeanLocator beanLocator

fileName

protected java.lang.String fileName

exportAggregation

protected boolean exportAggregation

If true and table is aggregatable will export aggregation row to excel document.

Constructor Detail

ExcelAction

public ExcelAction()

ExcelAction

public ExcelAction(java.lang.String id)

Method Detail

setIcons

@Inject
protected void setIcons(Icons icons)

setMessages

@Inject
protected void setMessages(Messages messages)

setBeanLocator

@Inject
protected void setBeanLocator(BeanLocator beanLocator)

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component when an action occurs.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

needExportAll

protected boolean needExportAll()

isExportAggregation

public boolean isExportAggregation()

setExportAggregation

public void setExportAggregation(boolean exportAggregation)

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

export

protected void export(ExcelExporter.ExportMode exportMode)

Export via ExcelExporter.