ilog.views.sdm.renderer

Class IlvLaneRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvInteractorRenderer

ilog.views.sdm.renderer.IlvLaneRenderer

All Implemented Interfaces:

Serializable

public class IlvLaneRenderer
extends IlvInteractorRenderer

This class is an alternative implementation of swimlanes. It differs from the first implementation, IlvSwimLanesRenderer, on the following points:

• With the new implementation, the lanes represent objects that are explicitly contained in the data model, whereas in the first implementation, the lanes were created internally by the renderer. The advantage of this new implementation is that the properties of the lanes (position, size, label, etc.) can be stored in the data model.
• The new implementation supports hierarchical swimlanes, that is, lanes containing sub-lanes.

These new swimlanes make it possible to display processes that conform to the Business Process Modeling Notation (BPMN) standard, which requires hierarchical lanes.

This renderer looks up the following properties in the style sheet:

• LaneName: If this property is set for a node, the node is considered as a lane that will contain other nodes or links.
• LaneSize: This property is looked up for objects that are lanes, that is, on which the LaneName property is also set. It defines the height of the lane if lanes are horizontal, or the width if they are vertical.
• LaneLength: This property is looked up for objects that are lanes, that is, on which the LaneName property is also set. It defines the width of the lane if lanes are horizontal, or the height if they are vertical.
• LaneFree: This property is looked up for all objects. When true, the object is not automatically associated to a lane when dropped or moved inside it. Default is false.
• Lane: If this property is set for a node or a link, the node or the link is considered as a belonging to the lane whose name is the value of the Lane property.

Since:

JViews 6.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvLaneRenderer.ResizeLaneInteractor This class is public only to allow saving in an IVL file the contents of a grapher associated with an SDM engine and containing lanes.
static class	IlvLaneRenderer.ResizeLaneSelection A custom resize interactor on selection handles.

Field Summary

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

_interactor

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
IlvLaneRenderer() Creates a new lane renderer.
IlvLaneRenderer(IlvSDMRenderer renderer) Creates a new lane renderer with the 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.
void	afterLayout(IlvHierarchicalLayout hl) This method is used internally, do not call it directly.
void	beforeLayout(IlvHierarchicalLayout hl) This method is used internally, do not call it directly.
IlvGraphic	createNodeGraphic(IlvSDMEngine engine, Object node) If the "LaneName" rendering property is set for the node, the node is considered as being a lane.
void	customize(IlvSDMEngine engine, Object object, IlvGraphic g, String[] pseudoClasses) This method simply calls the customize method of the filtered renderer.
double	getDefaultLength() Returns the default length of lanes (that is, the width if lanes are horizontal, or the height if they are vertical).
double	getDefaultSize() Returns the default size of lanes (that is, the height if lanes are horizontal, or the width if they are vertical).
static IlvLaneRenderer	getInstance(IlvSDMEngine engine) Returns the IlvLaneRenderer instance which belongs to the specified SDM engine.
Object	getLaneNode(String name) Returns a lane node with the given name.
double	getMargin() Returns the margin between the objects inside the lane and the bounds of the lane.
Object	getNodeLane(Object node) Returns the lane representing the given model object.
double	getSpacing() Returns the minimum spacing between adjacent lanes.
double	getSublaneOffset() If lanes are horizontal, returns the offset between the left side of a sub-lane and the left side of its parent lane.
boolean	isAutomaticExtending() Tests whether the lane is in automatic extending mode.
boolean	isHorizontal() Returns true if the lanes are displayed horizontally.
boolean	isNodeReparenting() Returns true if the node reparenting mode is enabled.
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	nodeGraphicBBoxChanged(IlvSDMEngine engine, Object node, IlvGraphic graphic, IlvRect oldBBox, IlvRect newBBox, String[] pseudoClasses) This method calls the filtered renderer's nodeGraphicBBoxChanged method.
void	prepareRendering(IlvSDMEngine engine) This implementation calls the filtered renderer's prepareRendering method.
void	propertiesChanged(IlvSDMEngine engine, Object object, Collection<String> propertyNames, IlvGraphic graphic) Resets the object interactor on the object once it has been customized.
void	propertiesChanged(IlvSDMEngine engine, Object object, Collection<String> propertyNames, Object oldValue, Object newValue, IlvGraphic graphic) Deprecated. Please use propertiesChanged(IlvSDMEngine, Object, Collection, IlvGraphic) instead. Actually, oldValue and newValue have never been used.
void	removeAll(IlvSDMEngine engine) This implementation calls the filtered renderer's removeAll method.
void	removeNodeGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw) Simply calls the removeNodeGraphic method of the filtered renderer.
void	renderingDone(IlvSDMEngine engine) This implementation calls the filtered renderer's renderingDone method.
void	setAutomaticExtending(boolean automatic) Enables or disables the automatic extending mode.
void	setDefaultLength(double defaultLength) Changes the default length of lanes (that is, the width if lanes are horizontal, or the height if they are vertical).
void	setDefaultSize(double defaultSize) Changes the default size of lanes (that is, the height if lanes are horizontal, or the width if they are vertical).
void	setHorizontal(boolean horizontal) Changes the orientation of the lanes.
void	setMargin(double margin) Sets the margin between the objects inside the lane and the bounds of the lane.
void	setNodeReparenting(boolean reparent) Enables or disables the node reparenting mode.
void	setSpacing(double spacing) Changes the minimum spacing between adjacent lanes.
void	setSublaneOffset(double sublaneOffset) If lanes are horizontal, changes the offset between the left side of a sub-lane and the left side of its parent lane.

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

addViewListeners, getInteractor, getParameter, isProcessMouseMoveEvents, isShorcutEnabled, isShortcutEnabled, linkGraphicAdded, needsViewListeners, removeViewListeners, setInteractor, setParameter, setProcessMouseMoveEvents, setShorcutEnabled, setShortcutEnabled

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

addLinkGraphic, addNodeGraphic, computeBBox, createLinkGraphic, getEncapsulatedGraphic, getFilteredRenderer, getGraphicProperty, getLinkConnectionRectangle, moveResizeNodeGraphic, processServerAction, removeLinkGraphic, 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

Constructor Detail

IlvLaneRenderer

public IlvLaneRenderer()

Creates a new lane renderer.

IlvLaneRenderer

public IlvLaneRenderer(IlvSDMRenderer renderer)

Creates a new lane renderer with the specified filtered renderer.

Parameters:

renderer - the next renderer

Method Detail

getInstance

public static IlvLaneRenderer getInstance(IlvSDMEngine engine)

Returns the IlvLaneRenderer instance which belongs to the specified SDM engine.

Parameters:

engine - the SDM engine

Returns:

an instance of IlvLaneRenderer

Since:

JViews 7.5

isHorizontal

public boolean isHorizontal()

Returns true if the lanes are displayed horizontally.

Returns:

true if lanes are horizontal

setHorizontal

public void setHorizontal(boolean horizontal)

Changes the orientation of the lanes.

Parameters:

horizontal - the new value

getSpacing

public double getSpacing()

Returns the minimum spacing between adjacent lanes.

Returns:

minimum lane spacing

setSpacing

public void setSpacing(double spacing)

Changes the minimum spacing between adjacent lanes.

Parameters:

spacing - the new value

getDefaultLength

public double getDefaultLength()

Returns the default length of lanes (that is, the width if lanes are horizontal, or the height if they are vertical).

Returns:

the default lane length

setDefaultLength

public void setDefaultLength(double defaultLength)

Changes the default length of lanes (that is, the width if lanes are horizontal, or the height if they are vertical).

Parameters:

defaultLength - the new length

getDefaultSize

public double getDefaultSize()

Returns the default size of lanes (that is, the height if lanes are horizontal, or the width if they are vertical).

Returns:

the default size

setDefaultSize

public void setDefaultSize(double defaultSize)

Changes the default size of lanes (that is, the height if lanes are horizontal, or the width if they are vertical).

Parameters:

defaultSize - the new value

getMargin

public double getMargin()

Returns the margin between the objects inside the lane and the bounds of the lane.

Returns:

the margin

setMargin

public void setMargin(double margin)

Sets the margin between the objects inside the lane and the bounds of the lane.

Parameters:

margin - the new margin value

getSublaneOffset

public double getSublaneOffset()

If lanes are horizontal, returns the offset between the left side of a sub-lane and the left side of its parent lane. If lanes are vertical, returns the offset between the top side of a sub-lane and the top side of its parent lane. This offset is used to leave room for a label.

Returns:

offset between sublanes

setSublaneOffset

public void setSublaneOffset(double sublaneOffset)

If lanes are horizontal, changes the offset between the left side of a sub-lane and the left side of its parent lane. If lanes are vertical, changes the offset between the top side of a sub-lane and the top side of its parent lane. This offset is used to leave room for a label.

Parameters:

sublaneOffset - the new value

setAutomaticExtending

public void setAutomaticExtending(boolean automatic)

Enables or disables the automatic extending mode. If the automatic extending mode is enabled, the lane is automatically extended to fully contain all its nodes when they are moved or resized.

Parameters:

automatic - true if the lane is automatically extended to fully contain all its nodes when they are moved or resized.

Since:

JViews 8.8

See Also:

isAutomaticExtending()

Internal: do not use!

isAutomaticExtending

public boolean isAutomaticExtending()

Tests whether the lane is in automatic extending mode.

Returns:

true if the lane is automatically extended to fully contain its nodes when they are moved or resized.

Since:

JViews 8.8

See Also:

setAutomaticExtending(boolean)

Internal: do not use!

setNodeReparenting

public void setNodeReparenting(boolean reparent)

Enables or disables the node reparenting mode. When the node reparenting is allowed, nodes can be reparented when they are moved. In that case, if a node is moved outside its parent lane, it is detached from that lane. If its new location intersects another lane, the moved node is attached to this new lane.

Parameters:

reparent - If true, nodes can be reparented when they are moved.

Since:

JViews 8.8

See Also:

isNodeReparenting()

isNodeReparenting

public boolean isNodeReparenting()

Returns true if the node reparenting mode is enabled.

Returns:

true the node reparenting mode is enabled.

Since:

JViews 8.8

See Also:

setNodeReparenting(boolean)

prepareRendering

public void prepareRendering(IlvSDMEngine engine)

This implementation calls the filtered renderer's prepareRendering method.

Overrides:

prepareRendering in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

createNodeGraphic

public IlvGraphic createNodeGraphic(IlvSDMEngine engine,
                                    Object node)

If the "LaneName" rendering property is set for the node, the node is considered as being a lane.

If the "Lane" rendering property is set for the node, the node is considered as belonging to the specified lane.

Overrides:

createNodeGraphic in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine

node - The node whose graphic object is being created.

removeNodeGraphic

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

Simply calls the removeNodeGraphic method of the filtered renderer.

Overrides:

removeNodeGraphic in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine associated with the grapher from which the graphic object will be removed.

node - The node that has been removed or modified in the data model.

graphic - The graphic object that must be removed from the grapher.

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

customize

public void customize(IlvSDMEngine engine,
                      Object object,
                      IlvGraphic g,
                      String[] pseudoClasses)

This method simply calls the customize method of the filtered renderer.

Overrides:

customize in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

object - The data object that the graphic object represents.

g - The graphic object to customize.

pseudoClasses - The pseudo-classes of the object. This parameter can be null.

nodeGraphicBBoxChanged

public void nodeGraphicBBoxChanged(IlvSDMEngine engine,
                                   Object node,
                                   IlvGraphic graphic,
                                   IlvRect oldBBox,
                                   IlvRect newBBox,
                                   String[] pseudoClasses)

This method calls the filtered renderer's nodeGraphicBBoxChanged method.

Overrides:

nodeGraphicBBoxChanged in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

node - The data node that the graphic object represents.

graphic - The graphic object that has been moved and/or resized.

oldBBox - The bounding box of the graphic object before the change.

newBBox - The bounding box of the graphic object after the change.

pseudoClasses - The pseudo-classes of the object. This parameter can be null.

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 IlvInteractorRenderer

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.

See Also:

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

renderingDone

public void renderingDone(IlvSDMEngine engine)

This implementation calls the filtered renderer's renderingDone method.

Overrides:

renderingDone in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

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 IlvInteractorRenderer

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.

propertiesChanged

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

Deprecated. Please use propertiesChanged(IlvSDMEngine, Object, Collection, IlvGraphic) instead. Actually, oldValue and newValue have never been used.

Adjusts lanes if needed

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.

oldValue - The old value of the property.

newValue - The new value of the property.

graphic - The graphic object associated with object.

Since:

JViews 8.5

removeAll

public void removeAll(IlvSDMEngine engine)

This implementation calls the filtered renderer's removeAll method.

Overrides:

removeAll in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

getLaneNode

public Object getLaneNode(String name)

Returns a lane node with the given name.

Parameters:

name - the lane name

Returns:

the model object representing the lane

Since:

JViews 7.5

getNodeLane

public Object getNodeLane(Object node)

Returns the lane representing the given model object.

Parameters:

node - the model object

Returns:

a Lane object (private type)

Since:

JViews 7.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.

Overrides:

acceptInteractor in class IlvInteractorRenderer

Parameters:

engine - The SDM engine.

object - The data object.

graphic - The graphic object.

Returns:

true if object accepts interaction

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.

Overrides:

acceptShortcut in class IlvInteractorRenderer

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

beforeLayout

public void beforeLayout(IlvHierarchicalLayout hl)

This method is used internally, do not call it directly.

Parameters:

hl - the new value

Internal: do not use!

afterLayout

public void afterLayout(IlvHierarchicalLayout hl)

This method is used internally, do not call it directly.

Parameters:

hl - the layout

Internal: do not use!