ilog.views.event

Class NamedPropertyEvent

java.lang.Object

java.util.EventObject

ilog.views.event.NamedPropertyEvent

All Implemented Interfaces:

Serializable

public final class NamedPropertyEvent
extends EventObject

An NamedPropertyEvent event is delivered to objects that are listening to additions and removals of named properties of a graphic object.

Since:

JViews 6.5

See Also:

NamedPropertyListener, IlvGraphic.setNamedProperty(ilog.views.IlvNamedProperty), IlvGraphic.removeNamedProperty(java.lang.String), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROPERTY_REMOVED The type of the event when a property is removed from the graphic object.
static int	PROPERTY_SET The type of the event when a property is set at the graphic object.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
NamedPropertyEvent(IlvGraphic obj, IlvNamedProperty oldValue, IlvNamedProperty newValue) Creates the event.

Method Summary

Modifier and Type	Method and Description
IlvGraphic	getGraphicObject() Returns the graphic object that caused the event.
IlvNamedProperty	getNewValue() Returns the new named property.
IlvNamedProperty	getOldValue() Returns the old named property.
String	getPropertyName() Returns the name of the named property that caused the event.
int	getType() Returns the type of the event.
void	setNewValue(IlvNamedProperty p) Changes the new named property.
void	setOldValue(IlvNamedProperty p) Changes the old named 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

PROPERTY_SET

public static final int PROPERTY_SET

The type of the event when a property is set at the graphic object.

See Also:

Constant Field Values

PROPERTY_REMOVED

public static final int PROPERTY_REMOVED

The type of the event when a property is removed from the graphic object.

See Also:

Constant Field Values

Constructor Detail

NamedPropertyEvent

public NamedPropertyEvent(IlvGraphic obj,
                          IlvNamedProperty oldValue,
                          IlvNamedProperty newValue)

Creates the event. Either the old value or the new value should not be null.

Parameters:

obj - The source of the event.

oldValue - The old named property.

newValue - The new named property.

Method Detail

getGraphicObject

public final IlvGraphic getGraphicObject()

Returns the graphic object that caused the event.

getType

public final int getType()

Returns the type of the event.

See Also:

PROPERTY_SET, PROPERTY_REMOVED

getPropertyName

public final String getPropertyName()

Returns the name of the named property that caused the event.

getOldValue

public final IlvNamedProperty getOldValue()

Returns the old named property. When setting a named property, this is the old value that was previously set, or null if the named property was previously not set. When removing a named property, this is the old value that was previously set.

See Also:

IlvGraphic.setNamedProperty(ilog.views.IlvNamedProperty), IlvGraphic.removeNamedProperty(java.lang.String)

setOldValue

public final void setOldValue(IlvNamedProperty p)

Changes the old named property. You should not call this method. This method is public for implementation purposes.

getNewValue

public final IlvNamedProperty getNewValue()

Returns the new named property. When setting a named property, this is the new value that is set. When removing a named property, this is null.

See Also:

IlvGraphic.setNamedProperty(ilog.views.IlvNamedProperty), IlvGraphic.removeNamedProperty(java.lang.String)

setNewValue

public final void setNewValue(IlvNamedProperty p)

Changes the new named property. You should not call this method. This method is public for implementation purposes.