ilog.views.event

Class GraphicBagHierarchyEvent

java.lang.Object

java.util.EventObject

ilog.views.event.GraphicBagHierarchyEvent

All Implemented Interfaces:

Serializable

public class GraphicBagHierarchyEvent
extends EventObject

A GraphicBagHierarchyEvent event is fired when the hierarchy of graphic bags changes. This event is generated by a graphic bag (manager or graphic set) when the graphic bag is added to or removed from another graphic bag, and passed down the hierarchy. The event is dispatched to every IlvManager IlvGraphicBag and IlvGraphicHandleBag that is contained in the graphic bag whose own bag has changed.

Note: not all graphic bags support GraphicBagHierarchyEvent. Graphic bags that cannot be contained in other graphic bags don't need to support this event. Only IlvManager, IlvGraphicBag and IlvGraphicHandleBag support this event, that is, they are able to fire the event and also able to receive the event.

Since:

JViews 8.1

See Also:

GraphicBagHierarchyListener, IlvGraphicBag.addObject(ilog.views.IlvGraphic, boolean), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
GraphicBagHierarchyEvent(IlvGraphicBag bag, IlvGraphicBag oldRootBag, IlvGraphicBag newRootBag) Creates the event.

Method Summary

Modifier and Type	Method and Description
IlvGraphicBag	getGraphicBag() Returns the source of the event.
IlvGraphicBag	getNewRootBag() Returns the new root of the hierarchy after the change happened.
IlvGraphicBag	getOldRootBag() Returns the old root of the hierarchy before the change happened.

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

GraphicBagHierarchyEvent

public GraphicBagHierarchyEvent(IlvGraphicBag bag,
                                IlvGraphicBag oldRootBag,
                                IlvGraphicBag newRootBag)

Creates the event.

Parameters:

bag - The source of the event. This is the graphic bag whose graphic bag has changed.

oldRootBag - The old root bag before the change happened.

newRootBag - The new root bag after the change happened.

Method Detail

getGraphicBag

public IlvGraphicBag getGraphicBag()

Returns the source of the event. This is the graphic bag whose graphic bag has changed.

getOldRootBag

public IlvGraphicBag getOldRootBag()

Returns the old root of the hierarchy before the change happened.

getNewRootBag

public IlvGraphicBag getNewRootBag()

Returns the new root of the hierarchy after the change happened.