Package io.jmix.pivottable.action.list

Class ShowPivotAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.pivottable.action.list.ShowPivotAction

All Implemented Interfaces:

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

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Gets items from Table/DataGrid and shows them in a new screen with PivotTable component")
@ActionType("showPivot")
public class ShowPivotAction
extends ListAction

Gets items from ListComponent and shows them in new screen with pivot table component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	ShowPivotAction.ShowPivotMode	Provides two modes for exporting rows from component.

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 org.springframework.context.ApplicationContext	applicationContext
protected String	excludedProperties
static final String	ID
protected String	includedProperties
protected Messages	messages

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

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
String	getExcludedProperties()
List<String>	getExcludedPropertiesList()
String	getIncludedProperties()
List<String>	getIncludedPropertiesList()
protected boolean	needShowAll()
protected List<String>	parseProperties(String properties)
protected void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setExcludedProperties(String properties)	Set excluded properties separated by a comma.
void	setIncludedProperties(String properties)	Sets included properties separated by a comma.
protected void	setMessages(Messages messages)
protected void	showPivotTable(ShowPivotAction.ShowPivotMode mode)

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

messages

protected Messages messages

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

includedProperties

protected String includedProperties

excludedProperties

protected String excludedProperties

Constructor Details

ShowPivotAction

public ShowPivotAction()

ShowPivotAction

public ShowPivotAction(String id)

Method Details

setMessages

@Autowired
protected void setMessages(Messages messages)

setApplicationContext

@Autowired
protected void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

setExcludedProperties

@StudioPropertiesItem(name="excludedProperties",
                      description="Set excluded properties separated by a comma. Excluded properties will not be shown in the PivotTable")
public void setExcludedProperties(String properties)

Set excluded properties separated by a comma. Excluded properties will not be shown in the PivotTable.

Parameters:

properties - excluded properties

getExcludedProperties

public String getExcludedProperties()

getExcludedPropertiesList

public List<String> getExcludedPropertiesList()

Returns:

list with parsed excluded properties

setIncludedProperties

@StudioPropertiesItem(name="includedProperties",
                      description="Sets included properties separated by a comma. Only included properties will be shown in the PivotTable")
public void setIncludedProperties(String properties)

Sets included properties separated by a comma. Only included properties will be shown in the PivotTable.

Parameters:

properties - included properties

getIncludedProperties

public String getIncludedProperties()

getIncludedPropertiesList

public List<String> getIncludedPropertiesList()

Returns:

list with parsed included properties

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

needShowAll

protected boolean needShowAll()

parseProperties

protected List<String> parseProperties(String properties)

showPivotTable

protected void showPivotTable(ShowPivotAction.ShowPivotMode mode)