com.jidesoft.pivot
Interface PivotConstants

All Known Subinterfaces:

IPivotDataModel

All Known Implementing Classes:

AggregateTableModel.AggregateTablePivotDataModel, CalculatedHeaderTableModel, CalculatedPivotDataModel, DataTableModel, DefaultSummaryCalculator, HeaderTableModel, PivotDataModel, PivotField, PivotTablePane

public interface PivotConstants

Constants used in pivot grid product.

Field Summary

static int	AREA_COLUMN A constant for the pivot field area for column fields.
static int	AREA_DATA A constant for the pivot field area for data fields.
static int	AREA_FILTER A constant for the pivot field area for filter fields.
static String[]	AREA_NAMES All the field area names.
static int	AREA_NOT_ASSIGNED A constant for the pivot field area for not assigned fields.
static int	AREA_ROW A constant for the pivot field area for row fields.
static Object	COMPARE_TO_NEXT An object to represent that the running summary would compare to the next value.
static Object	COMPARE_TO_PREVIOUS An object to represent that the running summary would compare to the previous value.
static int	HEADER_SELECTION_DATA_TABLE_ONLY A constant for header selection mode.
static int	HEADER_SELECTION_HEADER_TABLE_ONLY A constant for header selection mode.
static PivotField	RANGE_IN_TOTAL Special PivotField instance to represent that the running summary will run through all the columns.
static int	RUNNING_SUMMARY_DIFFERENCE A running type, which represents the difference between this value and the compared value.
static int	RUNNING_SUMMARY_PERCENTAGE_FROM A running type, which represents the percentage from the compared value to this value.
static int	RUNNING_SUMMARY_PERCENTAGE_OF A running type, which represents the percentage of this value comparing to the compared value.
static int	RUNNING_SUMMARY_PERCENTAGE_TOTAL A running type, which represents the percentage of this value comparing to the summary within the range.
static int	RUNNING_SUMMARY_TOTAL A running type, which represents the total summary from the beginning in the range to this value.
static int	STATISTICS_CALCULATION_DEFAULT A constant for statistics calculation type.
static int	STATISTICS_CALCULATION_RUNNING A constant for statistics calculation type.
static int	STATISTICS_CALCULATION_RUNNING_IN_COLUMN A constant for statistics calculation type.
static int	STATISTICS_CALCULATION_RUNNING_LEAF A constant for statistics calculation type.
static int	SUBTOTAL_AUTOMATIC A constant for subtotal type.
static int	SUBTOTAL_CUSTOM A constant for subtotal type.
static int	SUBTOTAL_NONE A constant for subtotal type.
static int	SUMMARY_COUNT A constant for summary type.
static int	SUMMARY_CUSTOM A constant for summary type.
static int	SUMMARY_MAX A constant for summary type.
static int	SUMMARY_MEAN A constant for summary type.
static int	SUMMARY_MIN A constant for summary type.
static String[]	SUMMARY_NAMES All the summary type names.
static int	SUMMARY_NONE A constant for summary type.
static int	SUMMARY_RESERVED_MAX A constant for the maximum value of summary type.
static int	SUMMARY_STDDEV A constant for summary type.
static int	SUMMARY_SUM A constant for summary type.
static int	SUMMARY_VAR A constant for summary type.

Field Detail

AREA_ROW

static final int AREA_ROW

A constant for the pivot field area for row fields. Used by PivotField.setAreaType(int).

See Also:

Constant Field Values

AREA_COLUMN

static final int AREA_COLUMN

A constant for the pivot field area for column fields. Used by PivotField.setAreaType(int).

See Also:

Constant Field Values

AREA_FILTER

static final int AREA_FILTER

A constant for the pivot field area for filter fields. Used by PivotField.setAreaType(int).

See Also:

Constant Field Values

AREA_DATA

static final int AREA_DATA

A constant for the pivot field area for data fields. Used by PivotField.setAreaType(int).

See Also:

Constant Field Values

AREA_NOT_ASSIGNED

static final int AREA_NOT_ASSIGNED

A constant for the pivot field area for not assigned fields. Those fields will appear in the field chooser panel only Used by PivotField.setAreaType(int).

See Also:

Constant Field Values

AREA_NAMES

static final String[] AREA_NAMES

All the field area names. The names are localized using Locale.getDefault() as the locale. If you want a different locale, using PivotTablePane.getAreaName(java.util.Locale,int) instead.

SUMMARY_NONE

static final int SUMMARY_NONE

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_CUSTOM

static final int SUMMARY_CUSTOM

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_SUM

static final int SUMMARY_SUM

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_MAX

static final int SUMMARY_MAX

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_MIN

static final int SUMMARY_MIN

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_MEAN

static final int SUMMARY_MEAN

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_VAR

static final int SUMMARY_VAR

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_STDDEV

static final int SUMMARY_STDDEV

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_COUNT

static final int SUMMARY_COUNT

A constant for summary type. Used by PivotField.setSummaryType(int) and PivotField.setCustomSubtotals(int[]).

See Also:

Constant Field Values

SUMMARY_RESERVED_MAX

static final int SUMMARY_RESERVED_MAX

A constant for the maximum value of summary type. If you need to define your own summary statistics, you must start your summary type value from from SUMMARY_RESERVED_MAX + 1, and continues with SUMMARY_RESERVED_MAX + 2, SUMMARY_RESERVED_MAX + 3, etc. There should be no gap in between.

See Also:

Constant Field Values

RUNNING_SUMMARY_DIFFERENCE

static final int RUNNING_SUMMARY_DIFFERENCE

A running type, which represents the difference between this value and the compared value.

See Also:

Constant Field Values

RUNNING_SUMMARY_PERCENTAGE_OF

static final int RUNNING_SUMMARY_PERCENTAGE_OF

A running type, which represents the percentage of this value comparing to the compared value.

See Also:

Constant Field Values

RUNNING_SUMMARY_PERCENTAGE_FROM

static final int RUNNING_SUMMARY_PERCENTAGE_FROM

A running type, which represents the percentage from the compared value to this value.

See Also:

Constant Field Values

RUNNING_SUMMARY_TOTAL

static final int RUNNING_SUMMARY_TOTAL

A running type, which represents the total summary from the beginning in the range to this value.

See Also:

Constant Field Values

RUNNING_SUMMARY_PERCENTAGE_TOTAL

static final int RUNNING_SUMMARY_PERCENTAGE_TOTAL

A running type, which represents the percentage of this value comparing to the summary within the range.

See Also:

Constant Field Values

RANGE_IN_TOTAL

static final PivotField RANGE_IN_TOTAL

Special PivotField instance to represent that the running summary will run through all the columns.

COMPARE_TO_PREVIOUS

static final Object COMPARE_TO_PREVIOUS

An object to represent that the running summary would compare to the previous value.

COMPARE_TO_NEXT

static final Object COMPARE_TO_NEXT

An object to represent that the running summary would compare to the next value.

SUMMARY_NAMES

static final String[] SUMMARY_NAMES

All the summary type names. The names are localized using Locale.getDefault() as the locale. If you want a different locale, using PivotTablePane.getSummaryName(java.util.Locale,int) instead.

SUBTOTAL_NONE

static final int SUBTOTAL_NONE

A constant for subtotal type. Used by PivotField.setSubtotalType(int).

See Also:

Constant Field Values

SUBTOTAL_AUTOMATIC

static final int SUBTOTAL_AUTOMATIC

A constant for subtotal type. Used by PivotField.setSubtotalType(int). SUBTOTAL_AUTOMATIC means it will use Sum to calculate the subtotal.

See Also:

Constant Field Values

SUBTOTAL_CUSTOM

static final int SUBTOTAL_CUSTOM

A constant for subtotal type. Used by PivotField.setSubtotalType(int). SUBTOTAL_CUSTOM means it will use the value in PivotField.setCustomSubtotals(int[]) to decide how to calculate the subtotals.

See Also:

Constant Field Values

STATISTICS_CALCULATION_DEFAULT

static final int STATISTICS_CALCULATION_DEFAULT

A constant for statistics calculation type. This is the default calculation type which will calculate the statistics based on the original values in the table model.

See Also:

Constant Field Values

STATISTICS_CALCULATION_RUNNING

static final int STATISTICS_CALCULATION_RUNNING

A constant for statistics calculation type. This is a calculation type which will calculation the statistics based on the running values in the next level as displayed in the UI. If both keys are summary values, it will calculate the value based on the values in the same row by default

See Also:

Constant Field Values

STATISTICS_CALCULATION_RUNNING_IN_COLUMN

static final int STATISTICS_CALCULATION_RUNNING_IN_COLUMN

A constant for statistics calculation type. This is a calculation type which will calculation the statistics based on the running values as displayed in the UI. It only applies to the scenario that both keys are summary values, it will then calculate the value based on the values in the same column.

See Also:

Constant Field Values

STATISTICS_CALCULATION_RUNNING_LEAF

static final int STATISTICS_CALCULATION_RUNNING_LEAF

A constant for statistics calculation type. This is a calculation type which will calculation the statistics based on the running values in the leaf level as displayed in the UI. If both keys are summary values, it will calculate the value based on the values in the same row by default

Since:

3.4.4

See Also:

Constant Field Values

HEADER_SELECTION_HEADER_TABLE_ONLY

static final int HEADER_SELECTION_HEADER_TABLE_ONLY

A constant for header selection mode. In this mode, the header could be selected and if the header is clicked, only the header cell is selected.

See Also:

Constant Field Values

HEADER_SELECTION_DATA_TABLE_ONLY

static final int HEADER_SELECTION_DATA_TABLE_ONLY

A constant for header selection mode. In this mode, the header will not be selected and gain focus in any cases. If the header is clicked, the corresponding row or column in the DataTable are selected.

See Also:

Constant Field Values