ilog.views.sdm.renderer

Class IlvInteractorRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvInteractorRenderer

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvCompositeRenderer, IlvExpandCollapseRenderer, IlvLaneRenderer, IlvLegendRenderer

public class IlvInteractorRenderer
extends IlvFilterSDMRenderer

The class IlvInteractorRenderer is a filtering renderer that puts an object interactor on every graphic object representing a node or a link of the data model.

This class is mostly used as a base class for other renderers that set built-in interactors on nodes and links.

The interactor renderer can also be used as-is. For this, you must specify the class of the object interactor that you want to be set on the objects. To do so, you use the interactor property or the Interactor rendering property. For example:

 SDM {
   Interactor : "true";
 }
 Interactor {
   interactor : "mypackage.MyInteractor";
 }
 node[special="true"] {
   Interactor : "mypackage.MySpecialInteractor";
 }
 

If the Interactor rendering property is set to an empty string, no interactor will be set on the object.

Normally, Rogue Wave JViews never calls object interactors when a view interactor is active on a manager view. To overcome this, the interactor renderer provides a "shortcut" mechanism that propagates certain types of events to the object interactor, even if a view interactor is active. See acceptShortcut(ilog.views.sdm.IlvSDMEngine, ilog.views.IlvManagerView, java.awt.event.InputEvent).

Since:

JViews 4.0

See Also:

IlvObjectInteractor, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IlvObjectInteractor	_interactor The interactor that this renderer will put on graphic objects.

Fields inherited from class ilog.views.sdm.renderer.IlvFilterSDMRenderer

_renderer

Fields inherited from class ilog.views.sdm.renderer.IlvSDMRenderer

PSEUDOCLASS_PREFIX

Constructor Summary

Constructors

Constructor and Description
IlvInteractorRenderer() Creates a new interactor renderer with a null filtered renderer.
IlvInteractorRenderer(IlvSDMRenderer renderer) Creates a new interactor renderer for a specified filtered renderer.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptInteractor(IlvSDMEngine engine, Object object, IlvGraphic graphic) This method allows subclasses to filter the objects on which the interactor will be set.
protected boolean	acceptShortcut(IlvSDMEngine engine, IlvManagerView view, InputEvent event) The intent of this method is to allow the object interactor installed by this renderer to be activated even if a view interactor is installed on the manager view.
protected void	addViewListeners(IlvManagerView view) Adds the mouse listeners that handle shortcuts.
String	getInteractor() Returns the class name of the interactor that will be put on the graphic objects created by the filtered renderer.
String	getParameter() This method calls getInteractor().
boolean	isProcessMouseMoveEvents() Returns true if MouseMove events are processed as well.
static boolean	isShorcutEnabled() Deprecated. Use isShortcutEnabled() instead
static boolean	isShortcutEnabled() Tests if shortcuts are enabled for all object interactors at once.
void	linkGraphicAdded(IlvSDMEngine engine, Object link, IlvGraphic graphic, boolean redraw) Sets the object interactor on the link once it has been added in the grapher.
protected boolean	needsViewListeners() Returns true, because this renderer needs to install mouse listeners on all the views to handle shortcuts.
void	nodeGraphicAdded(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw) Sets the object interactor on the node once it has been added in the grapher.
void	propertiesChanged(IlvSDMEngine engine, Object object, Collection<String> propertyNames, IlvGraphic graphic) Resets the object interactor on the object once it has been customized.
protected void	removeViewListeners(IlvManagerView view) Adds the mouse listeners that handle shortcuts.
void	setInteractor(String interactor) Changes the interactor that will be put on the graphic objects created by the filtered renderer.
void	setParameter(String parameter) This method calls setInteractor(java.lang.String).
void	setProcessMouseMoveEvents(boolean processMouseMoveEvents) Sets the processMouseMoveEvents to set.
static void	setShorcutEnabled(boolean newValue) Deprecated. Use setShortcutEnabled(boolean) instead
static void	setShortcutEnabled(boolean newValue) Sets if shortcuts are enabled for all interactors at once.

Methods inherited from class ilog.views.sdm.renderer.IlvFilterSDMRenderer

addLinkGraphic, addNodeGraphic, computeBBox, createLinkGraphic, createNodeGraphic, customize, getEncapsulatedGraphic, getFilteredRenderer, getGraphicProperty, getLinkConnectionRectangle, moveResizeNodeGraphic, nodeGraphicBBoxChanged, prepareRendering, processServerAction, removeAll, removeLinkGraphic, removeNodeGraphic, renderingDone, setFilteredRenderer, updateObjectProperties

Methods inherited from class ilog.views.sdm.renderer.IlvSDMRenderer

callMoveResizeNodeGraphic, convert, convert, getAlias, getAuxiliaryBean, getAuxiliaryBeans, getEngine, getLinkConnectionRectangle, getLocation, propertyChanged, setAlias, setEngine, setLayerName

Methods inherited from class java.lang.Object

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

Field Detail

_interactor

protected IlvObjectInteractor _interactor

The interactor that this renderer will put on graphic objects.

Constructor Detail

IlvInteractorRenderer

public IlvInteractorRenderer(IlvSDMRenderer renderer)

Creates a new interactor renderer for a specified filtered renderer.

Parameters:

renderer - The filtered renderer.

IlvInteractorRenderer

public IlvInteractorRenderer()

Creates a new interactor renderer with a null filtered renderer.

Method Detail

setInteractor

public void setInteractor(String interactor)

Changes the interactor that will be put on the graphic objects created by the filtered renderer.

Parameters:

interactor - The fully qualified class name of the new interactor, for example: "ilog.views.objectinteractor.IlvButtonInteractor".

getInteractor

public String getInteractor()

Returns the class name of the interactor that will be put on the graphic objects created by the filtered renderer.

Returns:

interactor class name

setParameter

public void setParameter(String parameter)

This method calls setInteractor(java.lang.String). So, you can simply customize the interactor renderer as follows:

 SDM {
   Interactor : "ilog.views.objectinteractor.IlvButtonInteractor";
 }
 

Overrides:

setParameter in class IlvSDMRenderer

Parameters:

parameter - The interactor class name.

getParameter

public String getParameter()

This method calls getInteractor().

Overrides:

getParameter in class IlvSDMRenderer

See Also:

setInteractor(java.lang.String)

nodeGraphicAdded

public void nodeGraphicAdded(IlvSDMEngine engine,
                             Object node,
                             IlvGraphic graphic,
                             boolean redraw)

Sets the object interactor on the node once it has been added in the grapher.

Overrides:

nodeGraphicAdded in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine associated with the grapher in which the graphic object has been added.

node - The node that is being translated into an IlvGraphic.

graphic - The graphic object returned by createNodeGraphic.

redraw - If true, the region covered by the new graphic object must be redrawn.

Since:

JViews 5.0

See Also:

IlvSDMRenderer.addNodeGraphic(ilog.views.sdm.IlvSDMEngine, java.lang.Object, ilog.views.IlvGraphic, boolean)

linkGraphicAdded

public void linkGraphicAdded(IlvSDMEngine engine,
                             Object link,
                             IlvGraphic graphic,
                             boolean redraw)

Sets the object interactor on the link once it has been added in the grapher.

Overrides:

linkGraphicAdded in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine associated with the grapher in which the graphic object has been added.

link - The link that is being translated into an IlvGraphic.

graphic - The graphic object returned by createLinkGraphic.

redraw - If true, the region covered by the new graphic object must be redrawn.

Since:

JViews 5.0

See Also:

IlvSDMRenderer.addLinkGraphic(ilog.views.sdm.IlvSDMEngine, java.lang.Object, ilog.views.IlvGraphic, boolean)

propertiesChanged

public void propertiesChanged(IlvSDMEngine engine,
                              Object object,
                              Collection<String> propertyNames,
                              IlvGraphic graphic)

Resets the object interactor on the object once it has been customized.

Overrides:

propertiesChanged in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine associated with the grapher in which the graphic object is displayed.

object - The data object whose property has changed.

propertyNames - The names of the properties that have been modified.

graphic - The graphic object associated with object.

Since:

JViews 8.5

acceptInteractor

protected boolean acceptInteractor(IlvSDMEngine engine,
                                   Object object,
                                   IlvGraphic graphic)

This method allows subclasses to filter the objects on which the interactor will be set.

If the method returns true, the interactor will be installed on the graphic object representing the specified data object. Otherwise, no interactor will installed on this object.

The default implementation always returns true, which means that the interactor is installed on all objects.

Parameters:

engine - The SDM engine.

object - The data object.

graphic - The graphic object.

Returns:

true if object accepts interaction

needsViewListeners

protected boolean needsViewListeners()

Returns true, because this renderer needs to install mouse listeners on all the views to handle shortcuts.

Overrides:

needsViewListeners in class IlvSDMRenderer

Since:

JViews 5.5

See Also:

IlvSDMRenderer.addViewListeners(ilog.views.IlvManagerView), IlvSDMRenderer.removeViewListeners(ilog.views.IlvManagerView)

addViewListeners

protected void addViewListeners(IlvManagerView view)

Adds the mouse listeners that handle shortcuts.

Overrides:

addViewListeners in class IlvSDMRenderer

Parameters:

view - The manager view.

Since:

JViews 5.5

See Also:

IlvSDMRenderer.needsViewListeners()

removeViewListeners

protected void removeViewListeners(IlvManagerView view)

Adds the mouse listeners that handle shortcuts.

Overrides:

removeViewListeners in class IlvSDMRenderer

Parameters:

view - The manager view.

Since:

JViews 5.5

See Also:

IlvSDMRenderer.needsViewListeners()

acceptShortcut

protected boolean acceptShortcut(IlvSDMEngine engine,
                                 IlvManagerView view,
                                 InputEvent event)

The intent of this method is to allow the object interactor installed by this renderer to be activated even if a view interactor is installed on the manager view.

If a view interactor is installed on the reference view of the SDM engine, this method is called every time a mouse or keyboard event occurs in the reference view. If the method returns true, the event will be sent to the interactor of the object where the event occurred. If the method returns false, the object interactor is not called.

The default implementation returns true if the event is a middle- or right-click.

Parameters:

engine - The SDM engine attached to the reference view in which the event occurred.

view - The reference view.

event - The event received by the manager view while a view interactor was active.

Returns:

true if object interactor has priority over view interactor

setShorcutEnabled

@Deprecated
public static void setShorcutEnabled(boolean newValue)

Deprecated. Use setShortcutEnabled(boolean) instead

Sets if shortcuts are enabled for all interactors at once.

Parameters:

newValue - Set to true to enable shortcuts.

Since:

JViews 8.0

See Also:

acceptShortcut(IlvSDMEngine, IlvManagerView, InputEvent)

setShortcutEnabled

public static void setShortcutEnabled(boolean newValue)

Sets if shortcuts are enabled for all interactors at once.

Parameters:

newValue - Set to true to enable shortcuts.

Since:

JViews 8.1

See Also:

acceptShortcut(IlvSDMEngine, IlvManagerView, InputEvent)

isShorcutEnabled

@Deprecated
public static boolean isShorcutEnabled()

Deprecated. Use isShortcutEnabled() instead

Tests if shortcuts are enabled for all object interactors at once.

Returns:

If shortcuts are enabled, true is returned.

Since:

JViews 8.0

isShortcutEnabled

public static boolean isShortcutEnabled()

Tests if shortcuts are enabled for all object interactors at once.

Returns:

If shortcuts are enabled, true is returned.

Since:

JViews 8.1

isProcessMouseMoveEvents

public boolean isProcessMouseMoveEvents()

Returns true if MouseMove events are processed as well.

Returns:

the processMouseMoveEvents.

Since:

JViews 7.5

setProcessMouseMoveEvents

public void setProcessMouseMoveEvents(boolean processMouseMoveEvents)

Sets the processMouseMoveEvents to set. If true, mouse motion events are processed, which can slow down the application. If false, mouse motion events are ignored. Default is false.

Parameters:

processMouseMoveEvents - The processMouseMoveEvents to set

Since:

JViews 7.5