ilog.views.hypergraph.interactor

Class IlvMakeHyperEdgePinConnectorInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.hypergraph.interactor.IlvMakeHyperEdgeBaseInteractor

ilog.views.hypergraph.interactor.IlvMakeHyperEdgePinConnectorInteractor

All Implemented Interfaces:

IlvPermanentInteractorInterface, Serializable

public class IlvMakeHyperEdgePinConnectorInteractor
extends IlvMakeHyperEdgeBaseInteractor

An interactor that allows to install an IlvHyperEdgePinConnector or add pins to it. It also allows to move the pins. This interactor must be attached to a view that is attached to an IlvHyperGrapher.

Clicking on the node border creates a new pin. If no hyperedge connector is yet installed at the node, it also installs the hyperedge connector. Clicking on an existing pin and dragging moves the pin (if the pin allows moving). This is actually the same as what the select interactor does via IlvHyperEdgePinConnectorEdition. Clicking on an existing pin while holding the shift and the control key simultaneously removes the pin.

More precisely: in order to create a pin, you move the mouse pointer over the node. This highlights (selects) the node. Then you move the mouse pointer to the border. You can even move the mouse slightly outside the bounding box of the node. The pin margin (see IlvMakeHyperEdgeBaseInteractor.setPinMargin(double)) specifies how much you can move the mouse outside the node. Then, a mouse click creates the pin. By default, the pin margin is 5 for this interactor.

Since:

JViews 8.0

See Also:

IlvHyperEdgePinConnector, IlvHyperGrapher, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvMakeHyperEdgePinConnectorInteractor() Creates a new interactor.

Method Summary

Modifier and Type	Method and Description
protected IlvHyperGrapherPin	createPin(IlvGraphic node, IlvPoint p) Creates a new hypergrapher pin.
Cursor	getBorderCursor() Returns the cursor when the mouse is on the border of a node.
int	getFixedPinLayer() Returns the layer of the pins of the newly created hyperedge connector if the pin layer mode is IlvHyperEdgeConnector.IN_FIXED_LAYER.
protected IlvHyperGrapherPin	getPin(IlvPoint p) Returns the pin at input position, or null if there is no pin at that position.
Color	getPinColor() Returns the color of the newly created pin when it is visible.
int	getPinDirection() Returns the direction into which the newly created pin connects to the hyperedge.
int	getPinLayerMode() Returns the pin layer mode of the newly created hyperedge pin connector.
double	getPinOffset() Returns the offset of the newly created pin from the border of the node.
Color	getPinSelectedColor() Returns the color of the newly created pin when it is selected.
double	getPinSize() Returns the pin size of the newly created pin.
protected void	highlightObject(IlvGraphic object) Highlight the input object.
boolean	isConnectionPointMoveAllowed() Returns whether the newly created hyperedge connector allows to move the hyperedge ends interactively when they are controlled by the connector.
boolean	isConnectorFullyZoomable() Returns whether the newly created hyperedge pin connector behaves fully zoomable.
protected boolean	isDragging(MouseEvent event) Returns true if the mouse event was dragging.
protected boolean	isNormalClick(MouseEvent event) Returns true if the mouse event was a normal click.
protected boolean	isNormalClickEnd(MouseEvent event) Returns true if the mouse event was a mouse up.
boolean	isPinAllowMultiConnection() Returns whether a newly created pin should multiple hyperedge ends to connect to the same pin.
boolean	isPinDraggingAllowed() Returns whether it is allowed to drag a selected pin.
boolean	isPinDraggingRestrictedToNodeBorder() Returns whether the movement of pins is restricted so that pins always stay at the border of the node.
boolean	isPinMovable() Returns whether a newly created pin should be movable.
boolean	isPinVisible() Returns whether a newly created pin should be visible.
protected boolean	isRemovePinClick(MouseEvent event) Returns true if the mouse event was a click on a pin in order to remove the pin.
protected void	processMouseEvent(MouseEvent event) Processes the mouse events.
protected void	processMouseMotionEvent(MouseEvent event) Processes the mouse moved and mouse dragged events.
protected void	react(IlvPoint p) Highlights or unhighlights the node under the specified point.
protected void	reInitialize() Reinitializes the interactor.
void	setBorderCursor(Cursor cursor) Changes the cursor when the mouse is on the border of a node.
void	setConnectionPointMoveAllowed(boolean allow) Sets whether the newly created hyperedge connector allows to move the hyperedge ends interactively when they are controlled by the connector.
void	setConnectorFullyZoomable(boolean enable) Sets whether the newly created hyperedge pin connector behaves fully zoomable.
void	setFixedPinLayer(int layer) Sets the layer of the pins of the newly created hyperedge connector if the pin layer mode is IlvHyperEdgeConnector.IN_FIXED_LAYER.
void	setPinAllowMultiConnection(boolean allow) Sets whether a newly created pin should multiple hyperedge ends to connect to the same pin.
void	setPinColor(Color color) Sets the color of the newly created pin when it is visible.
void	setPinDirection(int direction) Sets the direction into which the newly created pin connects to the hyperedge.
void	setPinDraggingAllowed(boolean flag) Sets whether it is allowed to drag a selected pin.
void	setPinDraggingRestrictedToNodeBorder(boolean flag) Allows to restrict the movement of pins so that pins always stay at the border of the node.
void	setPinLayerMode(int mode) Sets the pin layer mode of the newly created hyperedge pin connector.
void	setPinMovable(boolean movable) Sets whether a newly created pin should be movable.
void	setPinOffset(double offset) Sets the offset of the newly created pin from the border of the node.
void	setPinSelectedColor(Color color) Sets the color of the newly created pin if when is selected.
void	setPinSize(double size) Sets the pin size of the newly created pin.
void	setPinVisible(boolean visible) Sets whether a newly created pin should be visible.

Methods inherited from class ilog.views.hypergraph.interactor.IlvMakeHyperEdgeBaseInteractor

attach, detach, getCursor, getHighlightedGraphic, getHighlightedPin, getObjectDrawingTransformer, getObjectToBeHighlighted, getPinCursor, getPinMargin, highlightPin, isCreationInSubManagersAllowed, isGridMode, isHyperEdge, isManagerToBeHighlighted, isNode, isPermanent, setCreationInSubManagersAllowed, setCursor, setGridMode, setPermanent, setPinCursor, setPinMargin, setPinSelected

Methods inherited from class ilog.views.IlvManagerViewInteractor

addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, allowEnsureVisible, allowEnsureVisible, disableEvents, drawGhost, drawGhost, enableEvents, ensureVisible, ensureVisible, getManager, getManagerView, getTransformer, handleExpose, isXORGhost, processEvent, processFocusEvent, processKeyEvent, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, setXORGhost

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMakeHyperEdgePinConnectorInteractor

public IlvMakeHyperEdgePinConnectorInteractor()

Creates a new interactor.

See Also:

IlvManagerView.pushInteractor(ilog.views.IlvManagerViewInteractor, java.awt.AWTEvent), IlvManagerView.popInteractor()

Method Detail

reInitialize

protected void reInitialize()

Reinitializes the interactor. You do not have to use this method.

Overrides:

reInitialize in class IlvMakeHyperEdgeBaseInteractor

processMouseEvent

protected void processMouseEvent(MouseEvent event)

Processes the mouse events. The method dispatches the event to the MouseListener registered with this interactor (if any).

Overrides:

processMouseEvent in class IlvManagerViewInteractor

Parameters:

event - The event.

See Also:

IlvManagerViewInteractor.addMouseListener(java.awt.event.MouseListener)

createPin

protected IlvHyperGrapherPin createPin(IlvGraphic node,
                                       IlvPoint p)

Creates a new hypergrapher pin.

isNormalClick

protected boolean isNormalClick(MouseEvent event)

Returns true if the mouse event was a normal click. By default, this is a left mouse click.

isNormalClickEnd

protected boolean isNormalClickEnd(MouseEvent event)

Returns true if the mouse event was a mouse up.

isRemovePinClick

protected boolean isRemovePinClick(MouseEvent event)

Returns true if the mouse event was a click on a pin in order to remove the pin. By default, it checks whether the control key and the shift key are pressed simultaneously.

isDragging

protected boolean isDragging(MouseEvent event)

Returns true if the mouse event was dragging.

processMouseMotionEvent

protected void processMouseMotionEvent(MouseEvent event)

Processes the mouse moved and mouse dragged events. The method dispatches the event to the MouseMotionListener registered with this interactor (if any).

Overrides:

processMouseMotionEvent in class IlvManagerViewInteractor

Parameters:

event - The event.

See Also:

IlvManagerViewInteractor.addMouseMotionListener(java.awt.event.MouseMotionListener)

react

protected void react(IlvPoint p)

Highlights or unhighlights the node under the specified point.

Parameters:

p - The point in the coordinate space of the view.

highlightObject

protected void highlightObject(IlvGraphic object)

Highlight the input object.

Overrides:

highlightObject in class IlvMakeHyperEdgeBaseInteractor

getPin

protected IlvHyperGrapherPin getPin(IlvPoint p)

Returns the pin at input position, or null if there is no pin at that position.

Overrides:

getPin in class IlvMakeHyperEdgeBaseInteractor

setPinSize

public void setPinSize(double size)

Sets the pin size of the newly created pin. The default value is 3.

See Also:

IlvHyperGrapherPin.getSize(), getPinSize()

getPinSize

public double getPinSize()

Returns the pin size of the newly created pin.

See Also:

IlvHyperGrapherPin.getSize(), setPinSize(double)

setPinOffset

public void setPinOffset(double offset)

Sets the offset of the newly created pin from the border of the node. This influences the absolute offset of the pin. If the offset is 0, the pin center is exactly on the border. If the offset is the positive pin size, the pin is attached outside the node at the border. If the offset is the negative pin size, the pin is attached inside the node at the border. The default value is 3.

See Also:

IlvHyperGrapherPin.getAbsoluteOffset(), setPinSize(double), getPinOffset()

getPinOffset

public double getPinOffset()

Returns the offset of the newly created pin from the border of the node.

See Also:

setPinOffset(double)

setPinDirection

public void setPinDirection(int direction)

Sets the direction into which the newly created pin connects to the hyperedge. The valid values are:

• IlvDirection.Left - the hyperedge connects to the left side of the pin. This should be used if the pin is on the left side of the node.
• IlvDirection.Right - the hyperedge connects to the right side of the pin. This should be used if the pin is on the right side of the node.
• IlvDirection.Top - the hyperedge connects to the top side of the pin. This should be used if the pin is on the top side of the node.
• IlvDirection.Bottom - the hyperedge connects to the bottom side of the pin. This should be used if the pin is on the bottom side of the node.
• IlvDirection.Center - the hyperedge connects to the center of the pin.
• 0 - the hyperedge determines the best connection automatically. This is the default.

See Also:

IlvHyperGrapherPin.getDirection(), getPinDirection()

getPinDirection

public int getPinDirection()

Returns the direction into which the newly created pin connects to the hyperedge.

See Also:

setPinDirection(int)

setPinVisible

public void setPinVisible(boolean visible)

Sets whether a newly created pin should be visible. The default value is true.

See Also:

IlvHyperGrapherPin.setVisible(boolean), isPinVisible()

isPinVisible

public boolean isPinVisible()

Returns whether a newly created pin should be visible.

See Also:

IlvHyperGrapherPin.setVisible(boolean), setPinVisible(boolean)

setPinMovable

public void setPinMovable(boolean movable)

Sets whether a newly created pin should be movable. The default value is true.

See Also:

IlvHyperGrapherPin.setMovable(boolean), isPinMovable()

isPinMovable

public boolean isPinMovable()

Returns whether a newly created pin should be movable.

See Also:

IlvHyperGrapherPin.setMovable(boolean), setPinMovable(boolean)

setPinAllowMultiConnection

public void setPinAllowMultiConnection(boolean allow)

Sets whether a newly created pin should multiple hyperedge ends to connect to the same pin. The default value is false.

See Also:

IlvHyperGrapherPin.setAllowMultiConnection(boolean), isPinAllowMultiConnection()

isPinAllowMultiConnection

public boolean isPinAllowMultiConnection()

Returns whether a newly created pin should multiple hyperedge ends to connect to the same pin.

See Also:

IlvHyperGrapherPin.setAllowMultiConnection(boolean), setPinAllowMultiConnection(boolean)

setPinColor

public void setPinColor(Color color)

Sets the color of the newly created pin when it is visible. The default color is blue.

See Also:

IlvHyperGrapherPin.setColor(java.awt.Color), getPinColor()

getPinColor

public Color getPinColor()

Returns the color of the newly created pin when it is visible.

See Also:

IlvHyperGrapherPin.setColor(java.awt.Color), setPinColor(java.awt.Color)

setPinSelectedColor

public void setPinSelectedColor(Color color)

Sets the color of the newly created pin if when is selected. The default color is red.

See Also:

IlvHyperGrapherPin.setSelectedColor(java.awt.Color), getPinSelectedColor()

getPinSelectedColor

public Color getPinSelectedColor()

Returns the color of the newly created pin when it is selected.

See Also:

IlvHyperGrapherPin.setSelectedColor(java.awt.Color), setPinSelectedColor(java.awt.Color)

setPinLayerMode

public void setPinLayerMode(int mode)

Sets the pin layer mode of the newly created hyperedge pin connector. The pin layer mode determines the manager layer where to place the pins. The options are:

• IlvHyperEdgeConnector.IN_NODE_LAYER - the pins are placed in the same layer as the node. This is the default.
• IlvHyperEdgeConnector.IN_FRONT - the pins are placed in the a layer above the node layer. The pins may overlap the nodes.
• IlvHyperEdgeConnector.IN_BACK - the pins are placed in the a layer below the node layer. The node may overlap the pins.
• IlvHyperEdgeConnector.IN_FIXED_LAYER - the pins are placed in a fixed layer specified by setFixedPinLayer(int).

See Also:

IlvHyperEdgeConnector.setLayerMode(int), getPinLayerMode()

getPinLayerMode

public int getPinLayerMode()

Returns the pin layer mode of the newly created hyperedge pin connector.

See Also:

setPinLayerMode(int)

setFixedPinLayer

public void setFixedPinLayer(int layer)

Sets the layer of the pins of the newly created hyperedge connector if the pin layer mode is IlvHyperEdgeConnector.IN_FIXED_LAYER.

See Also:

IlvHyperEdgeConnector.getFixedLayer(), setPinLayerMode(int), getFixedPinLayer()

getFixedPinLayer

public int getFixedPinLayer()

Returns the layer of the pins of the newly created hyperedge connector if the pin layer mode is IlvHyperEdgeConnector.IN_FIXED_LAYER.

See Also:

setPinLayerMode(int), setFixedPinLayer(int)

setConnectionPointMoveAllowed

public void setConnectionPointMoveAllowed(boolean allow)

Sets whether the newly created hyperedge connector allows to move the hyperedge ends interactively when they are controlled by the connector. This is enabled by default.

If moving hyperedge ends is allowed, then you can interactively move a hyperedge end from one pin to another pin. If moving pins is allowed, then you can interactively move th pin itself. The hyperedges stay connected to the pin while moving the pin.

See Also:

IlvHyperEdgeConnector.setConnectionPointMoveAllowed(boolean), isConnectionPointMoveAllowed()

isConnectionPointMoveAllowed

public boolean isConnectionPointMoveAllowed()

Returns whether the newly created hyperedge connector allows to move the hyperedge ends interactively when they are controlled by the connector.

See Also:

setConnectionPointMoveAllowed(boolean)

setConnectorFullyZoomable

public void setConnectorFullyZoomable(boolean enable)

Sets whether the newly created hyperedge pin connector behaves fully zoomable. This is enabled by default.

If true, the connector zooms the pin points relative to the unzoomed bounding box of the end nodes. For some graphic objects such as IlvHalfZoomingGraphic, the pin points might not be at the border of the visible bounding box of the node, since the visible bounding box may differ from the calculated bounding box. However, it works for most zoomable graphic objects and it is in general faster. If false, the connector calculates the pin points from the zoomed bounding box. This may match the visible bounding box more precisely, but the connector has eventually no zoomable connections, i.e. IlvHyperEdgePinConnector.connectionsZoomable() returns false.

See Also:

IlvHyperEdgePinConnector, isConnectorFullyZoomable()

isConnectorFullyZoomable

public boolean isConnectorFullyZoomable()

Returns whether the newly created hyperedge pin connector behaves fully zoomable.

See Also:

setConnectorFullyZoomable(boolean)

getBorderCursor

public Cursor getBorderCursor()

Returns the cursor when the mouse is on the border of a node.

See Also:

IlvMakeHyperEdgeBaseInteractor.setCursor(java.awt.Cursor)

setBorderCursor

public void setBorderCursor(Cursor cursor)

Changes the cursor when the mouse is on the border of a node. This cursor indicates that pin creation is currently possible even though the mouse pointer is outside the node.

See Also:

IlvMakeHyperEdgeBaseInteractor.getCursor()

setPinDraggingRestrictedToNodeBorder

public 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 boolean isPinDraggingRestrictedToNodeBorder()

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

See Also:

setPinDraggingRestrictedToNodeBorder(boolean)

setPinDraggingAllowed

public void setPinDraggingAllowed(boolean flag)

Sets whether it is allowed to drag a selected pin.

See Also:

isPinDraggingAllowed()

isPinDraggingAllowed

public boolean isPinDraggingAllowed()

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

See Also:

setPinDraggingAllowed(boolean)