ilog.views.hypergraph.edgeconnector

Class IlvHyperEdgePinConnectorEdition

java.lang.Object

ilog.views.IlvObjectInteractor

ilog.views.hypergraph.edgeconnector.IlvHyperEdgePinConnectorEdition

All Implemented Interfaces:

Serializable

public class IlvHyperEdgePinConnectorEdition
extends IlvObjectInteractor

An object interactor used to edit objects of class IlvHyperEdgePinConnector. The interactor allows you to select individual pins and to move them along the border of the related object.

Since:

JViews 8.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvHyperEdgePinConnectorEdition() Creates the interactor.

Method Summary

Modifier and Type	Method and Description
Cursor	getDragCursor() Returns the cursor used for dragging.
Cursor	getPinCursor() Returns the cursor used when the pointer is on a pin but not dragging.
protected boolean	handleButtonDown(IlvHyperEdgePinConnectorSelection s, MouseEvent event, IlvObjectInteractorContext context) Handles MOUSE_PRESSED events.
protected boolean	handleButtonDragged(IlvHyperEdgePinConnectorSelection s, MouseEvent event, IlvObjectInteractorContext context) Handles MOUSE_DRAGGED events.
protected boolean	handleButtonUp(IlvHyperEdgePinConnectorSelection s, MouseEvent event, IlvObjectInteractorContext context) Handles MOUSE_RELEASED events.
static boolean	isPinDraggingAllowed() Returns whether it is allowed to drag a selected pin.
static boolean	isPinDraggingRestrictedToNodeBorder() Returns whether the movement of pins is restricted so that pins always stay at the border of the node.
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	setDragCursor(Cursor cursor) Sets the cursor used for dragging.
void	setPinCursor(Cursor cursor) Sets the cursor used when the pointer is on a pin but not dragging.
static void	setPinDraggingAllowed(boolean flag) Sets whether it is allowed to drag a selected pin.
static void	setPinDraggingRestrictedToNodeBorder(boolean flag) Allows to restrict the movement of pins so that pins always stay at the border of the node.

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

IlvHyperEdgePinConnectorEdition

public IlvHyperEdgePinConnectorEdition()

Creates 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.

getPinCursor

public Cursor getPinCursor()

Returns the cursor used when the pointer is on a pin but not dragging.

setPinCursor

public void setPinCursor(Cursor cursor)

Sets the cursor used when the pointer is on a pin 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.

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.edgeconnector.IlvHyperEdgePinConnectorSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext), handleButtonUp(ilog.views.hypergraph.edgeconnector.IlvHyperEdgePinConnectorSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext), handleButtonDragged(ilog.views.hypergraph.edgeconnector.IlvHyperEdgePinConnectorSelection, java.awt.event.MouseEvent, ilog.views.IlvObjectInteractorContext)

handleButtonDown

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

Handles MOUSE_PRESSED events.

Returns:

true if the event has been processed, false otherwise.

handleButtonDragged

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

Handles MOUSE_DRAGGED events.

Returns:

true if the event has been processed, false otherwise.

handleButtonUp

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

Handles MOUSE_RELEASED events.

Returns:

true if the event has been processed, false otherwise.

setPinDraggingRestrictedToNodeBorder

public static void setPinDraggingRestrictedToNodeBorder(boolean flag)

Allows to restrict the movement of pins so that pins always stay at the border of the node. If unrestricted, it is also possible to move the pin to the inner or outside of the bounding box of the node.

See Also:

isPinDraggingRestrictedToNodeBorder()

isPinDraggingRestrictedToNodeBorder

public static boolean isPinDraggingRestrictedToNodeBorder()

Returns whether the movement of pins is restricted so that pins always stay at the border of the node. This is disabled by default.

See Also:

setPinDraggingRestrictedToNodeBorder(boolean)

setPinDraggingAllowed

public static void setPinDraggingAllowed(boolean flag)

Sets whether it is allowed to drag a selected pin. This does not influence whether pin dragging is allowed by the IlvMakeHyperEdgePinConnectorInteractor, but only whether pin dragging is allowed while the normal select interactor is used.

See Also:

isPinDraggingAllowed()

isPinDraggingAllowed

public static boolean isPinDraggingAllowed()

Returns whether it is allowed to drag a selected pin. This is enabled by default.

See Also:

setPinDraggingAllowed(boolean)

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)