ilog.views.sdm.renderer.graphlayout

Class IlvSwimLanesRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.graphlayout.IlvSwimLanesRenderer

public class IlvSwimLanesRenderer
extends IlvFilterSDMRenderer

The SwimLanes renderer is responsible for displaying "swimlanes."

Swimlanes are contiguous vertical or horizontal rectangular areas that usually span the whole view. Swimlanes are most often used in conjunction with a hierarchical graph layout algorithm. This algorithm has the ability to place the nodes of the graph automatically according to swimlanes. See IlvHierarchicalLayout and IlvSwimLaneConstraint for a detailed discussion of the hierarchical layout algorithm and swimlanes.

The swimlane renderer is not responsible for configuring the graph layout algorithm so that it creates swimlanes. This is done by using a GraphLayout renderer (see IlvGraphLayoutRenderer configured to use a hierarchical algorithm, and setting the SwimLaneConstraint property in the style sheet for appropriate groups of nodes.

The swimlane renderer is merely responsible for displaying the swimlanes. For this, it reads the SwimLaneConstraint property of each node of the graph from the style sheet to determine which nodes belong to the same swimlane. The swimlanes are then displayed as colored rectangles in the background of the view, with a label on top of each swimlane.

Since the SwimLaneConstraint property is also used to configure the hierarchical layout algorithm so that it places the nodes automatically in swimlanes, performing a hierarchical layout on the graph will also place the activities correctly according to their swimlanes. Note, however, that the IlvSwimLanesRenderer can be used without performing a node layout. Conversely, you can perform a node layout using swim lanes without actually displaying the swimlanes (to do this, just set the SwimLanes property to false).

In other words, you can use the IlvSwimLanesRenderer to only display swimlanes, but then the swimlanes may overlap. Performing a node layout will also make sure that the swimlanes do not overlap, and that the nodes are arranged as hierarchical graphs inside each swimlane.

Example

Suppose all the activities of a workflow process have a participant property identifying the workflow participant that performs the activity. Swimlanes are often used to represent the participant. Each swimlane represents a participant, and the activities are placed in the swimlane of their participant. This can be implemented very simply using the following rules:

  SDM {
      SwimLanes : "true";
  }
  node.activity {
      SwimLaneConstraint : "@participant";
  }
  

The first rule tells the SDM engine to display the swimlanes using an IlvSwimLanesRenderer. The second rule says that a swimlane must be displayed around all the activities that have the same participant property.

Rendering Properties

The look of the swimlanes can be customized with the following properties:

• SwimLaneLabel: This property can be set to customize the label of the swimlanes. For example:

    node.activity[participant="rnd"] {
        SwimLaneLabel : "Research and Development";
    }
    node.activity[participant="cs"] {
        SwimLaneLabel : "Customer Support";
    }
    

  If this property is not set, the default label is the value of the SwimLaneConstraint property.
• SwimLaneColor: This property can be set to customize the colors of the swimlanes. For example:

    node.activity[participant="rnd"] {
        SwimLaneColor : "blue";
    }
    node.activity[participant="cs"] {
        SwimLaneColor : "#8800ff00"; // half-transparent green
    }
    

  If this property is not set, a different default color is automatically allocated for each swimlane, based on the values defined by #setHue, #setBrightness, #setSaturation, and #setAlpha.
• SwimLaneGraphic: This property can be set to customize the graphic object representing a swimlane completely. For example:

    node.activity {
        SwimLaneGraphic : "@#swimlane";
    }
    Subobject#swimlane {
        class : "ilog.views.sdm.graphic.IlvExpandedFrame";
        thickness : "10";
    }
    

  If this property is not set, an IlvGeneralNode is used by default.

Note: IlvLaneRenderer is a simpler implementation of this feature.

CSS example:

SwimLanes {
adjustingToView : "false";
alias : "<value>";
alpha : "2.0";
brightness : "2.0";
defaultSwimLanes : "<value>";
draggingEnabled : "false";
enabled : "false";
extendingToSides : "false";
hue : "2.0";
labelRotated : "false";
layer : "2";
margin : "2";
overlapsAllowed : "false";
parameter : "<value>";
saturation : "2.0";
scrollDelay : "2";
swimLaneColor[0] : "green";
swimLaneColor[1] : "red";
swimLaneLabel[0] : "<value>";
swimLaneLabel[1] : "<value>";
swimLaneWidth[0] : "3.0";
swimLaneWidth[1] : "3.0";
}

Property Summary

Properties

Modifier and Type	Property and Description
boolean	adjustingToView Specifies whether the swimlanes are dynamically adjusted according to the size of the view or not.
java.lang.String	alias Sets the alias of this renderer.
float	alpha Sets the alpha channel of the colors allocated by this renderer.
float	brightness Sets the brightness of the colors allocated by this renderer.
java.lang.String	defaultSwimLanes Defines the default swimlanes to display.
boolean	draggingEnabled Allows the user to drag objects from one swimlane to another.
boolean	enabled Enables or disables swimlanes.
boolean	extendingToSides Specifies whether the swimlanes extend to the sides of the view or not.
float	hue Sets the "base" hue.
boolean	labelRotated Sets whether the label is rotated.
int	layer Sets the manager layer in which the swimlane graphics will be added.
int	margin Sets the width of the margin remaining around the objects of a swimlane.
boolean	overlapsAllowed Allows or forbids the swimlanes to overlap.
java.lang.String	parameter This method gives access to a privileged parameter of the renderer, and allows this parameter to be specified quickly in the main option rule of the style sheet.
float	saturation Sets the saturation of the colors allocated by this renderer.
int	scrollDelay Sets the delay after which the swimlanes reappear when the view has been scrolled.
java.awt.Color[]	swimLaneColor Changes the color of a swimlane.
java.lang.String[]	swimLaneLabel Sets the label of the specified swimlane.
double[]	swimLaneWidth Changes the width of a swimlane.

Method Summary

Methods inherited from class java.lang.Object

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

Property Detail

adjustingToView

public boolean adjustingToView

Specifies whether the swimlanes are dynamically adjusted according to the size of the view or not.

CSS example: adjustingToView : "false";

alias

public java.lang.String alias

Sets the alias of this renderer. The alias is the symbolic name used to designate the renderer in the SDM style sheet, for example SubGraph or GraphLayout.

CSS example: alias : "<value>";

alpha

public float alpha

Sets the alpha channel of the colors allocated by this renderer.

CSS example: alpha : "2.0";

brightness

public float brightness

Sets the brightness of the colors allocated by this renderer.

CSS example: brightness : "2.0";

defaultSwimLanes

public java.lang.String defaultSwimLanes

Defines the default swimlanes to display. Default swimlanes are displayed even when there are no objects in them.

CSS example: defaultSwimLanes : "<value>";

draggingEnabled

public boolean draggingEnabled

Allows the user to drag objects from one swimlane to another.

By default, dragging is enabled.

CSS example: draggingEnabled : "false";

enabled

public boolean enabled

Enables or disables swimlanes.

By default, swimlanes are enabled.

CSS example: enabled : "false";

extendingToSides

public boolean extendingToSides

Specifies whether the swimlanes extend to the sides of the view or not.

By default, swimlanes do not extend to the sides of the view.

CSS example: extendingToSides : "false";

hue

public float hue

Sets the "base" hue. This value can be changed to modify the automatic color allocation algorithm.

CSS example: hue : "2.0";

labelRotated

public boolean labelRotated

Sets whether the label is rotated. By default (when the option is disabled), vertical swim lanes have horizontal labels, and horizontal swim lanes have, by 90 degree rotated, vertical labels. If the option is enabled, vertical swim lanes have rotated vertical labels and horizontal swim lanes have unrotated horizontal labels.

CSS example: labelRotated : "false";

layer

public int layer

Sets the manager layer in which the swimlane graphics will be added. By default, the swimlane graphics are added to layer 0.

CSS example: layer : "2";

margin

public int margin

Sets the width of the margin remaining around the objects of a swimlane. The default margin is 10.

CSS example: margin : "2";

overlapsAllowed

public boolean overlapsAllowed

Allows or forbids the swimlanes to overlap.

CSS example: overlapsAllowed : "false";

parameter

public java.lang.String parameter

This method gives access to a privileged parameter of the renderer, and allows this parameter to be specified quickly in the main option rule of the style sheet.

For example, the main parameter of the ilog.views.sdm.renderer.maps.IlvMapRenderer is the name of the map file. You can specify that you want to display a map of the USA by the single declaration:

    SDM {
      Map : "usa.ivl";
    }
  

The default implementation does nothing. Subclasses should override this method to give access to their main parameter.

CSS example: parameter : "<value>";

saturation

public float saturation

Sets the saturation of the colors allocated by this renderer.

CSS example: saturation : "2.0";

scrollDelay

public int scrollDelay

Sets the delay after which the swimlanes reappear when the view has been scrolled.

Swimlanes are normally hidden during scrolling interactions. You can use this method if you notice that swimlanes reappear in the middle of a scrolling interaction. The default delay is 200 milliseconds; specify a longer delay to get a smoother scroll.

CSS example: scrollDelay : "2";

swimLaneColor

public java.awt.Color[] swimLaneColor

Changes the color of a swimlane.

CSS example:

swimLaneColor[0] : "green";
swimLaneColor[1] : "red";

A color can either be a string representing a color or else an octal or hexadecimal string that starts with the character "#" or else a comma separated "RGB" value where the integer values are in the range 0..255.

swimLaneLabel

public java.lang.String[] swimLaneLabel

Sets the label of the specified swimlane.

CSS example:

swimLaneLabel[0] : "<value>";
swimLaneLabel[1] : "<value>";

swimLaneWidth

public double[] swimLaneWidth

Changes the width of a swimlane. Note that the other swimlanes may also be resized and/or translated.

CSS example:

swimLaneWidth[0] : "3.0";
swimLaneWidth[1] : "3.0";