com.haulmont.charts.gui.components.action

Class ShowPivotAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

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

com.haulmont.charts.gui.components.action.ShowPivotAction

All Implemented Interfaces:

com.haulmont.cuba.gui.components.Action, com.haulmont.cuba.gui.components.Action.HasBeforeActionPerformedHandler, com.haulmont.cuba.gui.components.Action.HasTarget, com.haulmont.cuba.gui.components.Action.UiPermissionAware

@Component(value="charts_ShowPivotAction")
 @Scope(value="prototype")
public class ShowPivotAction
extends com.haulmont.cuba.gui.components.actions.BaseAction
implements com.haulmont.cuba.gui.components.Action.HasBeforeActionPerformedHandler

Gets all or selected rows from ListComponent and shows them in new screen with pivot table component.

Action's behaviour can be customized by providing arguments to constructor or setting properties.

In order to provide your own implementation globally, create a subclass and register it in web-spring.xml, for example:

 <bean id="charts_ShowPivotAction" class="com.company.sample.gui.MyShowPivotAction" scope="prototype"/>
 

Also, use create() static methods instead of constructors when creating the action programmatically.

Nested Class Summary

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

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

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

com.haulmont.cuba.gui.components.Action.ActionPerformedEvent, com.haulmont.cuba.gui.components.Action.BeforeActionPerformedHandler, com.haulmont.cuba.gui.components.Action.HasBeforeActionPerformedHandler, com.haulmont.cuba.gui.components.Action.HasOpenType, com.haulmont.cuba.gui.components.Action.HasSecurityConstraint, com.haulmont.cuba.gui.components.Action.HasTarget, com.haulmont.cuba.gui.components.Action.Status, com.haulmont.cuba.gui.components.Action.UiPermissionAware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID
static java.lang.String	NAME
static java.lang.String	SCREEN_ID

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
ShowPivotAction(com.haulmont.cuba.gui.components.ListComponent target) The simplest constructor.
ShowPivotAction(com.haulmont.cuba.gui.components.ListComponent target, java.lang.String id) Constructor allows to specify action's name.

Method Summary

Modifier and Type	Method and Description
void	actionPerform(com.haulmont.cuba.gui.components.Component component)
static ShowPivotAction	create(com.haulmont.cuba.gui.components.ListComponent target) Creates an action with default id.
static ShowPivotAction	create(com.haulmont.cuba.gui.components.ListComponent target, java.lang.String id) Creates an action with specified id.
java.util.List<java.lang.String>	getAdditinalProperties() Deprecated. will be removed in 7.0
java.util.List<java.lang.String>	getAdditionalProperties()
com.haulmont.cuba.gui.components.Action.BeforeActionPerformedHandler	getBeforeActionPerformedHandler()
java.util.List<java.lang.String>	getExcludedProperties()
java.util.List<java.lang.String>	getIncludedProperties()
java.lang.String	getNativeJson()
void	setBeforeActionPerformedHandler(com.haulmont.cuba.gui.components.Action.BeforeActionPerformedHandler handler)
ShowPivotAction	withAdditionalProperties(java.util.List<java.lang.String> additionalProperties) Set properties which should be additionally included.
ShowPivotAction	withExcludedProperties(java.util.List<java.lang.String> excludedProperties) Set excluded properties list using fluent API method.
ShowPivotAction	withIncludedProperties(java.util.List<java.lang.String> includedProperties) Set included properties list using fluent API method.
ShowPivotAction	withNativeJson(java.lang.String nativeJson) Set native json using fluent API method.

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

addEnabledRule, getTarget, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setTarget, setVisible, setVisibleByUiPermissions, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

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

Methods inherited from class java.lang.Object

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

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

ACTION_ID

public static final java.lang.String ACTION_ID

See Also:

Constant Field Values

SCREEN_ID

public static final java.lang.String SCREEN_ID

See Also:

Constant Field Values

Constructor Detail

ShowPivotAction

public ShowPivotAction(com.haulmont.cuba.gui.components.ListComponent target)

The simplest constructor. The action uses default id and other parameters.

Parameters:

target - component containing data to export

ShowPivotAction

public ShowPivotAction(com.haulmont.cuba.gui.components.ListComponent target,
                       java.lang.String id)

Constructor allows to specify action's name.

Parameters:

target - component containing data to export

id - action's name

Method Detail

create

public static ShowPivotAction create(com.haulmont.cuba.gui.components.ListComponent target)

Creates an action with default id.

Parameters:

target - component containing data to export

create

public static ShowPivotAction create(com.haulmont.cuba.gui.components.ListComponent target,
                                     java.lang.String id)

Creates an action with specified id.

Parameters:

target - component containing data to export

id - action's id

actionPerform

public void actionPerform(com.haulmont.cuba.gui.components.Component component)

Specified by:

actionPerform in interface com.haulmont.cuba.gui.components.Action

Overrides:

actionPerform in class com.haulmont.cuba.gui.components.actions.BaseAction

getIncludedProperties

public java.util.List<java.lang.String> getIncludedProperties()

Returns:

list of included properties

withIncludedProperties

public ShowPivotAction withIncludedProperties(java.util.List<java.lang.String> includedProperties)

Set included properties list using fluent API method. If included properties aren't set, all properties in the view will be shown, otherwise only included properties will be shown in the pivot table unless withExcludedProperties(List) is not set.

Parameters:

includedProperties - list of included properties

Returns:

current instance of action

getExcludedProperties

public java.util.List<java.lang.String> getExcludedProperties()

Returns:

list of excluded properties

withExcludedProperties

public ShowPivotAction withExcludedProperties(java.util.List<java.lang.String> excludedProperties)

Set excluded properties list using fluent API method.
Note, if it is used without withIncludedProperties(List), excluded properties will be applied for all properties in the view.

Parameters:

excludedProperties - list of excluded properties

Returns:

current instance of action

withAdditionalProperties

public ShowPivotAction withAdditionalProperties(java.util.List<java.lang.String> additionalProperties)

Set properties which should be additionally included. Additional property doesn't applied if excluded properties list contains it.

Parameters:

additionalProperties - list of additional properties

Returns:

current instance of action

getAdditionalProperties

public java.util.List<java.lang.String> getAdditionalProperties()

Returns:

list of additionally included properties

getAdditinalProperties

@Deprecated
public java.util.List<java.lang.String> getAdditinalProperties()

Deprecated. will be removed in 7.0

Returns:

list of additionally included properties

See Also:

getAdditionalProperties()

getNativeJson

public java.lang.String getNativeJson()

Returns:

configuration json of pivot table

withNativeJson

public ShowPivotAction withNativeJson(java.lang.String nativeJson)

Set native json using fluent API method. Using native json you can configure pivot table with initial values. For instance, for non-editable pivot table:

 
 {
 	"cols": ["localized property", "localized property"],
 	"rows": ["localized property"],
 	"editable": false,
 	"renderer": "heatmap",
 	"aggregation": {
 		"id": "d8fc3fdf-730d-c94f-a0c8-72a9ce3dcb3a",
 		"mode": "sumOverSum",
 		"properties": ["localized property", "localized property"]
 	}
 }
 
 

for editable pivot table:

 
 {
 	"cols": ["localized property"],
 	"rows": ["localized property"],
 	"editable": true,
 	"renderers": {
 		"selectedRenderer": "barChart"
 	},
 	"autoSortUnusedProperties": true,
 	"aggregationProperties": ["localized property", "localized property"],
 	"aggregations": {
 		"selectedAggregation": "count",
 		"aggregations": [{
 			"id": "647780f0-c6d0-6ade-a63a-542b5c8cdbd5",
 			"mode": "count",
 			"caption": "Count"
 		}, {
 			"id": "c2663238-2654-67f0-2dec-add6962d867c",
 			"mode": "sumOverSum"
 		}]
 	}
 }
 
 

Parameters:

nativeJson - configuration json of pivot table

Returns:

current instance of action

getBeforeActionPerformedHandler

public com.haulmont.cuba.gui.components.Action.BeforeActionPerformedHandler getBeforeActionPerformedHandler()

Specified by:

getBeforeActionPerformedHandler in interface com.haulmont.cuba.gui.components.Action.HasBeforeActionPerformedHandler

setBeforeActionPerformedHandler

public void setBeforeActionPerformedHandler(com.haulmont.cuba.gui.components.Action.BeforeActionPerformedHandler handler)

Specified by:

setBeforeActionPerformedHandler in interface com.haulmont.cuba.gui.components.Action.HasBeforeActionPerformedHandler