ilog.views.hypergraph

Class IlvHyperEdgeEdition

java.lang.Object

ilog.views.IlvObjectInteractor

ilog.views.hypergraph.IlvHyperEdgeEdition

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvSegmentedHyperEdgeEdition

public class IlvHyperEdgeEdition
extends IlvObjectInteractor

An object interactor used to edit objects of class IlvHyperEdge. The interactor allows you to move the ends of the hyperedge or to remove ends of the hyperedge. While the edge is selected, the following operations are implemented:

• Drag an end point of the hyperedge to a new position. Press the control key to connect the hyperedge to the new position. If a hyperedge connector IlvHyperEdgeConnector controls the end point of the hyperedge, it snaps to the closest point allowed for this end by the hyperedge connector.
• Drag an end point of the hyperedge to a different node. Press the control key to connect the hyperedge to the node.
• Click on an end point while holding the shift and the control key removes the end from the hyperedge. Note that if the hyperedge would become less than the minimum required ends (see IlvHyperGrapher.getMinHyperEdgeEndCount()), then the end is not removed.

Since:

JViews 8.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvHyperEdgeEdition() Creates and initializes the interactor.

Method Summary

Modifier and Type	Method and Description
protected void	afterDrop(IlvHyperEdgeEnd end) Called after we have dropped a hyperedge end.
protected void	doRemoveEnd(IlvHyperEdgeSelection s, MouseEvent event, IlvObjectInteractorContext context) Removes an end of the hyperedge.
Cursor	getConnectionPointCursor() Returns the cursor when the mouse is on top of a connection point but not dragging.
Cursor	getDragCursor() Returns the cursor used for dragging.
protected boolean	handleButtonDown(IlvHyperEdgeSelection s, MouseEvent event, IlvObjectInteractorContext context) Handles MOUSE_PRESSED events.
protected boolean	handleButtonDragged(IlvHyperEdgeSelection s, MouseEvent event, IlvObjectInteractorContext context) Handles MOUSE_DRAGGED events.
protected boolean	handleButtonUp(IlvHyperEdgeSelection s, MouseEvent event, IlvObjectInteractorContext context) Handles MOUSE_RELEASED events.
protected boolean	handleMouseMoved(IlvHyperEdgeSelection obj, MouseEvent event, IlvObjectInteractorContext context) Handles MOUSE_MOVED events.
boolean	isDragEndAllowed(IlvHyperEdgeEnd end) Returns whether it is allowed to drag the hyperedge end.
static boolean	isDragging(IlvManager manager) Returns true if a segment of a hyperedge is currently dragged in the manager.
protected void	onDrag(IlvHyperEdgeEnd end) Called when we are about to drag a hyperedge end.
void	onEnter(IlvGraphic sel, IlvObjectInteractorContext context) Called when the selection is entered.
void	onExit(IlvGraphic sel, IlvObjectInteractorContext context) Called when the selection is exited.
boolean	processEvent(IlvGraphic obj, AWTEvent event, IlvObjectInteractorContext context) Processes the events.
void	setConnectionPointCursor(Cursor cursor) Sets the cursor when the mouse is on top of a connection point but not dragging.
void	setDragCursor(Cursor cursor) Sets the cursor used for dragging.
static void	setDragging(IlvManager manager, boolean flag) Sets whether a segment of a hyperedge is currently dragged in the manager.
protected boolean	triggerChangeConnectionPoint(IlvHyperEdgeSelection s, MouseEvent event, IlvObjectInteractorContext context) Returns true if the end point of the hyperedge is allowed to move while staying connected at the same node.
protected boolean	triggerChangeNode(IlvHyperEdgeSelection s, MouseEvent event, IlvObjectInteractorContext context) Returns true if the end point of the hyperedge should be connected to a different node than the current node.
protected boolean	triggerRemoveEnd(IlvHyperEdgeSelection s, MouseEvent event, IlvObjectInteractorContext context) Returns true if the end point of the hyperedge should be removed when clicking on the end point of the hyperedge.

Methods inherited from class ilog.views.IlvObjectInteractor

Get, handleExpose, Put

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvHyperEdgeEdition

public IlvHyperEdgeEdition()

Creates and initializes the interactor.

Method Detail

getDragCursor

public Cursor getDragCursor()

Returns the cursor used for dragging.

setDragCursor

public void setDragCursor(Cursor cursor)

Sets the cursor used for dragging.

getConnectionPointCursor

public Cursor getConnectionPointCursor()

Returns the cursor when the mouse is on top of a connection point but not dragging.

setConnectionPointCursor

public void setConnectionPointCursor(Cursor cursor)

Sets the cursor when the mouse is on top of a connection point but not dragging.

processEvent

public boolean processEvent(IlvGraphic obj,
                            AWTEvent event,
                            IlvObjectInteractorContext context)

Processes the events. The events are dispatched to the following methods depending on the type of the event: handleButtonDown for a MOUSE_PRESSED event, handleButtonUp for a MOUSE_RELEASED event, or handleButtonDragged for a MOUSE_DRAGGED event. handleMouseMoved for a MOUSE_MOVED event.

Specified by:

processEvent in class IlvObjectInteractor

Parameters:

obj - The graphic object.

event - The event to process.

context - The context in which the event occurred.

Returns:

true if the event was handled by this processEvent invocation, false otherwise.

See Also:

handleButtonDown(ilog.views.hypergraph.IlvHyperEdgeSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext), handleButtonUp(ilog.views.hypergraph.IlvHyperEdgeSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext), handleButtonDragged(ilog.views.hypergraph.IlvHyperEdgeSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext), handleMouseMoved(ilog.views.hypergraph.IlvHyperEdgeSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext)

handleButtonDown

protected boolean handleButtonDown(IlvHyperEdgeSelection s,
                                   MouseEvent event,
                                   IlvObjectInteractorContext context)

Handles MOUSE_PRESSED events.

Returns:

true if the event has been processed, false otherwise.

triggerRemoveEnd

protected boolean triggerRemoveEnd(IlvHyperEdgeSelection s,
                                   MouseEvent event,
                                   IlvObjectInteractorContext context)

Returns true if the end point of the hyperedge should be removed when clicking on the end point of the hyperedge. By default, it returns true if the control key and the shift key are pressed simultaneously.

See Also:

doRemoveEnd(ilog.views.hypergraph.IlvHyperEdgeSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext)

doRemoveEnd

protected void doRemoveEnd(IlvHyperEdgeSelection s,
                           MouseEvent event,
                           IlvObjectInteractorContext context)

Removes an end of the hyperedge.

See Also:

triggerRemoveEnd(ilog.views.hypergraph.IlvHyperEdgeSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext)

handleButtonDragged

protected boolean handleButtonDragged(IlvHyperEdgeSelection s,
                                      MouseEvent event,
                                      IlvObjectInteractorContext context)

Handles MOUSE_DRAGGED events.

Returns:

true if the event has been processed, false otherwise.

onDrag

protected void onDrag(IlvHyperEdgeEnd end)

Called when we are about to drag a hyperedge end.

Parameters:

end - The hyperedge end to be dragged.

handleButtonUp

protected boolean handleButtonUp(IlvHyperEdgeSelection s,
                                 MouseEvent event,
                                 IlvObjectInteractorContext context)

Handles MOUSE_RELEASED events.

Returns:

true if the event has been processed, false otherwise.

afterDrop

protected void afterDrop(IlvHyperEdgeEnd end)

Called after we have dropped a hyperedge end.

triggerChangeNode

protected boolean triggerChangeNode(IlvHyperEdgeSelection s,
                                    MouseEvent event,
                                    IlvObjectInteractorContext context)

Returns true if the end point of the hyperedge should be connected to a different node than the current node. By default, it returns true if the control key is pressed.

triggerChangeConnectionPoint

protected boolean triggerChangeConnectionPoint(IlvHyperEdgeSelection s,
                                               MouseEvent event,
                                               IlvObjectInteractorContext context)

Returns true if the end point of the hyperedge is allowed to move while staying connected at the same node. By default, it returns true if the control key is pressed.

handleMouseMoved

protected boolean handleMouseMoved(IlvHyperEdgeSelection obj,
                                   MouseEvent event,
                                   IlvObjectInteractorContext context)

Handles MOUSE_MOVED events.

Returns:

true if the event has been processed, false otherwise.

isDragEndAllowed

public boolean isDragEndAllowed(IlvHyperEdgeEnd end)

Returns whether it is allowed to drag the hyperedge end. This method can be overridden. The default implementation asks the hyperedge connector whether it is allowed to move connection points.

Parameters:

end - The hyperedge end to be dragged.

onEnter

public void onEnter(IlvGraphic sel,
                    IlvObjectInteractorContext context)

Called when the selection is entered. This is used if the object interactor is associated with a selection object (see IlvSelection.onEnter(ilog.views.IlvObjectInteractorContext)). The selection is entered if the select interactor moves the mouse over the selection so that mouse events are dispatched to the object interactor of this selection.

Overrides:

onEnter in class IlvObjectInteractor

Parameters:

sel - The selection object.

context - The context for the object interactor.

See Also:

IlvSelection.onEnter(ilog.views.IlvObjectInteractorContext)

onExit

public void onExit(IlvGraphic sel,
                   IlvObjectInteractorContext context)

Called when the selection is exited. This is used if the object interactor is associated with a selection object (see IlvSelection.onExit(ilog.views.IlvObjectInteractorContext)). The selection is exited if the select interactor moves the mouse to a blanc area of the view, or to another selection so that mouse events are not anymore dispatched to the object interactor of this selection.

Overrides:

onExit in class IlvObjectInteractor

Parameters:

sel - The selection object.

context - The context for the object interactor.

See Also:

IlvSelection.onExit(ilog.views.IlvObjectInteractorContext)

setDragging

public static void setDragging(IlvManager manager,
                               boolean flag)

Sets whether a segment of a hyperedge is currently dragged in the manager.

isDragging

public static boolean isDragging(IlvManager manager)

Returns true if a segment of a hyperedge is currently dragged in the manager.