ilog.views.chart.datax.tree.set.event

Class TreeSetModelEvent

java.lang.Object

java.util.EventObject

ilog.views.chart.datax.tree.set.event.TreeSetModelEvent

All Implemented Interfaces:

Serializable

public class TreeSetModelEvent
extends EventObject

This class describes a change in an IlvTreeSetModel.

Since:

JViews 7.5

See Also:

TreeSetModelListener, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TreeSetModelEvent.Type This class defines the event types of the outer event class.

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TreeSetModelEvent(IlvTreeSetModel source, TreeSetModelEvent.Type type) Creates an event.
TreeSetModelEvent(IlvTreeSetModel source, TreeSetModelEvent.Type type, int column, boolean oldValue, boolean newValue) Creates an event.
TreeSetModelEvent(IlvTreeSetModel source, TreeSetModelEvent.Type type, int column, IlvDataColumnInfo columnInfo) Creates an event.
TreeSetModelEvent(IlvTreeSetModel source, TreeSetModelEvent.Type type, int column, Object oldValue, Object newValue) Creates an event.
TreeSetModelEvent(IlvTreeSetModel source, TreeSetModelEvent.Type type, Object object, TreePath objectPath, boolean recursive, int column) Creates an event.
TreeSetModelEvent(IlvTreeSetModel source, TreeSetModelEvent.Type type, Object parent, TreePath parentPath, Object[] objects) Creates an event.

Method Summary

Modifier and Type	Method and Description
int	getColumn() Returns the index of the affected column, or -1 for all columns.
IlvDataColumnInfo	getColumnInfo() Returns the meta information of the affected column, or null for all columns.
IlvTreeSetModel	getModel() Returns the model from which this event comes.
Object	getNewValue() Returns the new value inside the IlvDataColumnInfo.
Object	getObject() Returns the affected object.
TreePath	getObjectPath() Returns the path from the root to the affected object.
Object[]	getObjects() Returns the roots of the affected subtrees.
Object	getOldValue() Returns the old value inside the IlvDataColumnInfo.
Object	getParent() Returns the parent object of the roots of the affected subtrees, or null for a root change.
TreePath	getParentPath() Returns the path from the root to the parent object of the roots of the affected subtrees, or null for a root change.
TreeSetModelEvent.Type	getType() Returns the event type.
boolean	isRecursive() Returns true if the entire subtree is affected, not just a single object.
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

Constructor Detail

TreeSetModelEvent

public TreeSetModelEvent(IlvTreeSetModel source,
                         TreeSetModelEvent.Type type)

Creates an event.

You are not meant to use this constructor. SERIES_BEGIN and SERIES_END are automatically generated by the class IlvAbstractTreeSetModel.

Parameters:

source - The model.

type - One of SERIES_BEGIN, SERIES_END.

TreeSetModelEvent

public TreeSetModelEvent(IlvTreeSetModel source,
                         TreeSetModelEvent.Type type,
                         Object object,
                         TreePath objectPath,
                         boolean recursive,
                         int column)

Creates an event.

Parameters:

source - The model.

type - One of DATA_CHANGED, BEFORE_DATA_CHANGE.

object - The object whose attributes have changed.

objectPath - The path from the root to the object.

recursive - true if the attributes of the entire subtree have changed, false for a change affecting only the single object.

column - Column that changed, or -1 for all columns.

TreeSetModelEvent

public TreeSetModelEvent(IlvTreeSetModel source,
                         TreeSetModelEvent.Type type,
                         Object parent,
                         TreePath parentPath,
                         Object[] objects)

Creates an event.

Parameters:

source - The model.

type - One of OBJECTS_ADDED, OBJECTS_REMOVED, BEFORE_OBJECTS_REMOVED, DURING_OBJECTS_REMOVED.

parent - The parent object of the set of objects that were changed, added or removed, or null for a root change.

parentPath - The path from the root to the parent object, or null for a root change.

objects - The set of objects that was added or removed (together with their entire subtrees).

TreeSetModelEvent

public TreeSetModelEvent(IlvTreeSetModel source,
                         TreeSetModelEvent.Type type,
                         int column,
                         IlvDataColumnInfo columnInfo)

Creates an event.

Parameters:

source - The model.

type - One of COLUMN_ADDED, COLUMN_REMOVED, BEFORE_COLUMN_REMOVED.

column - The column that was added or removed (index after adding or before removing).

columnInfo - The IlvDataColumnInfo of the column that was added or removed.

TreeSetModelEvent

public TreeSetModelEvent(IlvTreeSetModel source,
                         TreeSetModelEvent.Type type,
                         int column,
                         Object oldValue,
                         Object newValue)

Creates an event.

Parameters:

source - The model.

type - One of EMPTY_VALUE_CHANGED, ENUM_VALUES_CHANGED, MIN_VALUE_CHANGED, MAX_VALUE_CHANGED.

column - The affected column.

oldValue - The old value.

newValue - The new Value.

TreeSetModelEvent

public TreeSetModelEvent(IlvTreeSetModel source,
                         TreeSetModelEvent.Type type,
                         int column,
                         boolean oldValue,
                         boolean newValue)

Creates an event.

Parameters:

source - The model.

type - One of ENUMERATED_CHANGED.

column - The affected column.

oldValue - The old value.

newValue - The new Value.

Method Detail

getModel

public IlvTreeSetModel getModel()

Returns the model from which this event comes.

getType

public TreeSetModelEvent.Type getType()

Returns the event type.

getObject

public Object getObject()

Returns the affected object. Assumes the event type is one of DATA_CHANGED, BEFORE_DATA_CHANGE.

getObjectPath

public TreePath getObjectPath()

Returns the path from the root to the affected object. Assumes the event type is one of DATA_CHANGED, BEFORE_DATA_CHANGE.

isRecursive

public boolean isRecursive()

Returns true if the entire subtree is affected, not just a single object. Assumes the event type is one of DATA_CHANGED, BEFORE_DATA_CHANGE.

getParent

public Object getParent()

Returns the parent object of the roots of the affected subtrees, or null for a root change. Assumes the event type is one of OBJECTS_ADDED, OBJECTS_REMOVED, BEFORE_OBJECTS_REMOVED, DURING_OBJECTS_REMOVED.

getParentPath

public TreePath getParentPath()

Returns the path from the root to the parent object of the roots of the affected subtrees, or null for a root change. Assumes the event type is one of OBJECTS_ADDED, OBJECTS_REMOVED, BEFORE_OBJECTS_REMOVED, DURING_OBJECTS_REMOVED.

getObjects

public Object[] getObjects()

Returns the roots of the affected subtrees. Assumes the event type is one of OBJECTS_ADDED, OBJECTS_REMOVED, BEFORE_OBJECTS_REMOVED, DURING_OBJECTS_REMOVED.

getColumn

public int getColumn()

Returns the index of the affected column, or -1 for all columns. Assumes the event type is one of DATA_CHANGED, BEFORE_DATA_CHANGE, COLUMN_ADDED, COLUMN_REMOVED, BEFORE_COLUMN_REMOVED, EMPTY_VALUE_CHANGED, ENUMERATED_CHANGED, ENUM_VALUES_CHANGED, MIN_VALUE_CHANGED, MAX_VALUE_CHANGED.

getColumnInfo

public IlvDataColumnInfo getColumnInfo()

Returns the meta information of the affected column, or null for all columns. Assumes the event type is one of DATA_CHANGED, BEFORE_DATA_CHANGE, COLUMN_ADDED, COLUMN_REMOVED, BEFORE_COLUMN_REMOVED, EMPTY_VALUE_CHANGED, ENUMERATED_CHANGED, ENUM_VALUES_CHANGED, MIN_VALUE_CHANGED, MAX_VALUE_CHANGED.

getOldValue

public Object getOldValue()

Returns the old value inside the IlvDataColumnInfo. Assumes the event type is one of EMPTY_VALUE_CHANGED, ENUMERATED_CHANGED, ENUM_VALUES_CHANGED, MIN_VALUE_CHANGED, MAX_VALUE_CHANGED.

getNewValue

public Object getNewValue()

Returns the new value inside the IlvDataColumnInfo. Assumes the event type is one of EMPTY_VALUE_CHANGED, ENUMERATED_CHANGED, ENUM_VALUES_CHANGED, MIN_VALUE_CHANGED, MAX_VALUE_CHANGED.

toString

public String toString()

Returns a String representation of this event.

Overrides:

toString in class EventObject