ilog.views.gantt.util.event

Class IlvPropertyEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.util.event.IlvPropertyEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ActivityPropertyEvent, ConstraintPropertyEvent, GanttModelChangedEvent, GanttModelPropertyEvent, ReservationPropertyEvent, ResourcePropertyEvent

public abstract class IlvPropertyEvent
extends EventObject

IlvPropertyEvent is an abstract class that can be used to represent both aboutToChange and changed events for arbitrary object properties. Basic support is provided for storing the property old and new values, along with veto capabilities for aboutToChange events. Concrete subclasses should provide typesafe accessors for the property values. For example:

  class FooEvent extends IlvPropertyEvent
  {
    public FooEvent(Object source, Foo oldVal, Foo newVal, boolean aboutToChangeEvent)
    {
      super(source, oldVal, newVal, aboutToChangeEvent);
    }

    public Foo getOldFoo()
    {
      return (Foo)getOldValue();
    }

    public Foo getNewFoo()
    {
      return (Foo)getNewValue();
    }

    public void setNewFoo(Foo newVal)
    {
      setNewValue(newVal);
    }
  }
 

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
IlvPropertyEvent(Object source, Object oldValue, Object newValue, boolean aboutToChangeEvent) Creates a new IlvPropertyEvent generated by the specified source object.

Method Summary

Modifier and Type	Method and Description
protected Object	getNewValue() Returns the new value of the property.
protected Object	getOldValue() Returns the old value of the property.
boolean	isAboutToChangeEvent() Returns whether this is a property aboutToChange event.
boolean	isChangedEvent() Returns whether this is a property changed event.
boolean	isVetoed() Returns whether the property aboutToChange event has been vetoed.
protected void	setNewValue(Object newValue) Sets the proposed new value of the property.
void	veto() Vetoes the property aboutToChange event.

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

Constructor Detail

IlvPropertyEvent

public IlvPropertyEvent(Object source,
                        Object oldValue,
                        Object newValue,
                        boolean aboutToChangeEvent)

Creates a new IlvPropertyEvent generated by the specified source object.

Parameters:

source - Where the event originated.

oldValue - The previous value of the property.

newValue - The new value of the property.

aboutToChangeEvent - true if this is a property aboutToChange event or false if this is a property changed event.

Method Detail

getOldValue

protected Object getOldValue()

Returns the old value of the property. If this is a property aboutToChange event, then this will be the same as the current value of the property since the change has not actually occurred yet. If this is a property changed event, this will be the property value prior to the current modification being reported.

getNewValue

protected Object getNewValue()

Returns the new value of the property. If this is a property aboutToChange event, then this will be the proposed value of the property. If this is a property changed event, this will be the new value of the property which is being reported.

setNewValue

protected void setNewValue(Object newValue)

Sets the proposed new value of the property. This method has meaning only if this is a property aboutToChange event.

Parameters:

newValue - The new value of the property.

isAboutToChangeEvent

public final boolean isAboutToChangeEvent()

Returns whether this is a property aboutToChange event.

isChangedEvent

public final boolean isChangedEvent()

Returns whether this is a property changed event.

isVetoed

public boolean isVetoed()

Returns whether the property aboutToChange event has been vetoed. This will be true if the event was explicitly vetoed via veto or the proposed new value of the property has been constrained to equal its previous value.

See Also:

veto()

veto

public void veto()

Vetoes the property aboutToChange event.