ilog.views.gantt.event

Class ResourceIDEvent

java.lang.Object

java.util.EventObject

ilog.views.gantt.util.event.IlvPropertyEvent

ilog.views.gantt.event.ResourcePropertyEvent

ilog.views.gantt.event.ResourceIDEvent

All Implemented Interfaces:

ResourceEvent, Serializable

public class ResourceIDEvent
extends ResourcePropertyEvent

ResourceIDEvent is fired by an IlvResource both before and after its id is modified. Immediately before its id is modified, an IlvResource fires an aboutToChange ResourceIDEvent in all listeners registered with the Gantt data model. Listeners can modify or constrain the proposed id by invoking setNewID(). Alternatively, a listener can veto the proposed change by invoking veto().

After its id is modified, an IlvResource will fire a changed ResourceIDEvent in all listeners registered with the Gantt data model. Listeners can access the old and new values of the resource's id, but cannot modify them via the event mechanism.

See Also:

IlvResource, IlvGanttModel.addResourceListener(ilog.views.gantt.event.ResourceListener), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ResourceIDEvent(IlvResource resource, String oldID, String newID, boolean aboutToChangeEvent) Constructs a new ResourceIDEvent generated by the specified resource and with the specified old and new id values.

Method Summary

Modifier and Type	Method and Description
String	getNewID() Returns the resource's new id.
String	getOldID() Returns the resource's old id.
void	setNewID(String id) Sets the resource's proposed new id.

Methods inherited from class ilog.views.gantt.event.ResourcePropertyEvent

getResource

Methods inherited from class ilog.views.gantt.util.event.IlvPropertyEvent

getNewValue, getOldValue, isAboutToChangeEvent, isChangedEvent, isVetoed, setNewValue, veto

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

ResourceIDEvent

public ResourceIDEvent(IlvResource resource,
                       String oldID,
                       String newID,
                       boolean aboutToChangeEvent)

Constructs a new ResourceIDEvent generated by the specified resource and with the specified old and new id values.

Parameters:

resource - the resource where the event originated

oldID - the resource's previous id

newID - the resource's new id

aboutToChangeEvent - true if this is a resourceIDAboutToChange event or false if this is a resourceIDChanged event.

Method Detail

getOldID

public String getOldID()

Returns the resource's old id. If this is a resourceIDAboutToChange event, then this will be the same as the resource's current id since the change has not actually occurred yet. If this is a resourceIDChanged event, this will be the resource's id prior to the current modification being reported.

Returns:

The String representing the old id.

getNewID

public String getNewID()

Returns the resource's new id. If this is a resourceIDAboutToChange event, then this is will be the resource's proposed value. If this is a resourceIDChanged event, this will be the resource's new id which is being reported.

Returns:

The String representing the new id.

setNewID

public void setNewID(String id)

Sets the resource's proposed new id. This method only has meaning if this is a resourceIDAboutToChange event. By using this method, a listener can constrain changes to the resource's id.

Parameters:

id - the resource's id