JIDE 3.5.15

com.jidesoft.pivot
Class PivotValueProviderEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.jidesoft.pivot.PivotValueProviderEvent
All Implemented Interfaces:
Serializable

public class PivotValueProviderEvent
extends EventObject

See Also:
Serialized Form

Field Summary
static int ADJUSTING_END_BOTH_HEADERS_CHANGE
          ADJUSTING_END_BOTH_HEADERS_CHANGE will be fired after adjusting end and both header tables update are required.
static int ADJUSTING_END_COLUMN_HEADER_CHANGE
          ADJUSTING_END_COLUMN_HEADER_CHANGE will be fired after adjusting end and column header table update is required.
static int ADJUSTING_END_ROW_HEADER_CHANGE
          ADJUSTING_END_ROW_HEADER_CHANGE will be fired after adjusting end and row header table update is required.
static int ADJUSTING_END_UPDATE_DATA_TABLE_ONLY
          ADJUSTING_END_UPDATE_DATA_TABLE_ONLY will be fired after adjusting end and no header tables update is required.
static int ADJUSTING_START
          ADJUSTING_START will be fired before sorting or other non-calculation scenario.
static int CALCULATION_END_ONLY_RESULT_UPDATED
          CALCULATION_END_ONLY_RESULT_UPDATED will be fired after calculation with only result updated.
static int CALCULATION_END_WITH_STRUCTURE_CHANGED
          CALCULATION_END_WITH_STRUCTURE_CHANGED will be fired after calculation with structure changed.
static int CALCULATION_START_DATA_UPDATED
          CALCULATION_START_REQUESTED will be fired before calculation caused by original data update.
static int CALCULATION_START_REQUESTED
          CALCULATION_START_REQUESTED will be fired before calculation caused by operation like fields update, etc.
static int INFO_AFFECTED_VALUES
          INFO_AFFECTED_VALUES will be fired after CALCULATION_END_WITH_STRUCTURE_CHANGED or CALCULATION_END_ONLY_RESULT_UPDATED if PivotDataModel.isComputeAffectedCellOnUpdate() returns true.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
PivotValueProviderEvent(Object source, int type)
           
PivotValueProviderEvent(Object source, int type, Object object)
           
 
Method Summary
 Object getObject()
          Get the event related object.
 int getType()
          Get the event type.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CALCULATION_START_REQUESTED

public static final int CALCULATION_START_REQUESTED
CALCULATION_START_REQUESTED will be fired before calculation caused by operation like fields update, etc.

See Also:
Constant Field Values

CALCULATION_START_DATA_UPDATED

public static final int CALCULATION_START_DATA_UPDATED
CALCULATION_START_REQUESTED will be fired before calculation caused by original data update.

See Also:
Constant Field Values

CALCULATION_END_WITH_STRUCTURE_CHANGED

public static final int CALCULATION_END_WITH_STRUCTURE_CHANGED
CALCULATION_END_WITH_STRUCTURE_CHANGED will be fired after calculation with structure changed.

Pair with CALCULATION_START_REQUESTED or CALCULATION_START_DATA_UPDATED.

It will contains the CALCULATION_START_DATA_UPDATED in its object if it's triggered by original data update. PivotTablePane would not rearrange the pivot field with this field filled.

See Also:
Constant Field Values

CALCULATION_END_ONLY_RESULT_UPDATED

public static final int CALCULATION_END_ONLY_RESULT_UPDATED
CALCULATION_END_ONLY_RESULT_UPDATED will be fired after calculation with only result updated. The hierarchy does not change.

Pair with CALCULATION_START_REQUESTED or CALCULATION_START_DATA_UPDATED.

See Also:
Constant Field Values

ADJUSTING_START

public static final int ADJUSTING_START
ADJUSTING_START will be fired before sorting or other non-calculation scenario.

PivotTablePane would use this event to save selections or support other persistence mechanism.

See Also:
Constant Field Values

ADJUSTING_END_ROW_HEADER_CHANGE

public static final int ADJUSTING_END_ROW_HEADER_CHANGE
ADJUSTING_END_ROW_HEADER_CHANGE will be fired after adjusting end and row header table update is required.

Pair with ADJUSTING_START

See Also:
Constant Field Values

ADJUSTING_END_COLUMN_HEADER_CHANGE

public static final int ADJUSTING_END_COLUMN_HEADER_CHANGE
ADJUSTING_END_COLUMN_HEADER_CHANGE will be fired after adjusting end and column header table update is required.

Pair with ADJUSTING_START

See Also:
Constant Field Values

ADJUSTING_END_BOTH_HEADERS_CHANGE

public static final int ADJUSTING_END_BOTH_HEADERS_CHANGE
ADJUSTING_END_BOTH_HEADERS_CHANGE will be fired after adjusting end and both header tables update are required.

Pair with ADJUSTING_START

See Also:
Constant Field Values

ADJUSTING_END_UPDATE_DATA_TABLE_ONLY

public static final int ADJUSTING_END_UPDATE_DATA_TABLE_ONLY
ADJUSTING_END_UPDATE_DATA_TABLE_ONLY will be fired after adjusting end and no header tables update is required.

Pair with ADJUSTING_START

See Also:
Constant Field Values

INFO_AFFECTED_VALUES

public static final int INFO_AFFECTED_VALUES
INFO_AFFECTED_VALUES will be fired after CALCULATION_END_WITH_STRUCTURE_CHANGED or CALCULATION_END_ONLY_RESULT_UPDATED if PivotDataModel.isComputeAffectedCellOnUpdate() returns true.

If you get this event from CalculatedPivotDataModel, it would contain an array to indicate impacted cells in the PivotTablePane. Every 5 items represents one cell. In order, they are rowValues, columnValues, PivotField(the data field), old value and new value.

If you get this event from PivotDataModel, the array would not be able to contain the value information since it does not have cache. Every 3 items represents one cell. In order, they are rowValues, columnValues and PivotField(the data field).

NOTE: oldValue equals null means that, either the value is null or the values was not cached.

See Also:
Constant Field Values
Constructor Detail

PivotValueProviderEvent

public PivotValueProviderEvent(Object source,
                               int type)

PivotValueProviderEvent

public PivotValueProviderEvent(Object source,
                               int type,
                               Object object)
Method Detail

getType

public int getType()
Get the event type.

Returns:
the event type.

getObject

public Object getObject()
Get the event related object. In collapse/expand scenario, while the event type is ADJUSTING_END_BOTH_HEADERS_CHANGE, the object is an array of Expandable which just changed collapse/expand status. In other scenarios, it's always null.

Returns:
the event related object.

JIDE 3.5.15