com.haulmont.charts.gui.components.action.list

Class PivotScreenBuilder

java.lang.Object

com.haulmont.charts.gui.components.action.list.PivotScreenBuilder

@Component(value="charts_pivotScreenBuilder")
 @Scope(value="prototype")
public class PivotScreenBuilder
extends java.lang.Object

Prepares data and builds a screen with pivot table component.

See Also:

ShowPivotAction

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PivotScreenBuilder(com.haulmont.cuba.gui.components.ListComponent target)

Method Summary

Modifier and Type	Method and Description
com.haulmont.cuba.gui.screen.Screen	build()
java.util.List<java.lang.String>	getAdditionalProperties()
java.util.List<java.lang.String>	getExcludedProperties()
java.util.List<java.lang.String>	getIncludedProperties()
java.lang.String	getNativeJson()
PivotScreenBuilder	withAdditionalProperties(java.util.List<java.lang.String> additionalProperties) Set properties which should be additionally included.
PivotScreenBuilder	withExcludedProperties(java.util.List<java.lang.String> excludedProperties) Set excluded properties list using fluent API method.
PivotScreenBuilder	withIncludedProperties(java.util.List<java.lang.String> includedProperties) Set included properties list using fluent API method.
PivotScreenBuilder	withItems(java.util.Collection<? extends com.haulmont.cuba.core.entity.Entity> items) Sets items that should be shown in PivotTable.
PivotScreenBuilder	withNativeJson(java.lang.String nativeJson) Set native json using fluent API method.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

SCREEN_ID

public static final java.lang.String SCREEN_ID

See Also:

Constant Field Values

Constructor Detail

PivotScreenBuilder

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

Method Detail

getIncludedProperties

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

Returns:

list of included properties

withIncludedProperties

public PivotScreenBuilder 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 ShowPivotAction.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 PivotScreenBuilder withExcludedProperties(java.util.List<java.lang.String> excludedProperties)

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

Parameters:

excludedProperties - list of excluded properties

Returns:

current instance

withAdditionalProperties

public PivotScreenBuilder 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

getNativeJson

public java.lang.String getNativeJson()

Returns:

configuration json of pivot table

withNativeJson

public PivotScreenBuilder 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

withItems

public PivotScreenBuilder withItems(java.util.Collection<? extends com.haulmont.cuba.core.entity.Entity> items)

Sets items that should be shown in PivotTable.

Parameters:

items - collection of entities

Returns:

current instance

build

public com.haulmont.cuba.gui.screen.Screen build()

Returns:

created screen