IlvSubGraphRenderer (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.sdm.renderer.IlvSDMRenderer
- - ilog.views.sdm.renderer.IlvFilterSDMRenderer
  - - ilog.views.sdm.renderer.IlvSubGraphRenderer

All Implemented Interfaces:

Serializable
```
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(boolean) 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.
Since:

JViews 5.0

See Also:

IlvManager, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IlvSubGraphRenderer.CollapsedGraphic` This graphic object encapsulates the collapsed representation of a subgraph.
`static class`	`IlvSubGraphRenderer.ExpandCollapseIcon` Deprecated. Since JViews 8.8, this class is no longer needed
`static class`	`IlvSubGraphRenderer.ExpandCollapseInteractor` Since JViews 8.5, this class is the mouse listener that manages to expand/collapse subgraphes.
`static class`	`IlvSubGraphRenderer.GraphicManagerFrame` This class draws the graphic border of `IlvGrapher` objects that represent subgraphs.
`static class`	`IlvSubGraphRenderer.SubGrapher` This class is not intended to be directly used by a user application.

Field Summary

Fields
Modifier and Type Field and Description

static String GRAPHER
- Fields inherited from class ilog.views.sdm.renderer.IlvFilterSDMRenderer
  _renderer
- Fields inherited from class ilog.views.sdm.renderer.IlvSDMRenderer
  PSEUDOCLASS_PREFIX

Fields
Modifier and Type	Field and Description
`static String`	`GRAPHER`

Constructor Summary

Constructors
Constructor and Description
`IlvSubGraphRenderer()` Creates a new subgraph renderer with a `null` filtered renderer.
`IlvSubGraphRenderer(IlvSDMRenderer renderer)` Creates a new subgraph renderer with a specified filtered renderer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addLinkGraphic(IlvSDMEngine engine, Object link, IlvGraphic graphic, boolean redraw)` If the link is contained in a subgraph, adds the graphic link to the `IlvGrapher` representing the subgraph.
`void`	`addNodeGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw)` If the node is contained in a subgraph, adds the graphic node to the `IlvGrapher` representing the subgraph.
`protected void`	`addViewListeners(IlvManagerView view)` This method can be overridden to add view listeners on any view attached to an SDM engine.
`IlvGraphic`	`createNodeGraphic(IlvSDMEngine engine, Object node)` If the node is the parent of a subgraph, creates an `IlvGrapher` that will contain the nodes and links of the subgraph.
`protected IlvManager`	`createSubManager()` Factory to create the submanager.
`void`	`customize(IlvSDMEngine engine, Object object, IlvGraphic g, String[] pseudoClass)` If the object is an `IlvGrapher`, this method customizes either the `IlvGrapher`'s border, or its collapsed graphic object, depending on whether the grapher is expanded or collapsed.
`IlvGraphic`	`getEncapsulatedGraphic(IlvGraphic g)` If the object is an `IlvGrapher`, this method returns either the `IlvGrapher`'s border, or its collapsed graphic object, depending on whether the grapher is expanded or collapsed.
`Object`	`getGraphicProperty(IlvSDMEngine engine, Object object, String property, String[] pseudoClass, Class<?> targetClass)` Modifies the `Layer` rendering property so that subgraphs are displayed on top of their frames.
`IlvRect`	`getLinkConnectionRectangle(IlvSDMEngine engine, IlvGraphic graphic, IlvTransformer t, IlvLinkConnector lc)` This method is overridden to take into account the special expandable nodes.
`boolean`	`isExpandCollapseEnabled()` Returns `true` if the expand/collapse interaction on subgraphs is enabled.
`boolean`	`isExpanded(IlvSDMEngine engine, Object object)` Tests whether a data node is expanded or collapsed.
`boolean`	`isForcingRenderingOnExpandCollapse()`
`boolean`	`isFrameZoomable()` Returns `true` if the frames and the expand/collapse icons drawn around subgraphs are zoomable, or `false` if they are not zoomable.
`boolean`	`isLeafToContainerEnabled()` Returns true whether leaves are automatically converted to container when a first new child is added.
`boolean`	`isLoadOnDemand()` Returns `true` if load-on-demand is enabled, or `false` otherwise.
`boolean`	`isSavingExpandedState()` Returns `true` if the expanded state of a subgraph is saved to the data model, or `false` otherwise.
`boolean`	`isSubObjectsSelectionAllowed()` Returns `true` if the user is allowed to select and edit the subobjects contained in an expanded node, or `false` otherwise.
`boolean`	`isUpdatingPositionOnExpand()` Deprecated. replaced by `isUpdatingPositionsOnExpand()`
`boolean`	`isUpdatingPositionsOnExpand()` Returns `true` if the positions of subgraphs and their children are updated when subgraphs are expanded or collapsed.
`void`	`linkGraphicAdded(IlvSDMEngine engine, Object link, IlvGraphic graphic, boolean redraw)` Makes the graphic object unselectable if `setSubObjectsSelectionAllowed(false)` was called.
`protected void`	`moveResizeNodeGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, IlvRect newBBox, int anchor)` Move the graphic to its final position
`protected boolean`	`needsViewListeners()` This method can be overridden to specify that this renderer needs to add listeners on all the views attached to the grapher of the SDM engine.
`void`	`nodeGraphicAdded(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw)` Makes the graphic object unselectable if `setSubObjectsSelectionAllowed(false)` was called.
`void`	`nodeGraphicBBoxChanged(IlvSDMEngine engine, Object node, IlvGraphic graphic, IlvRect oldBBox, IlvRect newBBox, String[] pseudoClasses)` Updates the location of a node.
`boolean`	`processServerAction(int x, int y, IlvManagerView view)` Processes clicks in the expand/collapse icons from the client-side of a web application.
`void`	`propertiesChanged(IlvSDMEngine engine, Object object, Collection<String> propertyNames, IlvGraphic graphic)` Updates the graphic representation of a data object.
`protected void`	`removeViewListeners(IlvManagerView view)` This method can be overridden to remove view listeners from any view attached to an SDM engine.
`static void`	`setDefaultUpdatingPositionsOnExpand(boolean updating)`
`void`	`setExpandCollapseEnabled(boolean enabled)` Enables or disables the expand/collapse interaction on subgraphs.
`void`	`setExpanded(IlvSDMEngine engine, Object object, boolean expand, boolean redraw)` Expands or collapses a node.
`void`	`setForcingRenderingOnExpandCollapse(boolean force)` Specifies whether the `renderingDone(IlvSDMEngine engine)` method of the main SDM Renderer must be called, regardless the value of `IlvSDMEngine.getRenderingDoneMode()`.
`void`	`setFrameZoomable(boolean zoomable)` Specifies whether the frames and the expand/collapse icons drawn around subgraphs are zoomable or not.
`void`	`setLeafToContainerEnabled(boolean leafToContainerEnabled)` Controls whether leaves are automatically converted to container when a first new child is added.
`void`	`setLoadOnDemand(boolean loadOnDemand)` Enables or disables load-on-demand.
`void`	`setSavingExpandedState(boolean savingExpandedState)` Specifies whether or not the expanded state of a subgraph is saved to the data model.
`void`	`setSubObjectsSelectionAllowed(boolean allowed)` Allows or forbids the selection of subobjects contained in an expanded node.
`void`	`setUpdatingPositionsOnExpand(boolean update)` Specifies whether or not the positions of subgraphs and their children must be updated when subgraphs are expanded or collapsed.
`void`	`updateObjectProperties(IlvSDMEngine engine, Object object, String property, Object value, String[] pseudoClasses)` This method converts the `x` and `y` coordinates of objects contained in subgraphs from absolute coordinates to relative coordinates in the subgrapher.

Methods inherited from class ilog.views.sdm.renderer.IlvFilterSDMRenderer
computeBBox, createLinkGraphic, getFilteredRenderer, prepareRendering, removeAll, removeLinkGraphic, removeNodeGraphic, renderingDone, setFilteredRenderer

Methods inherited from class ilog.views.sdm.renderer.IlvSDMRenderer
callMoveResizeNodeGraphic, convert, convert, getAlias, getAuxiliaryBean, getAuxiliaryBeans, getEngine, getLinkConnectionRectangle, getLocation, getParameter, propertyChanged, setAlias, setEngine, setLayerName, setParameter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GRAPHER
```
public static final String GRAPHER
```
    See Also:
    
    Constant Field Values
    
    Internal: do not use!
- Constructor Detail
  - IlvSubGraphRenderer
```
public IlvSubGraphRenderer(IlvSDMRenderer renderer)
```
    Creates a new subgraph renderer with a specified filtered renderer.
    
    Parameters:
    
    renderer - The filtered renderer.
  - IlvSubGraphRenderer
```
public IlvSubGraphRenderer()
```
    Creates a new subgraph renderer with a null filtered renderer.
- Method Detail
  - setSubObjectsSelectionAllowed
```
public void setSubObjectsSelectionAllowed(boolean allowed)
```
    Allows or forbids the selection of subobjects contained in an expanded node.
    
    Parameters:
    
    allowed - If true, the user will be able to select and edit the subobjects contained in an expanded node. Otherwise, the subobjects will not be selectable.
  - isSubObjectsSelectionAllowed
```
public boolean isSubObjectsSelectionAllowed()
```
    Returns true if the user is allowed to select and edit the subobjects contained in an expanded node, or false otherwise.
    
    Returns:
    
    true if the user is allowed to select the subobjects
  - setLoadOnDemand
```
public void setLoadOnDemand(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.
    
    Parameters:
    
    loadOnDemand - If true, the nodes contained in a collapsed node are not created at startup, but only when the parent node is first expanded. If false, all the nodes are created at startup.
    
    Since:
    
    JViews 5.5
  - isLoadOnDemand
```
public boolean isLoadOnDemand()
```
    Returns true if load-on-demand is enabled, or false otherwise.
    
    Returns:
    
    true if load on demand is enabled
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setLoadOnDemand(boolean)
  - setSavingExpandedState
```
public void setSavingExpandedState(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.
    Parameters:
    
    savingExpandedState - If true, the expanded state of a subgraph is saved to the data model when the subgraph is expanded or collapsed.
    
    Since:
    
    JViews 5.5
  - isSavingExpandedState
```
public boolean isSavingExpandedState()
```
    Returns true if the expanded state of a subgraph is saved to the data model, or false otherwise.
    
    Returns:
    
    true if saves expanded state
    
    Since:
    
    JViews 5.5
    
    See Also:
    
    setSavingExpandedState(boolean)
  - setExpandCollapseEnabled
```
public void setExpandCollapseEnabled(boolean enabled)
```
    Enables or disables the expand/collapse interaction on subgraphs.
    
    Parameters:
    
    enabled - If true, clicking in a subgraph (or in the expand or collapse icon if the SDM view has an interactor attached to it) toggles the expanded state of the subgraph. If false, clicking in a subgraph or in its expand or collapse icon has no effect.
    
    Since:
    
    JViews 6.0
  - isExpandCollapseEnabled
```
public boolean isExpandCollapseEnabled()
```
    Returns true if the expand/collapse interaction on subgraphs is enabled.
    
    Returns:
    
    true if enabled
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setExpandCollapseEnabled(boolean)
  - setUpdatingPositionsOnExpand
```
public void setUpdatingPositionsOnExpand(boolean update)
```
    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.
    
    Parameters:
    
    update - If true, the positions of a subgraph and its children will be updated every time the subgraph is expanded or collapsed. If false, the positions will not be updated.
    
    Since:
    
    JViews 6.0
  - isUpdatingPositionOnExpand
```
@Deprecated
public boolean isUpdatingPositionOnExpand()
```
    Deprecated. replaced by isUpdatingPositionsOnExpand()
    
    Returns true if the positions of subgraphs and their children are updated when subgraphs are expanded or collapsed.
    
    Returns:
    
    true if updating positions on expand
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setUpdatingPositionsOnExpand(boolean)
  - isUpdatingPositionsOnExpand
```
public boolean isUpdatingPositionsOnExpand()
```
    Returns true if the positions of subgraphs and their children are updated when subgraphs are expanded or collapsed.
    
    Returns:
    
    true if updtaing position on expand
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setUpdatingPositionsOnExpand(boolean)
  - createNodeGraphic
```
public IlvGraphic createNodeGraphic(IlvSDMEngine engine,
                                    Object node)
```
    If the node is the parent of a subgraph, creates an IlvGrapher that will contain the nodes and links of the subgraph.
    
    Overrides:
    
    createNodeGraphic in class IlvFilterSDMRenderer
    
    Parameters:
    
    engine - The SDM engine.
    
    node - The node.
  - createSubManager
```
protected IlvManager createSubManager()
```
    Factory to create the submanager. The default implementation returns an instance of IlvGrapher.
    
    Returns:
    
    a manager
    
    Since:
    
    JViews 5.5
  - isLeafToContainerEnabled
```
public boolean isLeafToContainerEnabled()
```
    Returns true whether leaves are automatically converted to container when a first new child is added.
    
    Returns:
    
    true if automatic leaf convert is enabled
    
    Since:
    
    JViews 6.0
  - setLeafToContainerEnabled
```
public void setLeafToContainerEnabled(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.
    
    Parameters:
    
    leafToContainerEnabled - Automatic conversion of leaves to containers.
    
    Since:
    
    JViews 6.0
  - setFrameZoomable
```
public void setFrameZoomable(boolean zoomable)
```
    Specifies whether the frames and the expand/collapse icons drawn around subgraphs are zoomable or not. By default, frames are not zoomable.
    
    Parameters:
    
    zoomable - If true, the frames and the expand/collapse icons of all subgraphs are zoomable, that is to say they are drawn using the transformer of the view. If false, the frames and expand/collapse icons are not zoomable, that is to say they are always drawn with an identity transformer.
    
    Since:
    
    JViews 6.0
  - isFrameZoomable
```
public boolean isFrameZoomable()
```
    Returns true if the frames and the expand/collapse icons drawn around subgraphs are zoomable, or false if they are not zoomable.
    
    Returns:
    
    true if frame is zoomable
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setFrameZoomable(boolean)
  - addNodeGraphic
```
public void addNodeGraphic(IlvSDMEngine engine,
                           Object node,
                           IlvGraphic graphic,
                           boolean redraw)
```
    If the node is contained in a subgraph, adds the graphic node to the IlvGrapher representing the subgraph.
    
    Overrides:
    
    addNodeGraphic in class IlvFilterSDMRenderer
    
    Parameters:
    
    engine - The SDM engine associated with the grapher in which the graphic object will be 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.
  - addLinkGraphic
```
public void addLinkGraphic(IlvSDMEngine engine,
                           Object link,
                           IlvGraphic graphic,
                           boolean redraw)
```
    If the link is contained in a subgraph, adds the graphic link to the IlvGrapher representing the subgraph.
    
    Overrides:
    
    addLinkGraphic in class IlvFilterSDMRenderer
    
    Parameters:
    
    engine - The SDM engine associated with the grapher in which the graphic object will be 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.
  - nodeGraphicAdded
```
public void nodeGraphicAdded(IlvSDMEngine engine,
                             Object node,
                             IlvGraphic graphic,
                             boolean redraw)
```
    Makes the graphic object unselectable if setSubObjectsSelectionAllowed(false) was called.
    
    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.
    
    See Also:
    
    setSubObjectsSelectionAllowed(boolean)
  - linkGraphicAdded
```
public void linkGraphicAdded(IlvSDMEngine engine,
                             Object link,
                             IlvGraphic graphic,
                             boolean redraw)
```
    Makes the graphic object unselectable if setSubObjectsSelectionAllowed(false) was called.
    
    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.
    
    See Also:
    
    setSubObjectsSelectionAllowed(boolean)
  - customize
```
public void customize(IlvSDMEngine engine,
                      Object object,
                      IlvGraphic g,
                      String[] pseudoClass)
```
    If the object is an IlvGrapher, this method customizes either the IlvGrapher's border, or its collapsed graphic object, depending on whether the grapher is expanded or collapsed.
    
    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.
    
    pseudoClass - The pseudo-class of the object. This parameter can be null.
  - propertiesChanged
```
public void propertiesChanged(IlvSDMEngine engine,
                              Object object,
                              Collection<String> propertyNames,
                              IlvGraphic graphic)
```
    Updates the graphic representation of a data object.
    
    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
  - getEncapsulatedGraphic
```
public IlvGraphic getEncapsulatedGraphic(IlvGraphic g)
```
    If the object is an IlvGrapher, this method returns either the IlvGrapher's border, or its collapsed graphic object, depending on whether the grapher is expanded or collapsed.
    
    Overrides:
    
    getEncapsulatedGraphic in class IlvFilterSDMRenderer
    
    Parameters:
    
    g - A graphic object returned by createNodeGraphic.
  - setExpanded
```
public void setExpanded(IlvSDMEngine engine,
                        Object object,
                        boolean expand,
                        boolean redraw)
```
    Expands or collapses a node. This method is useful to expand or collapse nodes by code, rather than by direct interaction.
    
    Parameters:
    
    engine - The SDM engine.
    
    object - The data node to expand or collapse.
    
    expand - If true, the node will be expanded; otherwise the node will be collapsed.
    
    redraw - If true, the area covered by the expanded or collapsed node will be redrawn.
  - setForcingRenderingOnExpandCollapse
```
public void setForcingRenderingOnExpandCollapse(boolean force)
```
    Specifies whether the renderingDone(IlvSDMEngine engine) method of the main SDM Renderer must be called, regardless the value of IlvSDMEngine.getRenderingDoneMode(). This value defaults to true. If you do not want the renderingDone method of the main SDM Renderer to be called when you set the renderingDoneMode to IlvSDMEngine.NEVER, call this method with the force parameter set to false.
    
    Parameters:
    
    force - true if renderingDone is called regardless the renderingDoneMode property of the SDM Engine.
    
    Internal: do not use!
  - isForcingRenderingOnExpandCollapse
```
public boolean isForcingRenderingOnExpandCollapse()
```
    Returns:
    
    whether renderingDone is called regardless the renderingDoneMode property of the SDM Engine.
    
    Internal: do not use!
  - isExpanded
```
public boolean isExpanded(IlvSDMEngine engine,
                          Object object)
```
    Tests whether a data node is expanded or collapsed.
    
    Parameters:
    
    engine - The SDM engine.
    
    object - The data node to expand or collapse.
    
    Returns:
    
    true if object is a compound node and if it is expanded, or false otherwise.
  - getGraphicProperty
```
public Object getGraphicProperty(IlvSDMEngine engine,
                                 Object object,
                                 String property,
                                 String[] pseudoClass,
                                 Class<?> targetClass)
```
    Modifies the Layer rendering property so that subgraphs are displayed on top of their frames.
    
    Overrides:
    
    getGraphicProperty in class IlvFilterSDMRenderer
    
    Parameters:
    
    engine - The SDM engine.
    
    object - The data object that is being rendered.
    
    property - The name of the graphic property.
    
    pseudoClass - The pseudo-class of the object. This parameter can be null.
    
    targetClass - The class of the object on which the property will be set. The method can introspect the class to determine the type of the property, and convert the value if necessary. If this argument is null, the property should be returned without conversion.
  - updateObjectProperties
```
public void updateObjectProperties(IlvSDMEngine engine,
                                   Object object,
                                   String property,
                                   Object value,
                                   String[] pseudoClasses)
```
    This method converts the x and y coordinates of objects contained in subgraphs from absolute coordinates to relative coordinates in the subgrapher.
    
    Overrides:
    
    updateObjectProperties in class IlvFilterSDMRenderer
    
    Parameters:
    
    engine - The SDM engine.
    
    object - The data object.
    
    property - The name of the graphic property.
    
    value - The new value of the property.
    
    pseudoClasses - The pseudo-classes of the objects. This parameter can be null.
  - nodeGraphicBBoxChanged
```
public void nodeGraphicBBoxChanged(IlvSDMEngine engine,
                                   Object node,
                                   IlvGraphic graphic,
                                   IlvRect oldBBox,
                                   IlvRect newBBox,
                                   String[] pseudoClasses)
```
    Updates the location of a node.
    
    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.
  - getLinkConnectionRectangle
```
public IlvRect getLinkConnectionRectangle(IlvSDMEngine engine,
                                          IlvGraphic graphic,
                                          IlvTransformer t,
                                          IlvLinkConnector lc)
```
    This method is overridden to take into account the special expandable nodes.
    
    Overrides:
    
    getLinkConnectionRectangle in class IlvFilterSDMRenderer
    
    Parameters:
    
    engine - The SDM engine.
    
    graphic - The graphic object.
    
    t - The transformer.
    
    lc - The link connector from which this is called.
    
    Returns:
    
    A rectangle in view coordinates.
    
    Since:
    
    JViews 8.7
  - moveResizeNodeGraphic
```
protected void moveResizeNodeGraphic(IlvSDMEngine engine,
                                     Object node,
                                     IlvGraphic graphic,
                                     IlvRect newBBox,
                                     int anchor)
```
    Move the graphic to its final position
    
    Overrides:
    
    moveResizeNodeGraphic in class IlvFilterSDMRenderer
    
    Parameters:
    
    engine - The SDM engine.
    
    node - The data node that the graphic object represents.
    
    graphic - The graphic object that to be moved and/or resized.
    
    newBBox - An IlvRectangle initialized with the "x", "y", "width" and "height" graphic properties. If the width or height of the rectangle are non-zero, the graphic object is moved and resized, otherwise the graphic object is only moved. The final position must be stored in this parameter.
    
    anchor - see IlvDirection for the possible values
  - processServerAction
```
public boolean processServerAction(int x,
                                   int y,
                                   IlvManagerView view)
```
    Processes clicks in the expand/collapse icons from the client-side of a web application.
    
    Overrides:
    
    processServerAction in class IlvFilterSDMRenderer
    
    Parameters:
    
    x - The X coordinate of the point where the user clicked on the client-side, in view coordinates.
    
    y - The y coordinate of the point where the user clicked on the client-side, in view coordinates.
    
    view - The view used to render the graph image.
    
    Returns:
    
    true if the action was processed, false if the action was not processed.
    
    Since:
    
    JViews 6.5
  - addViewListeners
```
protected void addViewListeners(IlvManagerView view)
```
    This method can be overridden to add view listeners on any view attached to an SDM engine.
    This method is called only if IlvSDMRenderer.needsViewListeners() returns true.
    The default implementation does nothing.
    
    Overrides:
    
    addViewListeners in class IlvSDMRenderer
    
    Parameters:
    
    view - The manager view.
    
    See Also:
    
    IlvSDMRenderer.needsViewListeners()
  - needsViewListeners
```
protected boolean needsViewListeners()
```
    This method can be overridden to specify that this renderer needs to add listeners on all the views attached to the grapher of the SDM engine.
    If this method returns true, then the SDM renderer will make sure that the methods IlvSDMRenderer.addViewListeners(ilog.views.IlvManagerView) and IlvSDMRenderer.removeViewListeners(ilog.views.IlvManagerView) are called as appropriate for each view attached to the SDM engine.
    For example, if your renderer needs to install a transformer listener on all views (for example to adjust the graphic objects when the view is zoomed or unzoomed), you would override the needsViewListeners method to return true and the add/removeViewListener methods to add/remove your transformer listener.
    If this method returns false, then the methods IlvSDMRenderer.addViewListeners(ilog.views.IlvManagerView) and IlvSDMRenderer.removeViewListeners(ilog.views.IlvManagerView) are never called.
    The default implementation returns false to indicate that the basic SDM renderer does not install any listeners on views.
    
    Overrides:
    
    needsViewListeners in class IlvSDMRenderer
    
    See Also:
    
    IlvSDMRenderer.addViewListeners(ilog.views.IlvManagerView), IlvSDMRenderer.removeViewListeners(ilog.views.IlvManagerView)
  - removeViewListeners
```
protected void removeViewListeners(IlvManagerView view)
```
    This method can be overridden to remove view listeners from any view attached to an SDM engine.
    This method is called only if IlvSDMRenderer.needsViewListeners() returns true.
    The default implementation does nothing.
    
    Overrides:
    
    removeViewListeners in class IlvSDMRenderer
    
    Parameters:
    
    view - The manager view.
    
    See Also:
    
    IlvSDMRenderer.needsViewListeners()
  - setDefaultUpdatingPositionsOnExpand
```
public static void setDefaultUpdatingPositionsOnExpand(boolean updating)
```
    Parameters:
    
    updating -
    
    Internal: do not use!

Class IlvSubGraphRenderer

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

GRAPHER

Constructor Detail

IlvSubGraphRenderer

IlvSubGraphRenderer

Method Detail

setSubObjectsSelectionAllowed

isSubObjectsSelectionAllowed

setLoadOnDemand

isLoadOnDemand

setSavingExpandedState

isSavingExpandedState

setExpandCollapseEnabled

isExpandCollapseEnabled

setUpdatingPositionsOnExpand

isUpdatingPositionOnExpand

isUpdatingPositionsOnExpand

createNodeGraphic

createSubManager

isLeafToContainerEnabled

setLeafToContainerEnabled

setFrameZoomable

isFrameZoomable

addNodeGraphic

addLinkGraphic

nodeGraphicAdded

linkGraphicAdded

customize

propertiesChanged

getEncapsulatedGraphic

setExpanded

setForcingRenderingOnExpandCollapse

isForcingRenderingOnExpandCollapse

isExpanded

getGraphicProperty

updateObjectProperties

nodeGraphicBBoxChanged

getLinkConnectionRectangle

moveResizeNodeGraphic

processServerAction

addViewListeners

needsViewListeners

removeViewListeners

setDefaultUpdatingPositionsOnExpand