ilog.views.sdm.interactor

Class IlvMakeSDMLinkInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.interactor.IlvMakePolyPointsInteractor

ilog.views.interactor.IlvMakeLinkInteractor

ilog.views.sdm.interactor.IlvMakeSDMLinkInteractor

All Implemented Interfaces:

IlvLinkImageFactory, IlvPermanentInteractorInterface, Serializable

Direct Known Subclasses:

IlvBPMNMakeSDMLinkInteractor

public class IlvMakeSDMLinkInteractor
extends IlvMakeLinkInteractor
implements IlvLinkImageFactory

The class IlvMakeSDMLinkInteractor lets the user create links by clicking in an SDM view.

Since:

JViews 4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvMakeSDMLinkInteractor() Creates a new interactor that adds new links to an SDM view.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptDestination(IlvPoint p, IlvGraphic toNode) This method tests whether a node can be the destination of the link.
protected boolean	acceptOrigin(IlvPoint p, IlvGraphic fromNode) This method tests whether a node can be the origin of the link.
protected void	addPolyPoints(IlvGraphic obj) Adds the new link inside the grapher.
protected void	attach(IlvManagerView v) This method is called when the interactor is attached to the specified manager view.
IlvLinkImage	createObject(IlvGraphic from, IlvGraphic to, IlvPoint[] points, boolean oriented) Implementation of IlvLinkImageFactory.
protected IlvLinkImage	createObjectInOpaqueMode(IlvGraphic from, IlvGraphic to, IlvPoint[] points, boolean oriented) This method is called by createObject(ilog.views.IlvGraphic, ilog.views.IlvGraphic, ilog.views.IlvPoint[], boolean) when the interactor is in Opaque mode, to create the temporary link drawn to show feedback during the interaction.
protected void	detach() This method is called when the interactor is detached from the specified manager view.
protected Object	getCompositeChild(IlvGraphic obj, IlvPoint p)
IlvSDMEngine	getEngine() Returns the SDM Engine attached to this interactor.
Object	getFromObject() Returns the SDM model object that will be the origin of the newly created link.
Class<?>	getLinkImageClass() Implementation of IlvLinkImageFactory.
IlvSDMModel	getPrototypeModel() Returns the data model that the prototype object belongs to.
Object	getPrototypeObject() Returns the prototype object used by this interactor to create new links.
String	getTag() Returns the tag of the objects that will be created by this interactor.
Object	getToObject() Returns the SDM model object that will be the destination of the newly created link.
protected void	highlight(IlvGraphic obj) Highlights a node when moving over it.
protected IlvGraphic	makePolyPoint(IlvPoint[] points) Called to create the link instance.
protected void	processKeyEvent(KeyEvent e) Processes the key events.
protected void	react(IlvPoint p) Highlights or unhighlights the node under the specified point.
protected void	setLinkProperties(IlvSDMModel model, Object link) Sets the initial properties of the newly created link.
void	setPrototypeObject(IlvSDMModel model, Object object) Sets the object that will be used as a prototype by this interactor to create new links.
void	setTag(String tag) Sets the tag of the objects that will be created by this interactor.
protected void	unHighlight(IlvGraphic obj) Unhighlights a node when moving over another node.

Methods inherited from class ilog.views.interactor.IlvMakeLinkInteractor

accept, doIt, drawGhost, endOnDoubleClick, getFrom, getGrapher, getLinkClass, getLinkFactory, getTo, isGridMode, isOriented, isSelectionMode, isSelfLinkAllowed, numberOfPointsReached, reInitialize, setLinkFactory, setOriented, setSelectionMode, setSelfLinkAllowed

Methods inherited from class ilog.views.interactor.IlvMakePolyPointsInteractor

allowsMultiplePoints, allowsMultiplePoints, count, getBackground, getCursor, getForeground, getMinPointsDistance, getObjectFactory, getPoints, isAllowingMultiplePoints, isCreationInSubManagersAllowed, isGrapherMode, isOpaqueMode, isPermanent, isXORGhost, processMouseEvent, processMouseMotionEvent, setAllowingMultiplePoints, setBackground, setCreationInSubManagersAllowed, setCursor, setForeground, setGrapherMode, setGridMode, setMinPointsDistance, setObjectFactory, setOpaqueMode, setPermanent

Methods inherited from class ilog.views.IlvManagerViewInteractor

addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, allowEnsureVisible, allowEnsureVisible, disableEvents, drawGhost, enableEvents, ensureVisible, ensureVisible, getManager, getManagerView, getTransformer, handleExpose, processEvent, processFocusEvent, 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

IlvMakeSDMLinkInteractor

public IlvMakeSDMLinkInteractor()

Creates a new interactor that adds new links to an SDM view.

Method Detail

getEngine

public IlvSDMEngine getEngine()

Returns the SDM Engine attached to this interactor.

Since:

JViews 6.0

setTag

public void setTag(String tag)

Sets the tag of the objects that will be created by this interactor.

Parameters:

tag - The new tag.

getTag

public String getTag()

Returns the tag of the objects that will be created by this interactor.

setPrototypeObject

public void setPrototypeObject(IlvSDMModel model,
                               Object object)

Sets the object that will be used as a prototype by this interactor to create new links.

Parameters:

model - The data model the object belongs to.

object - The prototype object.

getPrototypeModel

public IlvSDMModel getPrototypeModel()

Returns the data model that the prototype object belongs to.

getPrototypeObject

public Object getPrototypeObject()

Returns the prototype object used by this interactor to create new links.

attach

protected void attach(IlvManagerView v)

This method is called when the interactor is attached to the specified manager view.

Overrides:

attach in class IlvMakeLinkInteractor

Parameters:

v - The manager view.

See Also:

IlvMakePolyPointsInteractor.detach()

detach

protected void detach()

This method is called when the interactor is detached from the specified manager view.

Overrides:

detach in class IlvMakePolyPointsInteractor

See Also:

IlvManagerViewInteractor.attach(ilog.views.IlvManagerView)

createObject

public IlvLinkImage createObject(IlvGraphic from,
                                 IlvGraphic to,
                                 IlvPoint[] points,
                                 boolean oriented)

Implementation of IlvLinkImageFactory. Creates a new link.

If a prototype object was set using setPrototypeObject(ilog.views.sdm.IlvSDMModel, java.lang.Object), the new object is a copy of the prototype object. Otherwise, the object is a new object with the tag specified by setTag(java.lang.String).

If this interactor is in Opaque mode, and if this method is being called to create the temporary link drawn to show feedback during the interaction, then the method createObjectInOpaqueMode(ilog.views.IlvGraphic, ilog.views.IlvGraphic, ilog.views.IlvPoint[], boolean) is called to create the temporary link.

If IlvSDMEngine.isDropToGroupEnabled() returns true, the new link is created as a child of the common ancestor of the source and target nodes. If IlvSDMEngine.isDropToGroupEnabled() returns false or if the source and target nodes have no common ancestor, the link is created at the top level of the model.

Specified by:

createObject in interface IlvLinkImageFactory

Parameters:

from - The start node of the link.

to - The end node of the link.

points - The points defining the link.

oriented - true if the link must end with an arrow showing the orientation.

Returns:

The new link.

See Also:

IlvMakePolyPointsInteractor.setOpaqueMode(boolean), createObjectInOpaqueMode(ilog.views.IlvGraphic, ilog.views.IlvGraphic, ilog.views.IlvPoint[], boolean)

getFromObject

public Object getFromObject()

Returns the SDM model object that will be the origin of the newly created link. This method can be used, for example, in setLinkProperties(ilog.views.sdm.IlvSDMModel, java.lang.Object), to set special properties on a link according to its origin node.

Since:

JViews 6.0

getToObject

public Object getToObject()

Returns the SDM model object that will be the destination of the newly created link. This method can be used, for example, in setLinkProperties(ilog.views.sdm.IlvSDMModel, java.lang.Object), to set special properties on a link according to its destination node.

Since:

JViews 6.0

createObjectInOpaqueMode

protected IlvLinkImage createObjectInOpaqueMode(IlvGraphic from,
                                                IlvGraphic to,
                                                IlvPoint[] points,
                                                boolean oriented)

This method is called by createObject(ilog.views.IlvGraphic, ilog.views.IlvGraphic, ilog.views.IlvPoint[], boolean) when the interactor is in Opaque mode, to create the temporary link drawn to show feedback during the interaction.

By default, this method returns a new instance of IlvGeneralLink.

You can override this method to create a different link or to customize the link.

Parameters:

from - The start node of the link.

to - The end node of the link.

points - The points defining the link.

oriented - true if the link must end with an arrow showing the orientation.

Since:

JViews 5.0

See Also:

IlvMakePolyPointsInteractor.setOpaqueMode(boolean), createObject(ilog.views.IlvGraphic, ilog.views.IlvGraphic, ilog.views.IlvPoint[], boolean)

setLinkProperties

protected void setLinkProperties(IlvSDMModel model,
                                 Object link)

Sets the initial properties of the newly created link.

This basic implementation copies the properties of the prototype object specified by a call to setPrototypeObject(ilog.views.sdm.IlvSDMModel, java.lang.Object). If no prototype object was specified, this method does nothing.

Parameters:

model - The data model of the SDM engine.

link - The link that has just been created by this interactor.

acceptOrigin

protected boolean acceptOrigin(IlvPoint p,
                               IlvGraphic fromNode)

This method tests whether a node can be the origin of the link.

Overrides:

acceptOrigin in class IlvMakeLinkInteractor

Parameters:

p - The point clicked, in manager coordinates.

fromNode - The origin node to test.

See Also:

acceptDestination(ilog.views.IlvPoint, ilog.views.IlvGraphic)

acceptDestination

protected boolean acceptDestination(IlvPoint p,
                                    IlvGraphic toNode)

This method tests whether a node can be the destination of the link.

Overrides:

acceptDestination in class IlvMakeLinkInteractor

Parameters:

p - The point clicked, in manager coordinates.

toNode - The destination node to test.

See Also:

IlvMakeLinkInteractor.isSelfLinkAllowed(), IlvMakeLinkInteractor.getFrom()

react

protected void react(IlvPoint p)

Description copied from class: IlvMakeLinkInteractor

Highlights or unhighlights the node under the specified point.

Overrides:

react in class IlvMakeLinkInteractor

Parameters:

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

getCompositeChild

protected Object getCompositeChild(IlvGraphic obj,
                                   IlvPoint p)

Internal: do not use!

highlight

protected void highlight(IlvGraphic obj)

Highlights a node when moving over it.

Overrides:

highlight in class IlvMakeLinkInteractor

Parameters:

obj - The node.

unHighlight

protected void unHighlight(IlvGraphic obj)

Unhighlights a node when moving over another node.

Overrides:

unHighlight in class IlvMakeLinkInteractor

Parameters:

obj - The node.

makePolyPoint

protected IlvGraphic makePolyPoint(IlvPoint[] points)

Called to create the link instance.

Overrides:

makePolyPoint in class IlvMakeLinkInteractor

Parameters:

points - The selected points in the object's coordinate space.

Returns:

The created link object, of type IlvLinkImage (or a subclass), or null if the factory returns a null object.

See Also:

IlvMakeLinkInteractor.setLinkFactory(ilog.views.interactor.IlvLinkImageFactory), IlvMakePolyPointsInteractor.setBackground(java.awt.Color), IlvMakePolyPointsInteractor.setForeground(java.awt.Color)

addPolyPoints

protected void addPolyPoints(IlvGraphic obj)

Adds the new link inside the grapher.

Overrides:

addPolyPoints in class IlvMakeLinkInteractor

Parameters:

obj - The new link.

See Also:

IlvMakePolyPointsInteractor.setGrapherMode(boolean)

getLinkImageClass

public Class<?> getLinkImageClass()

Implementation of IlvLinkImageFactory. Returns the class of the link that is created by createObject.

Specified by:

getLinkImageClass in interface IlvLinkImageFactory

processKeyEvent

protected void processKeyEvent(KeyEvent e)

Description copied from class: IlvManagerViewInteractor

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

Overrides:

processKeyEvent in class IlvManagerViewInteractor

Parameters:

e - The event.

See Also:

IlvManagerViewInteractor.addKeyListener(java.awt.event.KeyListener)