IltMakePolyLinkInteractor (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.IlvManagerViewInteractor
- - ilog.tgo.interactor.IltMakeLinkInteractor
  - - ilog.tgo.interactor.IltMakePolyLinkInteractor

All Implemented Interfaces:

IlvPermanentInteractorInterface, Serializable
```
public class IltMakePolyLinkInteractor
extends IltMakeLinkInteractor
```
This class is a view interactor which lets the user connect two nodes by a link.
By default, this interactor creates multiple point links between the two nodes. To create multiple point links:
- Click on the node to start the interaction. The from node will become selected.
- Drag and click to add new points to the link shape.
- Once you have specified the link shape, double-click on the to node to end the interaction.
Please note that as JTGO uses link layout algorithms to route links, multiple point links are set as fixed links, so that the layout algorithm does not reshape the link afterwards.
The following configuration is also available:
- Self-links: through method IltMakeLinkInteractor.setSelfLinkAllowed(boolean) you can specify that self-links can be created by this interactor. Self-links are links where the from and to nodes are the same. Please note that with some link layout algorithms, such as IltShortLinkLayout, self-links are not well displayed.
- Straight links: through method setAllowingMultiplePoints(boolean) you can specify that straight links will be created by this interactor. Straight links are not marked as fixed by the layout. You must select the nodes where the link will start and end by pressing the mouse button on the from node and releasing it on the to node. Straight links are laid out according to the current link layout configuration.
When this interactor is set in a Network or Equipment component, the configuration for the links created by this interactor will be stored in the component through a mutable style sheet. Methods getStyleSheet(ilog.views.IlvManagerView), attachStyleSheet(ilog.views.IlvManagerView) and detachStyleSheet(ilog.views.IlvManagerView) are used to define the mutable style sheet that will be used for the given view. By default, the mutable style sheet used is the one specified for the component view (See IlpGraphView.getMutableStyleSheet(). This mutable style sheet is appended to the list of style sheets currently set in the component. If later on, method setStyleSheets is called, attention must be taken to not erase any changes performed by this interactor.
While the interactor is attached to the view, method getStyleSheet() can be used to retrieve the current mutable style sheet and save it for future use.
Since:

JViews 7.5

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ilog.tgo.interactor.IltMakeLinkInteractor
  IltMakeLinkInteractor.Gesture

Constructor Summary

Constructors
Constructor and Description

IltMakePolyLinkInteractor()
Creates the interactor.

Constructors
Constructor and Description
`IltMakePolyLinkInteractor()` Creates the interactor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`attach(IlvManagerView view)` Called when the interactor is attached to the manager view.
`protected void`	`attachStyleSheet(IlvManagerView view)` Initializes a mutable style sheet to the given view.
`protected void`	`detach()` Called when the interactor is detached from the view.
`protected void`	`detachStyleSheet(IlvManagerView view)` Ends the style sheet edition.
`protected boolean`	`endOnDoubleClick()` Returns `true` if the interactor will stop requesting points when the user performs a double-click.
`double`	`getMinPointsDistance()` Returns the minimum distance between two created points.
`protected IlpMutableStyleSheet`	`getStyleSheet()` Returns the mutable style sheet that is being used by this interactor to save the modifications in the current attached Network or Equipment components.
`IlpMutableStyleSheet`	`getStyleSheet(IlvManagerView view)` Returns the mutable style sheet used to store changes in link port configuration for the given view.
`boolean`	`isAllowingMultiplePoints()` Returns `true` if the interactor allows more than two points to be entered.
`protected boolean`	`isEnoughDistance(IlvPoint p1, IlvPoint p2)` Checks the distance between two consecutive points that are created.
`protected boolean`	`numberOfPointsReached()` Returns `true` if the number of desired points is reached.
`void`	`setAllowingMultiplePoints(boolean allow)` Changes the number of points the user can select with the interactor.
`void`	`setMinPointsDistance(double minDist)` Sets the minimum distance between two consecutive points.
`protected void`	`setStyleSheet(IlpMutableStyleSheet css)` Sets the mutable style sheet that is being used by this interactor to save the modifications in the Network and Equipment components.

Methods inherited from class ilog.tgo.interactor.IltMakeLinkInteractor
accept, acceptDestination, acceptOrigin, drawGhost, getPortsColor, handleExpose, isLinkConnectionPortMode, isPermanent, isSelfLinkAllowed, processMouseEvent, processMouseMotionEvent, react, setLinkConnectionPortMode, setPermanent, setPortsColor, setSelfLinkAllowed, trigger, trigger

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

- Constructor Detail
  - IltMakePolyLinkInteractor
```
public IltMakePolyLinkInteractor()
```
    Creates the interactor.
    
    Since:
    
    JViews 7.5
- Method Detail
  - isAllowingMultiplePoints
```
public boolean isAllowingMultiplePoints()
```
    Returns true if the interactor allows more than two points to be entered. The default value is true.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setAllowingMultiplePoints(boolean)
  - setAllowingMultiplePoints
```
public void setAllowingMultiplePoints(boolean allow)
```
    Changes the number of points the user can select with the interactor.
    
    Parameters:
    
    allow - If true then the interactor allows selecting several points; otherwise only two points are allowed.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    isAllowingMultiplePoints()
  - setMinPointsDistance
```
public final void setMinPointsDistance(double minDist)
```
    Sets the minimum distance between two consecutive points. The interactor ensures that the distance between any two consecutive points of the created polypoint is larger than or equal to this value.
    The value of the parameter is in manager view (screen) coordinates.
    This parameter does not apply to the distance between the first and the last point.
    The default value is 5.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    getMinPointsDistance()
  - getMinPointsDistance
```
public final double getMinPointsDistance()
```
    Returns the minimum distance between two created points.
    The default value is 5.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setMinPointsDistance(double)
  - isEnoughDistance
```
protected boolean isEnoughDistance(IlvPoint p1,
                                   IlvPoint p2)
```
    Checks the distance between two consecutive points that are created.
    
    Overrides:
    
    isEnoughDistance in class IltMakeLinkInteractor
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    IltMakePolyLinkInteractor
  - numberOfPointsReached
```
protected boolean numberOfPointsReached()
```
    Returns true if the number of desired points is reached. This method returns true if the interactor allows only two points to be selected (see the isAllowingMultiplePoints member function) and two points have been selected.
    
    Overrides:
    
    numberOfPointsReached in class IltMakeLinkInteractor
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    isAllowingMultiplePoints()
  - endOnDoubleClick
```
protected boolean endOnDoubleClick()
```
    Returns true if the interactor will stop requesting points when the user performs a double-click.
    The default implementation returns true when the interactor allows more than two points to be entered; otherwise it returns false.
    
    Overrides:
    
    endOnDoubleClick in class IltMakeLinkInteractor
    
    Since:
    
    JViews 7.5
  - attach
```
protected void attach(IlvManagerView view)
```
    Description copied from class: IlvManagerViewInteractor
    
    Called when the interactor is attached to the manager view.
    
    Overrides:
    
    attach in class IlvManagerViewInteractor
    
    Parameters:
    
    view - The manager view.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    IlvManagerViewInteractor.detach()
  - detach
```
protected void detach()
```
    Description copied from class: IlvManagerViewInteractor
    
    Called when the interactor is detached from the view.
    
    Overrides:
    
    detach in class IlvManagerViewInteractor
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    IlvManagerViewInteractor.attach(ilog.views.IlvManagerView)
  - getStyleSheet
```
public IlpMutableStyleSheet getStyleSheet(IlvManagerView view)
```
    Returns the mutable style sheet used to store changes in link port configuration for the given view.
    
    Parameters:
    
    view - Manager view
    
    Returns:
    
    Mutable style sheet that is being used for the given view or null if the view has never been edited before or is not able to use style sheet customization.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    IlpGraphView.getMutableStyleSheet()
  - getStyleSheet
```
protected IlpMutableStyleSheet getStyleSheet()
```
    Returns the mutable style sheet that is being used by this interactor to save the modifications in the current attached Network or Equipment components.
    
    Returns:
    
    Mutable style sheet being used when this interactor is attached to a component, or null otherwise.
    
    Since:
    
    JViews 7.5
  - setStyleSheet
```
protected void setStyleSheet(IlpMutableStyleSheet css)
```
    Sets the mutable style sheet that is being used by this interactor to save the modifications in the Network and Equipment components.
    This method must be called only when attaching this interactor to the view.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    attachStyleSheet(ilog.views.IlvManagerView view)
  - attachStyleSheet
```
protected void attachStyleSheet(IlvManagerView view)
```
    Initializes a mutable style sheet to the given view. This mutable style sheet allows changed performed by this interactor to be changed in the Network and Equipment components using CSS.
    
    Parameters:
    
    view - Manager view
    
    Since:
    
    JViews 7.5
  - detachStyleSheet
```
protected void detachStyleSheet(IlvManagerView view)
```
    Ends the style sheet edition.
    
    Parameters:
    
    view - Manager view
    
    Since:
    
    JViews 7.5

Class IltMakePolyLinkInteractor

Nested Class Summary

Nested classes/interfaces inherited from class ilog.tgo.interactor.IltMakeLinkInteractor

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.interactor.IltMakeLinkInteractor

Methods inherited from class ilog.views.IlvManagerViewInteractor

Methods inherited from class java.lang.Object

Constructor Detail

IltMakePolyLinkInteractor

Method Detail

isAllowingMultiplePoints

setAllowingMultiplePoints

setMinPointsDistance

getMinPointsDistance

isEnoughDistance

numberOfPointsReached

endOnDoubleClick

attach

detach

getStyleSheet

getStyleSheet

setStyleSheet

attachStyleSheet

detachStyleSheet