ilog.views.chart.event

Class DataSetContentsEvent

java.lang.Object

java.util.EventObject

ilog.views.chart.event.DataSetContentsEvent

All Implemented Interfaces:

DataSetEvent, Serializable

public class DataSetContentsEvent
extends EventObject
implements DataSetEvent

Describes events fired by an IlvDataSet when its contents changes.

Since:

JViews 5.0

See Also:

DataSetListener, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFTER_DATA_CHANGED Type of event sent after the data points have been modified.
static int	BATCH_BEGIN Type of event sent when a series of events starts.
static int	BATCH_END Type of event sent when a series of events is terminated.
static int	BEFORE_DATA_CHANGED Type of event sent before the data points are modified.
static int	DATA_ADDED Type of event sent after the data points are appended to a data set.
static int	DATA_CHANGED Type of event sent after the data points have been modified, when no pre-event notification is available.
static int	DATA_LABEL_CHANGED Type of event sent after the data point labels have been modified.
static int	FULL_UPDATE Type of event sent when the whole contents of the data set has been modified.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
DataSetContentsEvent(IlvDataSet dataSet) Describes a full update of the data set.
DataSetContentsEvent(IlvDataSet dataSet, DataSetContentsEvent source) Describes a change on the data set from an existing event.
DataSetContentsEvent(IlvDataSet dataSet, int type, int pointIndex) Describes a change in a data point.
DataSetContentsEvent(IlvDataSet dataSet, int type, int firstIdx, int lastIdx) Describes a change in all the data points between the specified indices.

Method Summary

Modifier and Type	Method and Description
IlvDataSet	getDataSet() Returns the source of the event, for example the data set on which the change occurred.
int	getFirstIdx() Returns the index of the first data point impacted by the modification.
int	getLastIdx() Returns the index of the last data point impacted by the modification.
int	getType() Returns the type of the event.
String	toString() Returns a string representation of this event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BATCH_BEGIN

public static final int BATCH_BEGIN

Type of event sent when a series of events starts.

You are not meant to send this type of event directly. Only the class IlvAbstractDataSet sends it.

Since:

JViews 8.1

See Also:

BATCH_END, IlvAbstractDataSet.startBatch(), Constant Field Values

BATCH_END

public static final int BATCH_END

Type of event sent when a series of events is terminated.

You are not meant to send this type of event directly. Only the class IlvAbstractDataSet sends it.

Since:

JViews 8.1

See Also:

BATCH_BEGIN, IlvAbstractDataSet.endBatch(), Constant Field Values

BEFORE_DATA_CHANGED

public static final int BEFORE_DATA_CHANGED

Type of event sent before the data points are modified.

See Also:

AFTER_DATA_CHANGED, getType(), Constant Field Values

AFTER_DATA_CHANGED

public static final int AFTER_DATA_CHANGED

Type of event sent after the data points have been modified. An AFTER_DATA_CHANGED event is always sent after an BEFORE_DATA_CHANGED event. If no pre-event notification is available, a single DATA_CHANGED event is sent.

See Also:

getType(), Constant Field Values

DATA_CHANGED

public static final int DATA_CHANGED

Type of event sent after the data points have been modified, when no pre-event notification is available.

Note: When a chart receives a DATA_CHANGED event from a data set, the chart area is repainted entirely. It is therefore more efficient if the data set sends pairs of BEFORE_DATA_CHANGED/AFTER_DATA_CHANGED events instead of DATA_CHANGED events.

See Also:

AFTER_DATA_CHANGED, getType(), Constant Field Values

DATA_ADDED

public static final int DATA_ADDED

Type of event sent after the data points are appended to a data set.

See Also:

getType(), Constant Field Values

DATA_LABEL_CHANGED

public static final int DATA_LABEL_CHANGED

Type of event sent after the data point labels have been modified.

See Also:

getType(), Constant Field Values

FULL_UPDATE

public static final int FULL_UPDATE

Type of event sent when the whole contents of the data set has been modified.

See Also:

getType(), Constant Field Values

Constructor Detail

DataSetContentsEvent

public DataSetContentsEvent(IlvDataSet dataSet,
                            int type,
                            int firstIdx,
                            int lastIdx)

Describes a change in all the data points between the specified indices.

Parameters:

dataSet - The modified data set.

type - The type of the modification.

firstIdx - The index of the first data point impacted by the modification.

lastIdx - The index of the first data point impacted by the modification.

DataSetContentsEvent

public DataSetContentsEvent(IlvDataSet dataSet,
                            DataSetContentsEvent source)

Describes a change on the data set from an existing event. This constructor creates a new DataSetContentsEvent object whose attributes are initialized from the source event attributes except the source data set that is set to the specified one.

Parameters:

dataSet - The modified data set.

source - The event to forward.

DataSetContentsEvent

public DataSetContentsEvent(IlvDataSet dataSet)

Describes a full update of the data set.

See Also:

FULL_UPDATE

DataSetContentsEvent

public DataSetContentsEvent(IlvDataSet dataSet,
                            int type,
                            int pointIndex)

Describes a change in a data point.

Method Detail

getFirstIdx

public int getFirstIdx()

Returns the index of the first data point impacted by the modification.

getLastIdx

public int getLastIdx()

Returns the index of the last data point impacted by the modification.

getType

public int getType()

Returns the type of the event.

getDataSet

public IlvDataSet getDataSet()

Returns the source of the event, for example the data set on which the change occurred.

Specified by:

getDataSet in interface DataSetEvent

toString

public String toString()

Returns a string representation of this event.

Overrides:

toString in class EventObject