ilog.views.dashboard

Class IlvDashboardLinkManager

java.lang.Object

ilog.views.dashboard.IlvDashboardLinkManager

public class IlvDashboardLinkManager
extends Object

Base class that controls link editing. It can be extended and set to the Dashboard Editor to customize the link creation behavior, for example, to control the validity of a symbol and potentially its ports when connecting a link. Its public functions are not intended to be called directly by an application. They are used by the Dashboard Editor classes that create link symbols.

Since:

JViews 8.6

Constructor Summary

Constructors

Constructor and Description
IlvDashboardLinkManager(IlvDashboardEditor editor) Creates an IlvDashboardLinkManager.

Method Summary

Modifier and Type	Method and Description
protected void	enterDestination(IlvDashboardSymbol symbol) This method is called when the mouse enter a symbol
protected void	enterLinkCreationMode(IlvDashboardDiagram dashboard, IlvPaletteSymbol link) This method is invoked before the Dashboard Editor switches to link creation mode.
protected void	enterOrigin(IlvDashboardSymbol symbol) This method is called when the mouse enters a symbol while the user selects a link origin.
protected void	exitDestination(IlvDashboardSymbol symbol) This method is called when the mouse exits a symbol while the make link interactor is selecting a link destination.
protected void	exitLinkCreationMode(IlvDashboardDiagram dashboard) This method is invoked when the Dashboard Editor exits link creation mode.
protected void	exitOrigin(IlvDashboardSymbol symbol) This method is called when the mouse exits a symbol while the user chooses a link origin.
protected IlvDashboardSymbol	getDestination() Returns the selected link destination symbol.
IlvDashboardEditor	getEditor() Returns the Dashboard Editor object.
protected Color	getHighlightColor() Returns the color used to draw the connection rectangles.
static Iterator<IlvGraphic>	getInPorts(IlvDashboardSymbol symbol) Returns all the in port elements of a given symbol.
Cursor	getIntermediatePointCursor() Returns the cursor used when the mouse is at a location where an intermediate point can be created.
Cursor	getInvalidCursor() Returns the invalid cursor.
protected Point	getLastPoint() Returns the last location processed by the link manager through processOrigin(IlvDashboardDiagram, Point) or processDestination(IlvDashboardDiagram, Point)
protected IlvDashboardSymbol	getOrigin() Returns the selected link origin symbol.
static Iterator<IlvGraphic>	getOutPorts(IlvDashboardSymbol symbol) Returns all the out port elements of a given symbol.
protected IlvGraphic	getPort(IlvTransformer transfo, Point point) Returns the link port of a previously processed symbol.
protected IlvRect	getPortBoundingBox(IlvDashboardSymbol symbol, IlvGraphic port) Returns the bounding box of a link port.
int	getPortMinSize() Returns the port minimum size.
Cursor	getValidCursor() Returns the cursor used when the mouse is at a valid link connection location.
protected void	highlightDestination(IlvDashboardSymbol symbol, boolean highlight) Highlights or stops highlighting a link destination candidate.
protected void	highlightOrigin(IlvDashboardSymbol symbol, boolean highlight) Highlights or stops highlighting a link origin candidate.
protected void	highlightPort(Graphics dst, IlvRect rect) Highlights a symbol link port.
protected void	highlightSymbol(Graphics dst, IlvRect rect) Highlights a symbol.
boolean	isIntermediatePointsModeAllowed() Checks whether intermediate point mode allowed or not.
protected boolean	isLinkCreationAllowed(IlvDashboardDiagram dashboard) Tests whether the Dashboard Editor is in a state that allows creating links, for example,there are at least two nodes in the dashboard diagram.
protected boolean	isValidDestination(IlvPaletteSymbol link, IlvDashboardSymbol sourceNode, IlvGraphic portOut, IlvDashboardSymbol targetNode, IlvGraphic portIn) Tests whether a symbol or a port is accepted as a link destination.
protected boolean	isValidOrigin(IlvPaletteSymbol link, IlvDashboardSymbol sourceNode, IlvGraphic outPort) Tests whether a symbol or a port is accepted as a link origin.
protected void	linkAdded(IlvDashboardSymbol linkSymbol) Invoked when a link symbol has been created and added to the dashboard diagram.
protected void	originSelected(IlvDashboardSymbol origin, IlvGraphic outPort) Invoked when the link origin has been selected.
protected boolean	processDestination(IlvDashboardDiagram dashboard, Point point) This function is called by the Make Link interactor at each mouse motion event, when the user chooses the link destination.
protected boolean	processOrigin(IlvDashboardDiagram dashboard, Point point) This function is repeatedly called when the user moves the mouse while choosing the link origin symbol.
void	setIntermediatePointCursor(Cursor cursor) Sets the cursor to be used when the mouse is at a location where an intermediate point can be created.
void	setIntermediatePointsModeAllowed(boolean allowed) Sets the intermediate points mode allowed.
void	setInvalidCursor(Cursor cursor) Sets the cursor to be used when the mouse is not at a valid location.
void	setPortMinSize(int size) Sets the minimum size of the link ports.
void	setValidCursor(Cursor cursor) Sets the cursor to be used when the mouse is at a valid link connection location.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDashboardLinkManager

public IlvDashboardLinkManager(IlvDashboardEditor editor)

Creates an IlvDashboardLinkManager.

Parameters:

editor - The Dashboard Editor instance.

Method Detail

originSelected

protected void originSelected(IlvDashboardSymbol origin,
                              IlvGraphic outPort)

Invoked when the link origin has been selected. The link manager starts to prepare the selection of the link destination.

Parameters:

origin - The selected link source symbol.

outPort - The selected out port, if any.

getEditor

public IlvDashboardEditor getEditor()

Returns the Dashboard Editor object.

Returns:

The Dashboard Editor.

isValidOrigin

protected boolean isValidOrigin(IlvPaletteSymbol link,
                                IlvDashboardSymbol sourceNode,
                                IlvGraphic outPort)

Tests whether a symbol or a port is accepted as a link origin. You can override this function in a subclass to control the validity of the link origin.

When the user chooses the link origin, each time the mouse enters a symbol, this function is called once for the symbol itself and once for each out port of the symbol to collect the valid out ports of the symbol.

Parameters:

link - The prototype of the link to be created.

sourceNode - The link source symbol to test.

outPort - The out port to test, or null if the test applies to the link source symbol itself. Note: the name of the port object includes its prefix port_out_ or port_inout_.

Returns:

true if the link source is valid.

See Also:

IlvGraphic.getName()

processOrigin

protected boolean processOrigin(IlvDashboardDiagram dashboard,
                                Point point)

This function is repeatedly called when the user moves the mouse while choosing the link origin symbol.

Parameters:

dashboard - The target dashboard diagram.

point - The current mouse location.

Returns:

true if the mouse is at a valid link origin.

getOrigin

protected IlvDashboardSymbol getOrigin()

Returns the selected link origin symbol.

Returns:

The link origin.

getDestination

protected IlvDashboardSymbol getDestination()

Returns the selected link destination symbol.

Returns:

The link destination.

getPort

protected IlvGraphic getPort(IlvTransformer transfo,
                             Point point)

Returns the link port of a previously processed symbol.

Parameters:

transfo - The transformer of the view.

point - The location of the potential port.

Returns:

The link port.

exitOrigin

protected void exitOrigin(IlvDashboardSymbol symbol)

This method is called when the mouse exits a symbol while the user chooses a link origin.

Parameters:

symbol - The previous symbol under the mouse pointer.

enterOrigin

protected void enterOrigin(IlvDashboardSymbol symbol)

This method is called when the mouse enters a symbol while the user selects a link origin. It collects all valid out ports by calling isValidOrigin(IlvPaletteSymbol, IlvDashboardSymbol, IlvGraphic) for the symbol itself (without specifying the out port) and then for all its out ports.

Parameters:

symbol - The new symbol under the mouse pointer.

getInPorts

public static Iterator<IlvGraphic> getInPorts(IlvDashboardSymbol symbol)

Returns all the in port elements of a given symbol.

Parameters:

symbol - The symbol.

Returns:

The names of the valid in ports of the symbol.

getOutPorts

public static Iterator<IlvGraphic> getOutPorts(IlvDashboardSymbol symbol)

Returns all the out port elements of a given symbol.

Parameters:

symbol - The symbol.

Returns:

The names of the valid out ports of the symbol.

getPortBoundingBox

protected IlvRect getPortBoundingBox(IlvDashboardSymbol symbol,
                                     IlvGraphic port)

Returns the bounding box of a link port. If needed, the returned rectangle is expanded to meet the port minimum size constraint.

Parameters:

symbol - The symbol containing the port.

port - The port.

Returns:

The bounding box of the port element.

See Also:

setPortMinSize(int)

isValidDestination

protected boolean isValidDestination(IlvPaletteSymbol link,
                                     IlvDashboardSymbol sourceNode,
                                     IlvGraphic portOut,
                                     IlvDashboardSymbol targetNode,
                                     IlvGraphic portIn)

Tests whether a symbol or a port is accepted as a link destination. You can override this function to control the validity of the link destination.

When the user chooses the link destination, each time the mouse enters a symbol, this function is called once for the symbol itself and once for each in port of the symbol to collect the valid in ports of the symbol.

Parameters:

link - The prototype of the link to be created.

sourceNode - The link source symbol that has already been selected.

portOut - The selected out port if any, or null if no out port is used. Note: the name of the given port includes its prefix port_out_ or port_inout_.

targetNode - The link target symbol to test.

portIn - The in port to test, or null if the test applies to the link target symbol itself. Note: the name of the given port includes its prefix port_in_ or port_inout_.

Returns:

true if the link destination is accepted.

processDestination

protected boolean processDestination(IlvDashboardDiagram dashboard,
                                     Point point)

This function is called by the Make Link interactor at each mouse motion event, when the user chooses the link destination. When the mouse pointer enters a symbol, this function invokes isValidDestination(IlvPaletteSymbol, IlvDashboardSymbol, IlvGraphic, IlvDashboardSymbol, IlvGraphic) to collect all the valid in ports of the symbol, and tests whether the symbol itself can be connected. All the accepted locations are then highlighted.

Parameters:

dashboard - The edited dashboard diagram.

point - The new mouse location.

Returns:

true if the mouse is on a valid link target connection.

enterDestination

protected void enterDestination(IlvDashboardSymbol symbol)

This method is called when the mouse enter a symbol

Parameters:

symbol - The symbol previously under the mouse pointer.

exitDestination

protected void exitDestination(IlvDashboardSymbol symbol)

This method is called when the mouse exits a symbol while the make link interactor is selecting a link destination.

Parameters:

symbol - The symbol previously under the mouse pointer.

highlightDestination

protected void highlightDestination(IlvDashboardSymbol symbol,
                                    boolean highlight)

Highlights or stops highlighting a link destination candidate.

Parameters:

symbol - The symbol.

highlight - true if the symbol is to be highlighted.

setPortMinSize

public void setPortMinSize(int size)

Sets the minimum size of the link ports. If the width or the height of a link port is smaller than the port minimum size, this minimum size is used instead.

Parameters:

size - The port minimum size.

See Also:

getPortMinSize(), getPortBoundingBox(IlvDashboardSymbol, IlvGraphic)

getPortMinSize

public int getPortMinSize()

Returns the port minimum size.

Returns:

The port minimum size.

See Also:

setPortMinSize(int)

highlightOrigin

protected void highlightOrigin(IlvDashboardSymbol symbol,
                               boolean highlight)

Highlights or stops highlighting a link origin candidate.

Parameters:

symbol - The symbol.

highlight - true if the symbol is to be highlighted.

highlightSymbol

protected void highlightSymbol(Graphics dst,
                               IlvRect rect)

Highlights a symbol.

Parameters:

dst - The destination.

rect - The area to highlight.

highlightPort

protected void highlightPort(Graphics dst,
                             IlvRect rect)

Highlights a symbol link port.

Parameters:

dst - The destination.

rect - The area to highlight.

getHighlightColor

protected Color getHighlightColor()

Returns the color used to draw the connection rectangles.

Returns:

The highlight color.

See Also:

highlightOrigin(IlvDashboardSymbol, boolean)

isLinkCreationAllowed

protected boolean isLinkCreationAllowed(IlvDashboardDiagram dashboard)

Tests whether the Dashboard Editor is in a state that allows creating links, for example,there are at least two nodes in the dashboard diagram.

Parameters:

dashboard - The current dashboard diagram.

Returns:

true if links can be created.

enterLinkCreationMode

protected void enterLinkCreationMode(IlvDashboardDiagram dashboard,
                                     IlvPaletteSymbol link)

This method is invoked before the Dashboard Editor switches to link creation mode.

Parameters:

dashboard - The target dashboard diagram where a link is to be created.

link - The palette symbol corresponding to the link to be created.

exitLinkCreationMode

protected void exitLinkCreationMode(IlvDashboardDiagram dashboard)

This method is invoked when the Dashboard Editor exits link creation mode.

Parameters:

dashboard - The target dashboard diagram.

isIntermediatePointsModeAllowed

public boolean isIntermediatePointsModeAllowed()

Checks whether intermediate point mode allowed or not.

Returns:

The intermediate point mode.

setIntermediatePointsModeAllowed

public void setIntermediatePointsModeAllowed(boolean allowed)

Sets the intermediate points mode allowed.

Parameters:

allowed - The intermediate points mode.

getInvalidCursor

public Cursor getInvalidCursor()

Returns the invalid cursor.

Returns:

The invalid cursor.

See Also:

setInvalidCursor(Cursor)

setInvalidCursor

public void setInvalidCursor(Cursor cursor)

Sets the cursor to be used when the mouse is not at a valid location. When choosing the link target, and typically when intermediate points are not allowed, this cursor is used as long as the mouse pointer is not at a valid link target location. In fact, when intermediate points are allowed, the user can insert intermediate points before choosing the link target, so this invalid cursor is not applicable.

Parameters:

cursor - The cursor.

See Also:

getInvalidCursor(), setIntermediatePointCursor(Cursor), setIntermediatePointsModeAllowed(boolean), isIntermediatePointsModeAllowed()

getIntermediatePointCursor

public Cursor getIntermediatePointCursor()

Returns the cursor used when the mouse is at a location where an intermediate point can be created.

Returns:

The cursor.

See Also:

setIntermediatePointCursor(Cursor)

setIntermediatePointCursor

public void setIntermediatePointCursor(Cursor cursor)

Sets the cursor to be used when the mouse is at a location where an intermediate point can be created.

Parameters:

cursor - The cursor.

See Also:

getIntermediatePointCursor()

getValidCursor

public Cursor getValidCursor()

Returns the cursor used when the mouse is at a valid link connection location.

Returns:

The cursor.

See Also:

setValidCursor(Cursor)

setValidCursor

public void setValidCursor(Cursor cursor)

Sets the cursor to be used when the mouse is at a valid link connection location.

Parameters:

cursor - The valid cursor.

See Also:

getValidCursor()

getLastPoint

protected Point getLastPoint()

Returns the last location processed by the link manager through processOrigin(IlvDashboardDiagram, Point) or processDestination(IlvDashboardDiagram, Point)

Returns:

The last location.

linkAdded

protected void linkAdded(IlvDashboardSymbol linkSymbol)

Invoked when a link symbol has been created and added to the dashboard diagram.

Parameters:

linkSymbol - The newly added link symbol.