ilog.views.sdm.renderer

Class IlvSubGraphRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvSubGraphRenderer

public class IlvSubGraphRenderer
extends IlvFilterSDMRenderer

The class IlvSubGraphRenderer is a filtering renderer that displays subgraphs as special nodes that can be expanded and collapsed.

This renderer is useful when the data model is hierarchical, that is, when some of its nodes contain subgraphs.

Each subgraph is initially displayed with a frame around it. The frame can be collapsed; it is then replaced with a single node (as defined in the style sheet), and the nodes and links of the subgraph become invisible. The collapsed node can be expanded to show the subgraph again.

To expand or collapse a subgraph node in a view, simply click the "expand" or "collapse" icon displayed in the upper-left corner of the subgraph node.

The subgraph renderer can be customized using the following rendering properties:

• Expandable : "true"|"false";
  Controls which nodes are expandable and collapsible. By default, all nodes that have children are expandable.
• InitiallyExpanded : "true"|"false";
  Controls whether the subgraph is initially expanded or collapsed.
• FrameMargin : "<double>,<double>,<double>,<double>"; or FrameMargin : "<double>";
  Controls the margins between the subgraph's bounding rectangle and the border of the expanded node's frame. You can specify either four values (for the left, top, right, and bottom margins), or only a single value which will then be used for the four sides.
• FrameGraphic : "@#<graphic>"
  Allows you to specify a custom graphic object for the frame. By default, an IlvExpandedFrame is used. You can also use an IlvDefaultManagerFrameGraphic to get the default look of submanagers, with a title bar displayed at the top of the submanager. For convenience, you can use the shortcut:

        FrameGraphic : "default";
    

  which is equivalent to

        FrameGraphic : "ilog.views.sdm.graphic.IlvDefaultManagerFrameGraphic";
    

  To get the effect of a IlvConstantModeManagerFrame you can use the shortcut:

        FrameGraphic : "constantmode";
    

  which is equivalent to

    node {
      FrameGraphic : "@+FrameGraphic";
      DelegateToManagerFrame : "true";
    }
    Subobject#FrameGraphic {
      class: "ilog.views.sdm.graphic.IlvDefaultManagerFrameGraphic";
      managerFrame: "@+Frame";
    }
    Subobject#Frame {
      class: "ilog.views.IlvConstantModeManagerFrame";
      minimumMargin : "5";
    }
    

• PlusGraphic : "@#<graphic>"
  Allows you to specify a custom graphic object for the "expand" icon. By default, an icon representing a horizontal handle is used.
• MinusGraphic : "@#<graphic>"
  Allows you to specify a custom graphic object for the "collapse" icon. By default, an icon representing a vertical handle is used.
• PlusGraphicPosition : "<position>"
  Allows you to specify the position of the "expand" icon relative to the collapsed graphic's bounding rectangle. The valid positions are: TopLeft, TopRight, BottomLeft, BottomRight, Top, Bottom, Left, Right, and Center. By default, the icon is in the top left corner.
• MinusGraphicPosition : "<position>"
  Allows you to specify the position of the "collapse" icon relative to the expanded frame's bounding rectangle. The valid positions are: TopLeft, TopRight, BottomLeft, BottomRight, Top, Bottom, Left, Right, and Center. By default, the icon is in the top left corner.
• PlusGraphicOffsetX : "<double>"
  Allows you to specify an additional offset in x direction to fine tune the the position of the "expand" icon.
• PlusGraphicOffsetY : "<double>"
  Allows you to specify an additional offset in y direction to fine tune the the position of the "expand" icon.
• MinusGraphicOffsetX : "<double>"
  Allows you to specify an additional offset in x direction to fine tune the the position of the "collapse" icon.
• MinusGraphicOffsetY : "<double>"
  Allows you to specify an additional offset in y direction to fine tune the the position of the "collapse" icon.
• DelegateToManagerFrame : "true"|"false";
  Is an expert option only allowed when the frame graphic is a IlvDefaultManagerFrameGraphic encapsulating a manager frame. If the flag is true, it uses the margin specification of the manager frame instead of the margin specification specified by FrameMargin. This is in particular needed for IlvConstantModeManagerFrame encapsulated inside IlvDefaultManagerFrameGraphic.

Examples: The following rule states that only those nodes whose type property is equal to "compound" are expandable.

  node[type!="compound"] {
    Expandable : "false";
  }
  

The following rules say the subgraphs should initially appear collapsed, and define a custom look for the expandable nodes: a different margin, a red rectangle for the frame, and icons instead of labels for the "expand" and "collapse" graphics.

  node[type="compound"] {
    InitiallyExpanded : "false";
    FrameMargin : "10";
    FrameGraphic : "@#rectangle";
    PlusGraphic : "@#plus";
    MinusGraphic : "@#minus";
  }
  Subobject#rectangle {
    class : "ilog.views.sdm.graphic.IlvGraphicFactories$Rectangle";
    foreground : "green";
  }
  Subobject#plus {
    class : "ilog.views.sdm.graphic.IlvGraphicFactories$Icon";
    imageLocation : "plus.gif";
  }
  Subobject#minus {
    class : "ilog.views.sdm.graphic.IlvGraphicFactories$Icon";
    imageLocation : "minus.gif";
  }
  

You can also customize the expandable nodes differently depending on whether they are expanded or collapsed. To do this, you must use the pseudoclasses "expanded" and "collapsed".

For example, the following rules put different tooltips on the nodes depending on whether they are expanded or collapsed:

  node:expanded {
    toolTipText : "Click on '-' to collapse";
  }
  node:collapsed {
    toolTipText : "Click on '+' to expand";
  }
  

Since JViews 5.5, the IlvSubGraphRenderer class provides a new "load on demand" mode, which lets you create the graphic objects inside a subgraph only when the subgraph is first expanded. See the #setLoadOnDemand method.

Note: The FrameGraphic, PlusGraphic, and MinusGraphic properties are not added in the manager.

Once created, each property change on a subgraph will customize the grapher and the expanded frame (or collapsed node, according to the subgraph expanded state). This class is functionally equivalent to the class IlvExpandCollapseRenderer, but it uses the subgraph functionalities available since Perforce JViews 5.0 to implement the expandable nodes.

CSS example:

ilvSubGraphRenderer {
class : "ilog.views.sdm.renderer.IlvSubGraphRenderer";
alias : "<value>";
expandCollapseEnabled : "false";
frameZoomable : "false";
leafToContainerEnabled : "false";
loadOnDemand : "false";
parameter : "<value>";
savingExpandedState : "false";
subObjectsSelectionAllowed : "false";
updatingPositionsOnExpand : "false";
}

Property Summary

Properties

Modifier and Type	Property and Description
java.lang.String	alias Sets the alias of this renderer.
java.lang.String	class Default constructor.
boolean	expandCollapseEnabled Enables or disables the expand/collapse interaction on subgraphs.
boolean	frameZoomable Specifies whether the frames and the expand/collapse icons drawn around subgraphs are zoomable or not.
boolean	leafToContainerEnabled Controls whether leaves are automatically converted to container when a first new child is added.
boolean	loadOnDemand Enables or disables load-on-demand.
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.
boolean	savingExpandedState Specifies whether or not the expanded state of a subgraph is saved to the data model.
boolean	subObjectsSelectionAllowed Allows or forbids the selection of subobjects contained in an expanded node.
boolean	updatingPositionsOnExpand Specifies whether or not the positions of subgraphs and their children must be updated when subgraphs are expanded or collapsed.

Method Summary

Methods inherited from class java.lang.Object

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

Property Detail

class

public java.lang.String class

Default constructor.

CSS example: class : "ilog.views.sdm.renderer.IlvSubGraphRenderer";

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>";

expandCollapseEnabled

public boolean expandCollapseEnabled

Enables or disables the expand/collapse interaction on subgraphs.

CSS example: expandCollapseEnabled : "false";

frameZoomable

public boolean frameZoomable

Specifies whether the frames and the expand/collapse icons drawn around subgraphs are zoomable or not. By default, frames are not zoomable.

CSS example: frameZoomable : "false";

leafToContainerEnabled

public boolean leafToContainerEnabled

Controls whether leaves are automatically converted to container when a first new child is added. Default is false, which means leaves are left unchanged when a first new child is added to them.

CSS example: leafToContainerEnabled : "false";

loadOnDemand

public boolean loadOnDemand

Enables or disables load-on-demand. In load-on-demand mode, subnodes of a collapsed subgraph are created only when the subgraph is first expanded. This technique usually gives better startup times, at the expense of a slower expansion.

CSS example: loadOnDemand : "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>";

savingExpandedState

public boolean savingExpandedState

Specifies whether or not the expanded state of a subgraph is saved to the data model. The expanded state is saved by updating the rendering property "InitiallyExpanded".

So, for example, if the SDM style sheet contains a rule like the following:

  node.process {
    Expandable : "true";
    InitiallyExpanded : "@expanded";
  }
  

then, when a process node is expanded or collapsed, the expanded property of the node will be updated in the data model.

Note that if the InitiallyExpanded property is set to a constant value, for example:

    InitiallyExpanded : "false";
  

then the node will still be collapsed the next time the style sheet is applied, even though the data model has been updated.

CSS example: savingExpandedState : "false";

subObjectsSelectionAllowed

public boolean subObjectsSelectionAllowed

Allows or forbids the selection of subobjects contained in an expanded node.

CSS example: subObjectsSelectionAllowed : "false";

updatingPositionsOnExpand

public boolean updatingPositionsOnExpand

Specifies whether or not the positions of subgraphs and their children must be updated when subgraphs are expanded or collapsed.

Normally, the position of a subgraph are consistent with the positions of its children. That is to say, the coordinates of the subgraph are such that the subgraph is initially centered with the bounding box of all its children. This ensures that the positions are always up to date when subgraphs are expanded or collapsed.

Normally, if you edit the data model using the built-in editing capabilities of the SDM engine (for example in the Workflow Modeler), this condition is always true.

If the data model is modified directly, though, this condition may not be true any more, and the positions of subgraphs and their children may be inconsistent. This may have unexpected side effects when the nodes are modified. A typical side effect is that subgraphs may be translated when you change one of their properties.

In that case, you can set this property to true to have the SDM engine update the positions on every expand or collapse operation.

The property is set to false by default. Note that setting the property to true may slow down expand and collapse operations, because of the additional update of the data model.

CSS example: updatingPositionsOnExpand : "false";