JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.chart
Class ChartDataEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.klg.jclass.chart.ChartDataEvent
All Implemented Interfaces:
Serializable

public class ChartDataEvent
extends EventObject

Class used to encapsulate a chart data change event.

See Also:
Serialized Form

Field Summary
static int ADD_SERIES
          Enum value indicating a data series has been added to the end of the set of data series.
static int ALL_POINTS
          Enum value used for pointIndex to indicate all points are affected.
static int ALL_SERIES
          Enum value used for seriesIndex to indicate all series are affected.
static int APPEND_DATA
          Enum value indicating that data has been appended to the end of the specified data series.
static int CHANGE_CHART_TYPE
          Enum indicating that the chart type has changed.
static int INSERT_SERIES
          Enum value indicating a data series has ben inserted at a particular index in the set of data series.
protected  int pointIndex
          Point index impacted by change (if applicable).
static int RELOAD
          Enum indicating that the data should be reloaded.
static int RELOAD_ALL_POINT_LABELS
          Enum value indicating all point labels need to be reloaded.
static int RELOAD_ALL_SERIES_LABELS
          Enum value indicating that all series labels need to be reloaded.
static int RELOAD_DATA_SOURCE_NAME
          Enum value indicating the data source name that needs to be reloaded.
static int RELOAD_HOLE_VALUE
          Enum value indicating that the hole value needs to be reloaded.
static int RELOAD_IMAGE_MAP_INFO
          Enum value indicating that the image map information needs to be reloaded.
static int RELOAD_POINT
          Enum value indicating a single data value has changed.
static int RELOAD_POINT_LABEL
          Enum value indicating a particular point label needs to be reloaded.
static int RELOAD_SERIES
          Enum value indicating a data series has changed.
static int RELOAD_SERIES_LABEL
          Enum value indicating a particular series label needs to be reloaded.
static int REMOVE_SERIES
          Enum value indicating a data series has been removed.
static int RESET
          Enum indicating that the data source has been completely reset.
protected  int seriesIndex
          Data series impacted by change (if applicable).
protected  int type
          Type of data change.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ChartDataEvent(Object dataSrc, int type, int seriesIndex, int pointIndex)
          Constructor used to create a ChartDataEvent object, with the = chart data changes and the data source.
 
Method Summary
 int getPointIndex()
          Gets the PointIndex property.
 int getSeriesIndex()
          Gets the SeriesIndex property.
 int getType()
          Gets the Type property.
 
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

type

protected int type
Type of data change. One of the enum values specified in this class.


seriesIndex

protected int seriesIndex
Data series impacted by change (if applicable).


pointIndex

protected int pointIndex
Point index impacted by change (if applicable).


RELOAD_POINT

public static final int RELOAD_POINT
Enum value indicating a single data value has changed. In this case, seriesIndex and pointIndex are used to index the point. An event of this type should be used when a value has been changed in a series value array that has previously been queried by the chart from the data source. If the array needs to be regenerated, RELOAD_SERIES should be used instead.

See Also:
Constant Field Values

RELOAD_SERIES

public static final int RELOAD_SERIES
Enum value indicating a data series has changed. In this case, seriesIndex points to the series to reload. An event of this type will requery the series value array from the data source.

See Also:
Constant Field Values

ADD_SERIES

public static final int ADD_SERIES
Enum value indicating a data series has been added to the end of the set of data series.

See Also:
Constant Field Values

INSERT_SERIES

public static final int INSERT_SERIES
Enum value indicating a data series has ben inserted at a particular index in the set of data series. In this case, seriesIndex holds the index at which to insert the series.

See Also:
Constant Field Values

REMOVE_SERIES

public static final int REMOVE_SERIES
Enum value indicating a data series has been removed. In this case, seriesIndex holds the index of the series to be removed.

See Also:
Constant Field Values

RELOAD_ALL_POINT_LABELS

public static final int RELOAD_ALL_POINT_LABELS
Enum value indicating all point labels need to be reloaded.

See Also:
Constant Field Values

RELOAD_POINT_LABEL

public static final int RELOAD_POINT_LABEL
Enum value indicating a particular point label needs to be reloaded. pointIndex indicates which label should be reloaded

See Also:
Constant Field Values

RELOAD_ALL_SERIES_LABELS

public static final int RELOAD_ALL_SERIES_LABELS
Enum value indicating that all series labels need to be reloaded.

See Also:
Constant Field Values

RELOAD_SERIES_LABEL

public static final int RELOAD_SERIES_LABEL
Enum value indicating a particular series label needs to be reloaded. seriesIndex indicates which label should be reloaded.

See Also:
Constant Field Values

RELOAD_DATA_SOURCE_NAME

public static final int RELOAD_DATA_SOURCE_NAME
Enum value indicating the data source name that needs to be reloaded.

See Also:
Constant Field Values

APPEND_DATA

public static final int APPEND_DATA
Enum value indicating that data has been appended to the end of the specified data series. This event refreshes the data and does a fast update.
Note: A fast update can be done only for charts of type PLOT, SCATTER_PLOT and AREA. Also, the fastUpdate property of the corresponding ChartDataView must be set to true.

See Also:
Constant Field Values

RESET

public static final int RESET
Enum indicating that the data source has been completely reset.

See Also:
Constant Field Values

RELOAD

public static final int RELOAD
Enum indicating that the data should be reloaded.

See Also:
Constant Field Values

CHANGE_CHART_TYPE

public static final int CHANGE_CHART_TYPE
Enum indicating that the chart type has changed. The chart type is specified by seriesIndex.

See Also:
Constant Field Values

RELOAD_HOLE_VALUE

public static final int RELOAD_HOLE_VALUE
Enum value indicating that the hole value needs to be reloaded.

See Also:
Constant Field Values

RELOAD_IMAGE_MAP_INFO

public static final int RELOAD_IMAGE_MAP_INFO
Enum value indicating that the image map information needs to be reloaded.

See Also:
Constant Field Values

ALL_SERIES

public static final int ALL_SERIES
Enum value used for seriesIndex to indicate all series are affected.

See Also:
Constant Field Values

ALL_POINTS

public static final int ALL_POINTS
Enum value used for pointIndex to indicate all points are affected.

See Also:
Constant Field Values
Constructor Detail

ChartDataEvent

public ChartDataEvent(Object dataSrc,
                      int type,
                      int seriesIndex,
                      int pointIndex)
Constructor used to create a ChartDataEvent object, with the = chart data changes and the data source.

Parameters:
dataSrc - the data source
type - data change type to pass to the views
seriesIndex - index of series affected by the change
pointIndex - index of point affected by the change
Method Detail

getType

public int getType()
Gets the Type property. It contains the type of change that has happened to the chart data.

Returns:
the Type property, which is one of the enums above

getSeriesIndex

public int getSeriesIndex()
Gets the SeriesIndex property.

Returns:
SeriesIndex property

getPointIndex

public int getPointIndex()
Gets the PointIndex property.

Returns:
PointIndex property

Copyright © 2004 Quest Software Inc..
All rights reserved.