IlvMakeHyperEdgeInteractor (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.IlvManagerViewInteractor
- - ilog.views.hypergraph.interactor.IlvMakeHyperEdgeBaseInteractor
  - - ilog.views.hypergraph.interactor.IlvMakeHyperEdgeInteractor

All Implemented Interfaces:

IlvPermanentInteractorInterface, Serializable

Direct Known Subclasses:

IlvMakeSegmentedHyperEdgeInteractor
```
public class IlvMakeHyperEdgeInteractor
extends IlvMakeHyperEdgeBaseInteractor
```
An interactor that allows to create or to extend an IlvHyperEdge. This interactor must be attached to a view that is attached to an IlvHyperGrapher.
Clicking on a start node and on an end node with the left mouse button creates a new hyperedge that has the start node as source and the end node as target. Clicking on a start node and on an existing hyperedge extends this hyperedge with the start node as new source node. Clicking on an existing hyperedge and on an end node extends this hyperedge with the end node as new target node. Pressing the Control-key while clicking on a node inverses the source and target notion of the node.
Clicking on a start hyperedge and on an end hyperedge combines both hyperedges into one hyperedge. This means, one of both hyperedges survives and the other is removed. The surviving hyperedge receives all ends of the removed hyperedge. This works only if both hyperedges have the same type, and if isCombiningHyperEdgesAllowed() returns true.
Clicking on the right mouse button cancels the current interaction.

Since:

JViews 8.0

See Also:

IlvHyperEdge, IlvHyperGrapher, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IlvMakeHyperEdgeInteractor()
Creates a new interactor.

Constructors
Constructor and Description
`IlvMakeHyperEdgeInteractor()` Creates a new interactor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`acceptContinuation(IlvPoint p, IlvHyperEdge hyperedge)` Tests if a hyperedge can be extended towards a new origin or destination end.
`protected boolean`	`acceptDestination(IlvPoint p, IlvGraphic toNode)` Tests if a node can be the destination of the hyperedge.
`protected boolean`	`acceptOrigin(IlvPoint p, IlvGraphic fromNode)` Tests if a node can be the origin of the hyperedge.
`protected void`	`afterChange(IlvHyperEdge edge1, IlvHyperEdge edge2, UndoableEdit[] edit)` Called after two hyperedges are combined.
`protected void`	`afterChange(IlvHyperEdge hyperedge, UndoableEdit edit)` Called after the hyperedge is extended.
`protected boolean`	`allowEnd(IlvGraphic obj)` Returns whether the object can be end of the interaction.
`protected boolean`	`allowStart(IlvGraphic obj)` Returns whether the object can be start of the interaction.
`protected UndoableEdit`	`beforeChange(IlvHyperEdge hyperedge)` Called before the hyperedge is extended.
`protected UndoableEdit[]`	`beforeChange(IlvHyperEdge edge1, IlvHyperEdge edge2)` Called before two hyperedges are combined.
`protected void`	`createGhost()` Creates the ghost.
`protected void`	`drawGhost(Graphics g)` Draws the ghost of the object being created.
`protected void`	`eraseGhost()` Erases the drawing of the ghost of the object being created.
`float[]`	`getLineStyle()` Returns the line style of the newly created hyperedge.
`double`	`getLineWidth()` Returns the line width of the newly created hyperedge.
`double`	`getMaximumLineWidth()` Returns the maximum line width of the newly created hyperedge.
`Paint`	`getStrokePaint()` Returns the stroke paint of the newly created hyperedge.
`protected void`	`initGhost(IlvHyperEdge hyperedge)` Initializes the ghost with the properties of the original hyperedge.
`protected boolean`	`isCancelClick(MouseEvent event)` Returns `true` if the mouse event was a cancel click.
`boolean`	`isCombiningHyperEdgesAllowed()` Returns `true` if combining hyperedges is allowed, and `false` otherwise.
`protected boolean`	`isNormalClick(MouseEvent event)` Returns `true` if the mouse event was a normal click.
`boolean`	`isSelectionMode()` Returns `true` if the graphic object is selected after creation, while the other objects are deselected.
`protected void`	`moveGhost(IlvPoint p)` Move the ghost when moving the mouse to point p.
`protected boolean`	`needsChangeGraphicBag(IlvHyperEdge hyperedge1, IlvHyperEdge hyperedge2, IlvGraphic node)` Returns `true` if the input hyperedge must change its current graphic bag if it is combined with the second hyperedge and with the input node.
`protected void`	`onEndCreation(IlvPoint p, boolean arrowAtEnd)` Called on the second mouse click that might finish the creation of a hyperedge.
`protected void`	`onStartCreation(IlvPoint p)` Called on the first mouse click that starts the creation of a hyperedge.
`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`	`refreshGhost()` Refreshs the drawing of the ghost of the object being created.
`protected void`	`reInitialize()` Reinitializes the interactor.
`protected void`	`selectIfNecessary(IlvGraphic obj)` Selects the input object if the selection mode is enabled.
`void`	`setCombiningHyperEdgesAllowed(boolean set)` Allows to combine hyperedges, by creating a segment branch that starts at the one hyperedge and ends at the other hyperedge.
`void`	`setLineStyle(float[] style)` Sets the line style of the newly created hyperedge.
`void`	`setLineWidth(double width)` Sets the line width of the newly created hyperedge.
`void`	`setMaximumLineWidth(double width)` Sets the maximum line width of the newly created hyperedge.
`void`	`setSelectionMode(boolean select)` Enables the selection of the created graphic object and the deselection of the other graphic objects contained in the manager after the creation.
`void`	`setStrokePaint(Paint paint)` Sets the stroke paint of the newly created hyperedge.

Methods inherited from class ilog.views.hypergraph.interactor.IlvMakeHyperEdgeBaseInteractor
attach, detach, getCursor, getHighlightedGraphic, getHighlightedPin, getObjectDrawingTransformer, getObjectToBeHighlighted, getPin, getPinCursor, getPinMargin, highlightObject, highlightPin, isCreationInSubManagersAllowed, isGridMode, isHyperEdge, isManagerToBeHighlighted, isNode, isPermanent, setCreationInSubManagersAllowed, setCursor, setGridMode, setPermanent, setPinCursor, setPinMargin, setPinSelected

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvMakeHyperEdgeInteractor
```
public IlvMakeHyperEdgeInteractor()
```
    Creates a new interactor.
    
    See Also:
    
    IlvManagerView.pushInteractor(ilog.views.IlvManagerViewInteractor, java.awt.AWTEvent), IlvManagerView.popInteractor()
- Method Detail
  - isCombiningHyperEdgesAllowed
```
public boolean isCombiningHyperEdgesAllowed()
```
    Returns true if combining hyperedges is allowed, and false otherwise.
    
    See Also:
    
    setCombiningHyperEdgesAllowed(boolean)
  - setCombiningHyperEdgesAllowed
```
public void setCombiningHyperEdgesAllowed(boolean set)
```
    Allows to combine hyperedges, by creating a segment branch that starts at the one hyperedge and ends at the other hyperedge.
    The default value is true
    
    See Also:
    
    isCombiningHyperEdgesAllowed()
  - isSelectionMode
```
public boolean isSelectionMode()
```
    Returns true if the graphic object is selected after creation, while the other objects are deselected. Returns false otherwise.
    
    See Also:
    
    setSelectionMode(boolean)
  - setSelectionMode
```
public void setSelectionMode(boolean select)
```
    Enables the selection of the created graphic object and the deselection of the other graphic objects contained in the manager after the creation.
    The default value is true.
    
    See Also:
    
    isSelectionMode()
  - getStrokePaint
```
public Paint getStrokePaint()
```
    Returns the stroke paint of the newly created hyperedge.
    
    See Also:
    
    setStrokePaint(java.awt.Paint)
  - setStrokePaint
```
public void setStrokePaint(Paint paint)
```
    Sets the stroke paint of the newly created hyperedge. If an existing hyperedge is extended, the stroke paint of the existing hyperedge is not changed.
    
    See Also:
    
    getStrokePaint(), IlvHyperEdge.setStrokePaint(java.awt.Paint)
  - getLineWidth
```
public double getLineWidth()
```
    Returns the line width of the newly created hyperedge.
    
    See Also:
    
    setLineWidth(double)
  - setLineWidth
```
public void setLineWidth(double width)
```
    Sets the line width of the newly created hyperedge. If an existing hyperedge is extended, the line width of the existing hyperedge is not changed.
    
    See Also:
    
    getLineWidth(), IlvHyperEdge.setLineWidth(double)
  - getMaximumLineWidth
```
public double getMaximumLineWidth()
```
    Returns the maximum line width of the newly created hyperedge.
    
    See Also:
    
    setMaximumLineWidth(double)
  - setMaximumLineWidth
```
public void setMaximumLineWidth(double width)
```
    Sets the maximum line width of the newly created hyperedge. If an existing hyperedge is extended, the maximum line width of the existing hyperedge is not changed.
    
    See Also:
    
    getMaximumLineWidth(), IlvHyperEdge.setMaximumLineWidth(double)
  - getLineStyle
```
public float[] getLineStyle()
```
    Returns the line style of the newly created hyperedge.
    
    See Also:
    
    setLineStyle(float[])
  - setLineStyle
```
public void setLineStyle(float[] style)
```
    Sets the line style of the newly created hyperedge. If an existing hyperedge is extended, the line style of the existing hyperedge is not changed.
    
    See Also:
    
    getLineStyle(), IlvHyperEdge.setLineStyle(float[])
  - reInitialize
```
protected void reInitialize()
```
    Reinitializes the interactor. You do not have to use this method.
    
    Overrides:
    
    reInitialize in class IlvMakeHyperEdgeBaseInteractor
  - eraseGhost
```
protected void eraseGhost()
```
    Erases the drawing of the ghost of the object being created.
  - refreshGhost
```
protected void refreshGhost()
```
    Refreshs the drawing of the ghost of the object being created.
  - drawGhost
```
protected void drawGhost(Graphics g)
```
    Draws the ghost of the object being created.
    
    Overrides:
    
    drawGhost in class IlvManagerViewInteractor
    
    Parameters:
    
    g - The graphics context. Its current color is already set to the view's default ghost color, see IlvManagerView.getDefaultGhostColor(). Also, in XOR ghost drawing mode, the graphics context is already set to XOR mode, with the view's default XOR color, see IlvManagerView.getDefaultXORColor().
    
    See Also:
    
    IlvManagerViewInteractor.handleExpose(java.awt.Graphics), IlvManagerViewInteractor.setXORGhost(boolean)
  - initGhost
```
protected void initGhost(IlvHyperEdge hyperedge)
```
    Initializes the ghost with the properties of the original hyperedge. This is used if a hyperedge is extended by a new branch.
    
    Parameters:
    
    hyperedge - The original hyperedge.
  - createGhost
```
protected void createGhost()
```
    Creates the ghost.
  - moveGhost
```
protected void moveGhost(IlvPoint p)
```
    Move the ghost when moving the mouse to point p. To ensure that the moved ghost is property drawn, you must first erase the ghost, then move the ghost, then refresh the ghost:
```
 
 // rerases the drawing of the old ghost position
 eraseGhost();
 moveGhost(p);
 // draws the new ghost position
 refreshGhost();
 
```
    Parameters:
    
    p - The point in the coordinate space of the view.
  - processMouseEvent
```
protected void processMouseEvent(MouseEvent event)
```
    Processes the mouse events.
    
    Overrides:
    
    processMouseEvent in class IlvManagerViewInteractor
    
    Parameters:
    
    event - The event.
    
    See Also:
    
    IlvManagerViewInteractor.addMouseListener(java.awt.event.MouseListener)
  - isNormalClick
```
protected boolean isNormalClick(MouseEvent event)
```
    Returns true if the mouse event was a normal click. On a normal click, the start node, end node or the hyperedge to be extended is selected. By default, this is a left mouse click.
  - isCancelClick
```
protected boolean isCancelClick(MouseEvent event)
```
    Returns true if the mouse event was a cancel click. On a cancel click, the current operation is canceled. By default, this is a right mouse click.
  - onStartCreation
```
protected void onStartCreation(IlvPoint p)
```
    Called on the first mouse click that starts the creation of a hyperedge. It checks whether there is a node under the mouse position which can become the start node. If pins should be used, it determined the appropriate pin of the hyperedge pin connector at this node. It also checks whether there is a hyperedge under the mouse position that allows to be extended by a new branch.
    
    Parameters:
    
    p - The click point in view coordinates
  - acceptOrigin
```
protected boolean acceptOrigin(IlvPoint p,
                               IlvGraphic fromNode)
```
    Tests if a node can be the origin of the hyperedge.
    If creation in submanagers is not allowed (see IlvMakeHyperEdgeBaseInteractor.isCreationInSubManagersAllowed()) and the fromNode is not in the topmost grapher, the method returns false.
    
    Parameters:
    
    p - The clicked point, in view coordinates.
    
    fromNode - The origin node to test.
    
    See Also:
    
    acceptDestination(ilog.views.IlvPoint, ilog.views.IlvGraphic)
  - acceptDestination
```
protected boolean acceptDestination(IlvPoint p,
                                    IlvGraphic toNode)
```
    Tests if a node can be the destination of the hyperedge.
    If creation in submanagers is not allowed (see IlvMakeHyperEdgeBaseInteractor.isCreationInSubManagersAllowed()) and the toNode is not in the topmost grapher, the method returns false.
    
    Parameters:
    
    p - The clicked point, in view coordinates.
    
    toNode - The destination node to test.
    
    See Also:
    
    acceptOrigin(ilog.views.IlvPoint, ilog.views.IlvGraphic)
  - acceptContinuation
```
protected boolean acceptContinuation(IlvPoint p,
                                     IlvHyperEdge hyperedge)
```
    Tests if a hyperedge can be extended towards a new origin or destination end.
    If creation in submanagers is not allowed (see IlvMakeHyperEdgeBaseInteractor.isCreationInSubManagersAllowed()) and the hyperege is not in the topmost grapher, the method returns false.
    
    Parameters:
    
    p - The clicked point, in view coordinates.
    
    hyperedge - The hyperedge to test.
  - onEndCreation
```
protected void onEndCreation(IlvPoint p,
                             boolean arrowAtEnd)
```
    Called on the second mouse click that might finish the creation of a hyperedge. It checks whether there is a node under the mouse position which can become the end node. If pins should be used, it determined the appropriate pin of the hyperedge pin connector at this node. It also checks whether there is a hyperedge under the mouse position that allows to be extended by a new branch. If one of the above conditions is true, it creates the new hyperedge or extends the existing hyperedge by a new branch.
    
    Parameters:
    
    p - The click point in view coordinates
    
    arrowAtEnd - Whether we try to select an end target or an end source.
  - selectIfNecessary
```
protected void selectIfNecessary(IlvGraphic obj)
```
    Selects the input object if the selection mode is enabled. This is called at the end of the interaction that created or extended a hyperedge.
    
    Parameters:
    
    obj - The object to be selected.
  - beforeChange
```
protected UndoableEdit beforeChange(IlvHyperEdge hyperedge)
```
    Called before the hyperedge is extended. This allows to plug in the undo mechanism.
  - afterChange
```
protected void afterChange(IlvHyperEdge hyperedge,
                           UndoableEdit edit)
```
    Called after the hyperedge is extended. This allows to plug in the undo mechanism.
  - beforeChange
```
protected UndoableEdit[] beforeChange(IlvHyperEdge edge1,
                                      IlvHyperEdge edge2)
```
    Called before two hyperedges are combined. This allows to plug in the undo mechanism.
  - afterChange
```
protected void afterChange(IlvHyperEdge edge1,
                           IlvHyperEdge edge2,
                           UndoableEdit[] edit)
```
    Called after two hyperedges are combined. This allows to plug in the undo mechanism.
  - needsChangeGraphicBag
```
protected boolean needsChangeGraphicBag(IlvHyperEdge hyperedge1,
                                        IlvHyperEdge hyperedge2,
                                        IlvGraphic node)
```
    Returns true if the input hyperedge must change its current graphic bag if it is combined with the second hyperedge and with the input node. By combining the input hyperedge with the second hyperedge or with the node, the hyperedge might become an intergraph hyperedge that must be contained in an ancestor hypergraph.
    
    Parameters:
    
    hyperedge1 - The input hyperedge whose graphic bag is checked.
    
    hyperedge2 - The hyperedge to be combined with the first hyperedge. Can be null
    
    node - The node to become an end node of the first hyperedge. Can be null
  - 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.
  - allowStart
```
protected boolean allowStart(IlvGraphic obj)
```
    Returns whether the object can be start of the interaction.
  - allowEnd
```
protected boolean allowEnd(IlvGraphic obj)
```
    Returns whether the object can be end of the interaction.

Class IlvMakeHyperEdgeInteractor

Constructor Summary

Method Summary

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

Methods inherited from class ilog.views.IlvManagerViewInteractor

Methods inherited from class java.lang.Object

Constructor Detail

IlvMakeHyperEdgeInteractor

Method Detail

isCombiningHyperEdgesAllowed

setCombiningHyperEdgesAllowed

isSelectionMode

setSelectionMode

getStrokePaint

setStrokePaint

getLineWidth

setLineWidth

getMaximumLineWidth

setMaximumLineWidth

getLineStyle

setLineStyle

reInitialize

eraseGhost

refreshGhost

drawGhost

initGhost

createGhost

moveGhost

processMouseEvent

isNormalClick

isCancelClick

onStartCreation

acceptOrigin

acceptDestination

acceptContinuation

onEndCreation

selectIfNecessary

beforeChange

afterChange

beforeChange

afterChange

needsChangeGraphicBag

processMouseMotionEvent

react

allowStart

allowEnd