ilog.views.graphic

Class IlvDoubleGraphicHandleBag

java.lang.Object

ilog.views.IlvGraphic

ilog.views.IlvBidiGraphic

ilog.views.graphic.IlvDoubleGraphicHandleBag

All Implemented Interfaces:

GraphicBagHierarchyEventReceiver, ManagerViewsHierarchyEventReceiver, IlvGraphicBag, IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable

Direct Known Subclasses:

IlvAnchoredLabel, IlvSubGraphRenderer.CollapsedGraphic

public class IlvDoubleGraphicHandleBag
extends IlvBidiGraphic
implements IlvGraphicBag, GraphicBagHierarchyEventReceiver, ManagerViewsHierarchyEventReceiver

An IlvDoubleGraphicHandleBag object is a graphic bag that contains two contained objects. This means, the method IlvGraphic.getGraphicBag() applied on the referenced objects returns the handle. You can consider it as graphic set that contains only two elements.

Since:

JViews 8.8

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static short	MAX_FLAG The maximal used bit flag.

Constructor Summary

Constructors

Modifier	Constructor and Description
	IlvDoubleGraphicHandleBag(IlvDoubleGraphicHandleBag source) Creates a new IlvDoubleGraphicHandleBag by copying an existing one.
	IlvDoubleGraphicHandleBag(IlvGraphic object1, IlvGraphic object2) Creates a new IlvDoubleGraphicHandleBag.
protected	IlvDoubleGraphicHandleBag(IlvGraphic object1, IlvGraphic object2, boolean delegateMoveResize) Creates a new IlvDoubleGraphicHandleBag.
	IlvDoubleGraphicHandleBag(IlvInputStream stream) Reads the object from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
void	addGraphicBagHierarchyListener(GraphicBagHierarchyListener listener) Adds the specified listener to receive events from the ancestor managers and ancestor graphic sets and from this handle when the hierarchy of graphic bags has changed.
void	addManagerViewsHierarchyListener(ManagerViewsChangedListener listener) Adds the specified listener to receive events from the owning manager of this object and from its ancestors when a manager view was added or removed.
void	addObject(IlvGraphic graphic, boolean redraw) Adds a graphic object to the bag.
void	applyToObject(IlvGraphic graphic, IlvApplyObject f, Object arg, boolean redraw) Applies a method to a graphic object of the bag.
void	applyTransform(IlvTransformer t) Applies a transformation to the shape of the object.
IlvRect	boundingBox(IlvTransformer t) Returns the bounding rectangle of the object.
boolean	contains(IlvPoint p, IlvPoint tp, IlvTransformer t) Tests whether a point lies within the outline of the object.
IlvGraphic	copy() Copies the object.
void	draw(Graphics dst, IlvTransformer t) Draws the object.
void	enableGraphicBagHierarchyEventForwarding() Enables forwarding of GraphicBagHierarchyEvent events, since the objects contained in this graphic handle bag need to receive the events.
void	enableManagerViewsHierarchyEventForwarding() Enables forwarding of ManagerViewsChangedEvent events through the nesting hierarchy, since the objects contained in this graphic handle bag need to receive the events.
void	fireGraphicBagHierarchyEvent(GraphicBagHierarchyEvent event) Fires a graphic bag hierarchy event to this graphic handle bag and all contained objects.
void	fireManagerViewsHierarchyEvent(ManagerViewsChangedEvent event) Fires a ManagerViewsChangedEvent event to all listeners installed via addManagerViewsHierarchyListener(ilog.views.event.ManagerViewsChangedListener) on this graphic set or contained objects.
IlvPoint	getIntersectionWithOutline(IlvPoint innerPoint, IlvPoint outerPoint, IlvTransformer t) Returns the intersection of the line segment from inner point to outer point with the shape of the graphic object.
IlvGraphic	getObject(String name) Returns the graphic object with that name if it exists in the bag, otherwise returns null.
IlvGraphic	getObject1() Returns the first referenced object.
IlvGraphic	getObject2() Returns the second referenced object.
IlvGraphicEnumeration	getObjects() Returns the objects of the bag.
protected JPopupMenu	getOriginalPopupMenu(IlvPoint p, IlvTransformer t, IlvManagerView view, IlvPopupMenuManager popupManager) This is the original implementation of getPopupMenu from the superclass to retrieve the pop-up menu.
JPopupMenu	getPopupMenu(IlvPoint p, IlvTransformer t, IlvManagerView view, IlvPopupMenuManager popupManager) Returns the Swing pop-up menu to display when the pop-up is triggered while the mouse pointer is at a specified location inside the graphic object.
String	getToolTipText(IlvPoint p, IlvTransformer t) Returns the tooltip text to display when the mouse pointer is at a specified location inside the graphic object.
boolean	inside(IlvRect rect, IlvRect trect, IlvTransformer t) Tests whether a rectangle contains the object.
boolean	intersects(IlvRect rect, IlvRect trect, IlvTransformer t) Tests whether a rectangle overlaps the object.
protected boolean	isFlagSet(short mask) Returns true if a flag is set.
boolean	isPersistent() If this method returns true the IlvGraphic instance will be saved in IVL files.
void	move(double x, double y) Moves the object.
void	move(IlvPoint p) Moves the object.
void	moveObject(IlvGraphic graphic, double x, double y, boolean redraw) Changes the location of a graphic object.
boolean	needsGraphicBagHierarchyEvent() Returns whether this object needs to receive GraphicBagHierarchyEvent events, either from itself or from its ancestors.
boolean	needsManagerViewsHierarchyEvent() Returns whether the graphic handle bag needs to receive ManagerViewsChangedEvent events, either from its owning manager or from its ancestors.
protected String	object1Name() Returns the name of the first object in the IVL file.
protected String	object2Name() Returns the name of the second object in the IVL file.
void	reDrawObj(IlvGraphic graphic) Redraws a graphic object located in the bag.
void	reDrawRegion(IlvRegion region) Redraws a region of the bag.
void	removeGraphicBagHierarchyListener(GraphicBagHierarchyListener listener) Removes the specified listener so that it no longer receives events from ancestor manager and ancestor graphic sets and from this handle when the hierarchy of graphic bags has changed.
void	removeManagerViewsHierarchyListener(ManagerViewsChangedListener listener) Removes the specified listener so that it no longer receives events from the owning manager of this object and from its ancestors when a manager view was added or removed.
void	removeObject(IlvGraphic graphic, boolean redraw) Removes a graphic object from the bag.
void	reshapeObject(IlvGraphic graphic, IlvRect newrect, boolean redraw) Changes the size of a graphic object.
protected void	setDelegateMoveResize(boolean delegateMoveResize) Sets whether operations that change the position of the object are directly delegated to both referenced objects.
protected void	setFlag(short mask, boolean value) Sets a flag.
void	setGraphicBag(IlvGraphicBag bag) Changes the bag that contains the object.
void	setObject1(IlvGraphic object) Changes the first referenced object.
void	setObject2(IlvGraphic object) Changes the second referenced object.
boolean	setObjectName(IlvGraphic graphic, String name) Changes the name of a graphic object.
void	translate(double dx, double dy) Translates the object.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.
boolean	zoomable() Returns true if the object is zoomable.

Methods inherited from class ilog.views.IlvBidiGraphic

calcResolvedBaseTextDirection, getBaseTextDirection, getComponentOrientation, getResolvedBaseTextDirection, getULocale, invalidateBidiCache, setBaseTextDirection, setBaseTextDirection, setBaseTextDirectionDuringConstruction

Methods inherited from class ilog.views.IlvGraphic

addActionListener, addNamedPropertyListener, allViewsRemoved, baseTextDirectionChanged, blinkingStateOn, boundingBox, callDraw, componentOrientationChanged, getAndAssociateObjectInteractor, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getDefaultInteractor, getGraphicBag, GetGraphicObject, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenuName, getProperty, getToolTipBaseTextDirection, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getZOrderIndex, hasProperty, invalidateBBoxCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isSelectable, isVisible, localeChanged, makeSelection, moveResize, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBackground, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setFillOn, setForeground, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.views.IlvGraphicBag

getGraphicBag

Field Detail

MAX_FLAG

protected static final short MAX_FLAG

The maximal used bit flag. Subclasses can use further flags.

See Also:

setFlag(short, boolean), Constant Field Values

Constructor Detail

IlvDoubleGraphicHandleBag

public IlvDoubleGraphicHandleBag(IlvGraphic object1,
                                 IlvGraphic object2)

Creates a new IlvDoubleGraphicHandleBag.

Parameters:

object1 - The first referenced object.

object2 - The second referenced object.

IlvDoubleGraphicHandleBag

protected IlvDoubleGraphicHandleBag(IlvGraphic object1,
                                    IlvGraphic object2,
                                    boolean delegateMoveResize)

Creates a new IlvDoubleGraphicHandleBag. This constructor is mainly useful when creating subclasses of this class.

Parameters:

object1 - The first referenced object.

object2 - The second referenced object.

delegateMoveResize - If true, operations that change the position of the object are directly delegated to both referenced objects.

IlvDoubleGraphicHandleBag

public IlvDoubleGraphicHandleBag(IlvDoubleGraphicHandleBag source)

Creates a new IlvDoubleGraphicHandleBag by copying an existing one.

IlvDoubleGraphicHandleBag

public IlvDoubleGraphicHandleBag(IlvInputStream stream)
                          throws IlvReadFileException

Reads the object from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Method Detail

getObject1

public final IlvGraphic getObject1()

Returns the first referenced object.

setObject1

public void setObject1(IlvGraphic object)

Changes the first referenced object. Note that a call to this method can modify the bounding box of the graphic handle. For this reason, if the graphic handle is contained inside an IlvManager, this method can be called only using the method IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean) of the manager.

getObject2

public final IlvGraphic getObject2()

Returns the second referenced object.

setObject2

public void setObject2(IlvGraphic object)

Changes the second referenced object. Note that a call to this method can modify the bounding box of the graphic handle. For this reason, if the graphic handle is contained inside an IlvManager, this method can be called only using the method IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean) of the manager.

setDelegateMoveResize

protected void setDelegateMoveResize(boolean delegateMoveResize)

Sets whether operations that change the position of the object are directly delegated to both referenced objects.

copy

public IlvGraphic copy()

Copies the object. May return null if the contained object cannot be copied.

Specified by:

copy in class IlvGraphic

Returns:

A copy of the object.

See Also:

IlvGraphic

zoomable

public boolean zoomable()

Returns true if the object is zoomable. Otherwise, it returns false. Calls zoomable on the referenced objects.

Overrides:

zoomable in class IlvGraphic

See Also:

IlvGraphic, IlvGraphic.draw(java.awt.Graphics, ilog.views.IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvManager

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvGraphic

Parameters:

stream - the output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

object1Name

protected String object1Name()

Returns the name of the first object in the IVL file.

object2Name

protected String object2Name()

Returns the name of the second object in the IVL file.

setGraphicBag

public void setGraphicBag(IlvGraphicBag bag)

Changes the bag that contains the object.

Note: do not call this method directly unless you are creating a custom graphic bag.

Overrides:

setGraphicBag in class IlvGraphic

Parameters:

bag - The graphic bag to contain this graphic object.

See Also:

IlvGraphic

draw

public void draw(Graphics dst,
                 IlvTransformer t)

Draws the object. Calls draw on the referenced objects.

Specified by:

draw in class IlvGraphic

Parameters:

dst - the destination Graphics.

t - the transformation used to draw the object.

See Also:

IlvGraphic.callDraw(Graphics,IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvGraphic.zoomable(), IlvGraphic

boundingBox

public IlvRect boundingBox(IlvTransformer t)

Returns the bounding rectangle of the object. Calls boundingBox on the referenced objects.

Specified by:

boundingBox in class IlvGraphic

Parameters:

t - the transformer used to draw the object.

See Also:

IlvGraphic.draw(java.awt.Graphics, ilog.views.IlvTransformer), IlvGraphic.zoomable(), IlvGraphic

applyTransform

public void applyTransform(IlvTransformer t)

Applies a transformation to the shape of the object. Calls applyTransform on the referenced objects.

Specified by:

applyTransform in class IlvGraphic

Parameters:

t - the transformer to be applied.

See Also:

IlvGraphic

contains

public boolean contains(IlvPoint p,
                        IlvPoint tp,
                        IlvTransformer t)

Tests whether a point lies within the outline of the object. Calls contains on the referenced objects.

Overrides:

contains in class IlvGraphic

Parameters:

p - the point to be tested.

tp - the point p transformed by the transformer t.

t - the transformation applied to the object when it was drawn.

Returns:

true if the point lies inside this graphic object.

See Also:

IlvGraphic

intersects

public boolean intersects(IlvRect rect,
                          IlvRect trect,
                          IlvTransformer t)

Tests whether a rectangle overlaps the object. Calls intersects on the referenced objects.

Overrides:

intersects in class IlvGraphic

Parameters:

rect - the rectangle to be tested.

trect - the rectangle rect transformed by the transformer t.

t - the transformation that was applied to the object when it was drawn.

Returns:

true if the rectangle overlaps this graphic object.

See Also:

IlvGraphic

inside

public boolean inside(IlvRect rect,
                      IlvRect trect,
                      IlvTransformer t)

Tests whether a rectangle contains the object. Calls inside on the referenced objects.

Overrides:

inside in class IlvGraphic

Parameters:

rect - the rectangle to be tested.

trect - the rectangle rect transformed by the transformer t.

t - the transformation that was applied to the object when it was drawn.

See Also:

IlvGraphic

getIntersectionWithOutline

public IlvPoint getIntersectionWithOutline(IlvPoint innerPoint,
                                           IlvPoint outerPoint,
                                           IlvTransformer t)

Returns the intersection of the line segment from inner point to outer point with the shape of the graphic object. This method is used to clip links against the shape of the node. The implementation of this method must be robust with respect to the input points: Even if innerPoint is not inside the graphic object, or if outerPoint is not outside the graphic object, it must return a valid point. For instance, if there is no intersection, it can return the start point.

Overrides:

getIntersectionWithOutline in class IlvGraphic

Parameters:

innerPoint - A point usually inside the graphic object, given in manager view coordinates.

outerPoint - A point usually outside of the graphic object, given in manager view coordinates.

t - The transformation used to draw the object.

See Also:

IlvClippingLinkConnector

move

public void move(double x,
                 double y)

Moves the object. Delegates move to the referenced objects.

Overrides:

move in class IlvGraphic

Parameters:

x - The new horizontal position.

y - The new vertical position.

See Also:

IlvGraphic, IlvGraphic.applyTransform(IlvTransformer)

move

public void move(IlvPoint p)

Moves the object. Delegates move to the referenced objects.

Overrides:

move in class IlvGraphic

Parameters:

p - The new position of the top-left corner.

See Also:

IlvGraphic, IlvGraphic.applyTransform(IlvTransformer)

translate

public void translate(double dx,
                      double dy)

Translates the object. Delegates translate to the referenced objects.

Overrides:

translate in class IlvGraphic

Parameters:

dx - The horizontal translation factor.

dy - The vertical translation factor.

See Also:

IlvGraphic, IlvGraphic.applyTransform(IlvTransformer)

isPersistent

public boolean isPersistent()

If this method returns true the IlvGraphic instance will be saved in IVL files. The method returns true if all subobjects are persistent.

Overrides:

isPersistent in class IlvGraphic

getToolTipText

public String getToolTipText(IlvPoint p,
                             IlvTransformer t)

Returns the tooltip text to display when the mouse pointer is at a specified location inside the graphic object. It tries to retrieve the tooltip text on the referenced objects. If this fails, it tries to retrieve the tooltip text on this object.

Note that you must enable the tooltip mechanism for the manager view by calling the static method IlvToolTipManager.registerView(ilog.views.IlvManagerView).

Overrides:

getToolTipText in class IlvGraphic

Parameters:

p - The location of the mouse (in view coordinates).

t - The transformer that converts the coordinate system of this object (the manager coordinates) into the coordinate system of the manager view in which the tooltip is about to be displayed (the view coordinates).

Returns:

The tooltip at point p for transformation t, or null if no tooltip should be displayed.

See Also:

IlvGraphic, IlvGraphic.getToolTipText(), IlvGraphic.setToolTipText(String)

getPopupMenu

public JPopupMenu getPopupMenu(IlvPoint p,
                               IlvTransformer t,
                               IlvManagerView view,
                               IlvPopupMenuManager popupManager)

Returns the Swing pop-up menu to display when the pop-up is triggered while the mouse pointer is at a specified location inside the graphic object. It tries to retrieve the pop-up menu on the referenced objects. If this fails, it tries to retrieve the pop-up menu on this object.

Note that you must enable the pop-up menu mechanism for the manager view by calling the static method IlvPopupMenuManager.registerView(ilog.views.IlvManagerView).

Overrides:

getPopupMenu in class IlvGraphic

Parameters:

p - The location of the mouse (in view coordinates).

t - The transformer that converts the coordinate system of this object (the manager coordinates) into the coordinate system of the manager view in which the tooltip is about to be displayed (the view coordinates).

view - The manager view that triggered the pop-up menu.

popupManager - The pop-up menu manager.

Returns:

The Swing pop-up menu, which can be null.

See Also:

IlvGraphic, IlvPopupMenuManager.registerView(ilog.views.IlvManagerView), IlvGraphic.getPopupMenu()

getOriginalPopupMenu

protected JPopupMenu getOriginalPopupMenu(IlvPoint p,
                                          IlvTransformer t,
                                          IlvManagerView view,
                                          IlvPopupMenuManager popupManager)

This is the original implementation of getPopupMenu from the superclass to retrieve the pop-up menu. Subclasses of this class might need access to the original implementation.

Parameters:

p - The location of the mouse (in view coordinates).

t - The transformer that converts the coordinate system of this object (the manager coordinates) into the coordinate system of the manager view in which the tooltip is about to be displayed (the view coordinates).

view - The manager view that triggered the pop-up menu.

popupManager - The pop-up menu manager.

Returns:

The Swing pop-up menu as retrieved by the superclass.

isFlagSet

protected final boolean isFlagSet(short mask)

Returns true if a flag is set. Subclasses can define some own flags by reusing the same storage.

See Also:

MAX_FLAG

setFlag

protected final void setFlag(short mask,
                             boolean value)

Sets a flag. Subclasses can define some own flags by reusing the same storage.

See Also:

MAX_FLAG

addObject

public void addObject(IlvGraphic graphic,
                      boolean redraw)

Adds a graphic object to the bag. This is part of the IlvGraphicBag interface. Do not use it for this object.

Specified by:

addObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

redraw - If true the object is redrawn.

removeObject

public void removeObject(IlvGraphic graphic,
                         boolean redraw)

Removes a graphic object from the bag. This is part of the IlvGraphicBag interface. Do not use it for this object.

Specified by:

removeObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

redraw - If true the object is redrawn.

getObjects

public IlvGraphicEnumeration getObjects()

Returns the objects of the bag. This is part of the IlvGraphicBag interface. This returns an enumeration with one object: the referenced object.

Specified by:

getObjects in interface IlvGraphicBag

Returns:

An enumeration of IlvGraphic objects, or null.

reDrawObj

public void reDrawObj(IlvGraphic graphic)

Redraws a graphic object located in the bag. This is part of the IlvGraphicBag interface. If this graphic handle bag is inside a graphic bag, it redraws this graphic handle bag.

Specified by:

reDrawObj in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

reDrawRegion

public void reDrawRegion(IlvRegion region)

Redraws a region of the bag. This is part of the IlvGraphicBag interface. If this graphic handle bag is inside a graphic bag, it redraws this graphic handle bag.

Specified by:

reDrawRegion in interface IlvGraphicBag

Parameters:

region - The region to redraw.

reshapeObject

public void reshapeObject(IlvGraphic graphic,
                          IlvRect newrect,
                          boolean redraw)

Changes the size of a graphic object. This is part of the IlvGraphicBag interface. Since the graphic handle bag can contain only one object, you can reshape only the currently referenced object.
If the graphic handle bag is in a graphic bag, it automatically calls applyToObject on its graphic bag while reshaping the object.

Specified by:

reshapeObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

newrect - The new desired bounding rectangle.

redraw - If true the object is redrawn.

moveObject

public void moveObject(IlvGraphic graphic,
                       double x,
                       double y,
                       boolean redraw)

Changes the location of a graphic object. This is part of the IlvGraphicBag interface. Since the graphic handle bag can contain only one object, you can move only the currently referenced object.
If the graphic handle bag is in a graphic bag, it automatically calls applyToObject on its graphic bag while moving the object.

Specified by:

moveObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

x - The new desired x position.

y - The new desired y position.

redraw - If true the object is redrawn.

applyToObject

public void applyToObject(IlvGraphic graphic,
                          IlvApplyObject f,
                          Object arg,
                          boolean redraw)

Applies a method to a graphic object of the bag. This is part of the IlvGraphicBag interface.

If the graphic handle bag is in a graphic bag, it automatically calls applyToObject on its graphic bag while applying the object.

Specified by:

applyToObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

f - The method to apply.

arg - The arguments passed to the method f.

redraw - If true the object is redrawn.

setObjectName

public boolean setObjectName(IlvGraphic graphic,
                             String name)

Changes the name of a graphic object. This is part of the IlvGraphicBag interface. Since the graphic handle bag can contain only one object, you can only change the name of the currently referenced object.

Specified by:

setObjectName in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

name - The new name.

Returns:

true if the name can be changed.

getObject

public IlvGraphic getObject(String name)

Returns the graphic object with that name if it exists in the bag, otherwise returns null. Since the graphic handle bag can contain only one object, it returns currently referenced object if this matches the input name, and null otherwise.

Specified by:

getObject in interface IlvGraphicBag

Parameters:

name - The graphic object name.

addGraphicBagHierarchyListener

public void addGraphicBagHierarchyListener(GraphicBagHierarchyListener listener)

Adds the specified listener to receive events from the ancestor managers and ancestor graphic sets and from this handle when the hierarchy of graphic bags has changed. The hierarchy event is generated by a manager, a graphic set, or a graphic handle bag when it is added to or removed from another manager, graphic set, or handle bag. The event is passed down the hierarchy. The event is dispatched to every graphic handle bag that is contained in object (manager, graphic set, handle bag) whose graphic bag has changed.

Specified by:

addGraphicBagHierarchyListener in interface GraphicBagHierarchyEventReceiver

Parameters:

listener - The listener.

See Also:

removeGraphicBagHierarchyListener(ilog.views.event.GraphicBagHierarchyListener)

removeGraphicBagHierarchyListener

public void removeGraphicBagHierarchyListener(GraphicBagHierarchyListener listener)

Removes the specified listener so that it no longer receives events from ancestor manager and ancestor graphic sets and from this handle when the hierarchy of graphic bags has changed.

Specified by:

removeGraphicBagHierarchyListener in interface GraphicBagHierarchyEventReceiver

Parameters:

listener - The listener.

See Also:

addGraphicBagHierarchyListener(ilog.views.event.GraphicBagHierarchyListener)

enableGraphicBagHierarchyEventForwarding

public void enableGraphicBagHierarchyEventForwarding()

Enables forwarding of GraphicBagHierarchyEvent events, since the objects contained in this graphic handle bag need to receive the events.

Specified by:

enableGraphicBagHierarchyEventForwarding in interface GraphicBagHierarchyEventReceiver

needsGraphicBagHierarchyEvent

public boolean needsGraphicBagHierarchyEvent()

Returns whether this object needs to receive GraphicBagHierarchyEvent events, either from itself or from its ancestors.

Specified by:

needsGraphicBagHierarchyEvent in interface GraphicBagHierarchyEventReceiver

fireGraphicBagHierarchyEvent

public void fireGraphicBagHierarchyEvent(GraphicBagHierarchyEvent event)

Fires a graphic bag hierarchy event to this graphic handle bag and all contained objects.

Specified by:

fireGraphicBagHierarchyEvent in interface GraphicBagHierarchyEventReceiver

addManagerViewsHierarchyListener

public void addManagerViewsHierarchyListener(ManagerViewsChangedListener listener)

Adds the specified listener to receive events from the owning manager of this object and from its ancestors when a manager view was added or removed.

The hierarchy event mechanism is comparable to java.awt.event.HierarchyEvent on swing components. The view changed event is generated by a manager when a view is added or removed, and passed down the nesting hierarchy. The event is dispatched to every graphic handle bag that is contained in the manager whose view has changed.

Specified by:

addManagerViewsHierarchyListener in interface ManagerViewsHierarchyEventReceiver

Parameters:

listener - The listener.

See Also:

removeManagerViewsHierarchyListener(ilog.views.event.ManagerViewsChangedListener)

removeManagerViewsHierarchyListener

public void removeManagerViewsHierarchyListener(ManagerViewsChangedListener listener)

Removes the specified listener so that it no longer receives events from the owning manager of this object and from its ancestors when a manager view was added or removed.

Specified by:

removeManagerViewsHierarchyListener in interface ManagerViewsHierarchyEventReceiver

Parameters:

listener - The listener.

See Also:

addManagerViewsHierarchyListener(ilog.views.event.ManagerViewsChangedListener)

enableManagerViewsHierarchyEventForwarding

public void enableManagerViewsHierarchyEventForwarding()

Enables forwarding of ManagerViewsChangedEvent events through the nesting hierarchy, since the objects contained in this graphic handle bag need to receive the events.

Specified by:

enableManagerViewsHierarchyEventForwarding in interface ManagerViewsHierarchyEventReceiver

needsManagerViewsHierarchyEvent

public boolean needsManagerViewsHierarchyEvent()

Returns whether the graphic handle bag needs to receive ManagerViewsChangedEvent events, either from its owning manager or from its ancestors. It returns true, if a listener was installed through addManagerViewsHierarchyListener(ilog.views.event.ManagerViewsChangedListener) on this graphic handle bag or on any object contained in this graphic handle bag.

Specified by:

needsManagerViewsHierarchyEvent in interface ManagerViewsHierarchyEventReceiver

fireManagerViewsHierarchyEvent

public void fireManagerViewsHierarchyEvent(ManagerViewsChangedEvent event)

Fires a ManagerViewsChangedEvent event to all listeners installed via addManagerViewsHierarchyListener(ilog.views.event.ManagerViewsChangedListener) on this graphic set or contained objects.

Specified by:

fireManagerViewsHierarchyEvent in interface ManagerViewsHierarchyEventReceiver