Identifies the rendering information necessary to display a network.

To display a network, you need rendering information. This information defines how to display network data.

You can configure a network either through a CSS configuration file or through the API, the easiest and preferred way being the CSS configuration. You also have the possibility to load a project file which combines the CSS configuration and the network data.

A network configuration relates to one network only. It defines the behavior and properties of the network component as well as the behavior and some properties of any representation object created in the network model. (See The model for more information about features like representation objects and network model.)

You can customize the network adapter (filters, node and link factories, for example), the network view (toolbar, background, interactors, for example) and the network objects.

You can customize the following features in a CSS file:

How to load a CSS file in a network component

The network configuration can be split across several CSS files. The method setStyleSheets accepts several CSS filenames.

There are three ways to apply a CSS configuration to a network component, depending on whether you have one or several configuration files:

How to configure a network component in a CSS file

The following code represents an example of configuring a network in CSS. It is based on the CSS files located in <installdir> /samples/network/styling where <installdir> is the directory where you have installed JViews TGO.

The configuration in CSS is organized as a set of rules that define properties.

For detailed information about the CSS syntax, refer to Introducing cascading style sheets.

The Network rule

This rule specifies Boolean flags that indicate whether each customizable property is present. For example, customization of the property GraphLayout is not taken into account unless graphlayout: true; is declared in the Network rule.

This feature provides powerful cascading possibilities of CSS files. Thus, you can define GraphLayout customizations in a default CSS file and then turn them on or off in another CSS file.

The following properties are supported in the Network rule. You will find detailed documentation for each of these properties in the Rogue Wave® JViews TGOJava™ API Reference Documentation, package ilog.cpl.network.renderer.

The ToolBar rule

This rule controls the toolbar.

The property enabled is a Boolean property, with default value true. It controls whether the toolbar is visible or not.

The property external is a Boolean property, with default value false. It specifies whether the placement and visibility of the toolbar are managed by user code instead of internally by the network component.

Buttons can be added through the syntax button[i]: @+ButtonId; followed by the customization setting of the button with the given ButtonId.

A button has a mandatory property, actionType. This property specifies the action triggered by the button or a separator that is added to the toolbar. The value can be:

How to add a toolbar separator for the network component

You can add toolbar separators in specified positions of the network component toolbar. When configuring the network component toolbar, you can specify the position where a separator should be placed by using the predefined button action called Separator. This button action supports an optional property, dimension, which allows you to specify the dimensions of the separator in the toolbar.

The following example shows how to achieve this result:

The predefined values for the actionType property are the following:

A button can have a property permanent. This is a Boolean property, with default value true. For interactor buttons, this property denotes whether the interactor remains attached after it has performed its action.

A button can have a property name. This property specifies the name by which other elements in the file refer to the button. The default name is the short name used as actionType.

A button can have additional properties, corresponding to Bean properties of the Java™ class. For example, the Select button has the properties multipleSelectionMode, moveAllowed, dragAllowed, editingAllowed, moveThreshold, opaqueMove, showingMovingObject, opaqueDragSelection, opaqueResize, opaquePolyPointsEdition, multipleSelectionModifier, selectionModifier, which are documented in the class ilog.cpl.network.action.toolbar.IlpNetworkSelectButton.

An interactor button can have key or gesture actions attached to it. These actions are triggered by specific keystrokes or gestures while the interactor is active. They are added through the syntax action[i]: @+ActionId; followed by a customization setting for the action.

An action customization has the mandatory property class, which specifies the Java class of the javax.swing.Action object. Bean properties of this class are also customizable and the properties key and gesture can be set to specify when the action is to be executed. These two properties are not used in combination. For example, if you specify:

the action will be executed either when the key sequence ‘control-A’ is typed, or when the mouse BUTTON1 is clicked. To define the property gesture, specify one of the predefined user gestures defined in class IlpGesture. To define the property key, specify a string that will be converted to a keystroke by the type converter ( IlpTypeConverter).

The following predefined actions are available:

An interactor can have a pop-up menu factory associated with it. This factory can be specified using the property popupMenuFactory. The value of this property should be a bean that implements the interface IlpPopupMenuFactory. For example,

In this example, the value of the property " popupMenuFactory " is a bean that is defined by the class CustomPopupMenuFactory. This class should implement the interface IlpPopupMenuFactory.

For more information on configuring the toolbar in a network view, refer to the class IlpToolBarRenderer.

How to add a predefined toolbar button to the network component

JViews TGO provides a list of predefined toolbar buttons usable in the network component (see Predefined values of the actionType property ).

The following example shows how to add a predefined button that enables the select interactor. When this interactor is enabled, you can customize actions, pop-up menus and interactor properties as illustrated here:

How to add a custom toolbar button to the network component

To add your own toolbar button, you need to create a new action class that inherits from IlpNetworkInteractorAction and contains a constructor that takes an IlpViewsView as parameter.

Then, you need to register this new button in your component configuration, as follows:

The custom action will be encapsulated in an IlpNetworkInteractorButton, and you will be able to customize the properties of this button as with the predefined buttons. For example, you can customize the following:

The View rule

This rule controls the view.

You can customize the following properties of the view:

The following CSS sample shows how to customize the view:

For more information on configuring a network view, refer to the class IlpViewRenderer.

The Overview rule

This rule controls the overview window.

The property enabled controls the visibility of the overview window. The default value is false.

The following CSS sample shows how to customize the overview:

For more information on configuring the overview window in a network view, refer to the class IlpOverviewRenderer.

The Interactor rule

This rule controls the interactor associated with the view.

You can customize the following properties of the interactor:

How to configure a network interactor in a CSS file

Prior to configuring the network view interactor, you need to configure the network component so that the interactor configuration is enabled:

After that, you can customize the interactor property in the Interactor rule as illustrated by the next code extract. for details about the CSS syntax, refer to The CSS specification.

How to set the default view interactor from the toolbar of the network component

You can customize the default view interactor to be one of the interactors present in the toolbar configured for the network component. In this case, the toolbar button is identified when the network component is configured, and it is activated at startup. This interactor becomes the initial view interactor, and the default view interactor when another interactor stops its interaction. This configuration is achieved through the property name, whose value must be the name of one of the configured toolbar buttons.

The following CSS extract configures the network view to use the Select toolbar button as the default view interactor:

How to set the default view Interactor when the toolbar is disabled in the network view

When the toolbar is disabled, you can no longer specify the default view interactor by using a toolbar button name, as in the example above. However, you can specify the view interactor directly in CSS, as follows:

The behavior of the view interactor is determined by the actions that are associated with user gestures and keystrokes. This behavior can also be customized through CSS. You can also configure a pop-up menu to be displayed in the network view. For more information about interactor customization, refer to Interacting with the network view and Interacting with the network objects.

When the interactor renderer is enabled, you can also customize objects interactors using property interactor. For further information, refer to IlpInteractorRenderer.

The Zooming rule

This rule controls the zoom policy.

The mandatory property type specifies the type of zoom. The possible values are Logical, Physical, or Mixed. Each zoom policy may have additional properties that you can also set using CSS:

How to customize the zoom policy in a network component

The following CSS sample shows how to customize the zoom policy in a network view:

For more information on configuring the zoom behavior in a network view, refer to the class IlpZoomingRenderer.

How to configure the visibility of decorations for a specific network component

JViews TGO provides three predefined zoom policies that you can use directly in the network component. For more information, see Zooming. When using the physical or the mixed zoom policy, decorations may become invisible as the user zooms out in the view. By default, this configuration is global in the application. However, you may need to specify the visibility threshold for a specific view. This feature is supported by properties decorationNames and visibilityThresholds. Property decorationNames specifies each decoration that is configured for the view (see IltGraphicElementName for the list of decoration names that can be customized). Property visibilityThresholds specifies, for each decoration name, the visibility threshold below which the decoration becomes invisible. This configuration is illustrated by the following example:

The GraphLayout rule

This rule allows you to control the automatic node layout in the view and to configure nonautomatic node layouts. Nonautomatic node layouts can only be executed through the API. For more details, see Layout.

How to control the automatic node layout in the network view

Automatic node layout is configured through the property class. This property specifies the graph layout class, a subclass of IlvGraphLayout. Additional Bean properties can be specified, depending on the class.

The following CSS sample shows how to customize the graph layout:

The graph layout is always a subclass of IlvGraphLayout which supports the " preserveFixedNodes " property. This property allows you to switch the support of fixed nodes on or off. You can set a node as fixed in the business object customization.

The properties of each layout algorithm are fully explained in the Rogue Wave® JViews DiagrammerUsing Graph Layout Algorithms documentation.

The properties of the IlvGraphLayout subclasses conform to the following JavaBeans™ convention: if a class has a pair of methods called setMyProp (with a single parameter) and getMyProp (without parameters), then you can set the property myProp in the style sheet.

How to configure multiple node layouts in a network view

The Graph Layout rule allows you to configure multiple node layouts, and to define the node layout to be used automatically in the view. Multiple node layout configuration is achieved through the properties layouts and autoLayoutIndex, as illustrated below:

In this use case, three node layouts are configured for the view: IlvTreeLayout, IlvHierarchicalLayout and IlvSpringEmbedderLayout. The hierarchical layout is configured to be performed automatically when the contents of the view changes. This configuration is achieved by specifying the value of property autoLayoutIndex as the index of the hierarchical layout defined through the layouts property. The other node layouts can be performed on demand using the API (see IlpGraphView.performAttachedLayout ).

How to configure nonautomatic node layouts in the network component

If you are not interested in automatic node layout, you can still configure multiple node layouts in CSS. To have only nonautomatic node layouts, set property autoLayoutIndex to -1, as illustrated below:

How to specify a different node layout for each subnetwork

When the node layout is configured for a view, it is applied to the view and to all the subnetworks displayed in this network view.

However, you can specify different node layouts for subnetworks. The node layouts of subnetworks are configured in CSS using the same properties as for the view configuration ( layouts and autoLayoutIndex ).

When you configure the node layout for a specific subnetwork, you must declare the CSS selector with a specific pseudoclass that identifies the graph layout renderer. The pseudoclass must be graphLayoutRenderer, as illustrated below:

The property autoLayoutIndex, when used in an object selector with the graphLayoutRenderer pseudoclass, specifies the automatic node layout that is applied to the subnetwork.

You can also specify nonautomatic node layouts for subnetworks. This configuration is achieved in the same way as for the view configuration ( layouts property with multiple node layouts and the autoLayoutIndex set to -1 ).

When you call the method performAttachedLayout(int index), it is applied recursively in the model hierarchy. Therefore if a node layout is configured for the given index in the subnetwork, this specific layout is performed. Otherwise, the node layout configured for the parent network is executed.

How to set node or link parameters on graph layout objects in the network component

You can set parameters for a graph layout algorithm that applies to a particular node or link, in the style sheet. Such parameters are defined by a method of the form:

or

Node parameters are set in the style sheet as follows:

The name of the property is the name of the method, without the prefix set. The pseudoclass graphLayoutRenderer indicates that the declarations apply to the node layouts that are configured in the graph layout rule.

For example, the graph layout defines a setFixed method that lets you specify whether a node or link is fixed. Fixed nodes or links are not moved when the layout is applied. The signature of the method is:

In the style sheet, you can set this parameter as follows:

The value of the property can be any basic type (integer, String, float), or it can be the name of a public constant defined by the graph layout class, for example, WEST, which is defined in the class IlvHierarchicalLayout.

When the graph layout rule contains multiple node layouts, you can still specify node and link layout parameters by using pseudoclasses that identify the graph layout to which the declarations apply.

In the example above, NE1 is configured as the root object for the Tree Layout algorithm. This is achieved by declaring the property root in a selector that contains the pseudoclasses graphLayoutRenderer (indicates that this is a graph layout renderer per-object property) and tree (indicates that this is a property specific to the IlvTreeLayout algorithm).

At the same time, NE1 is configured to be placed at level 0 in case of a hierarchical layout. This is achieved using pseudoclasses graphLayoutRenderer and hierarchical (indicates that this is a graph layout per-object property specific to the IlvHierarchicalLayout algorithm).

Each layout algorithm supports a set of per-object parameters. For more information on the parameters supported by each layout algorithm, refer to package ilog.cpl.graph.css.renderer.graphlayout.

In addition to the properties that are specific to the layout algorithms, the graph layout renderer also supports the following properties:

How to disable the per-object layout parameters for node configuration in the network view

You can also disable the per-object layout parameters configuration through CSS as follows:

For more information on configuring the node layout in a network view, refer to the class IlpGraphLayoutRenderer.

The LinkLayout rule

This rule controls the automatic link layout in the view.

The mandatory property class specifies the link layout class, a subclass of IlvGraphLayout. Additional Bean properties can be specified, depending on the class.

How to control the automatic link layout in the network view

The following CSS sample shows how to customize the link layout:

The link layout is always a subclass of IlvGraphLayout which supports the " preserveFixedLinks " property. This property allows you to switch the support of fixed links on or off.

How to specify a different link layout for each subnetwork

When the link layout is configured for a view, it is applied to the view and to all the subnetworks displayed in this network view.

However, you can also specify different link layouts for subnetworks. The link layout is configured in CSS using the property linkLayout and the pseudoclass linkLayoutRenderer, as illustrated below:

Like the graph layout renderer, the link layout renderer supports setting per-object link layout parameters through CSS. See How to set node or link parameters on graph layout objects in the network component.

How to specify per-object parameters for link layouts in the network view

Link parameters are set in the style sheet as follows:

How to disable per-object layout parameters for link configuration in the network view

You can also disable the per-object layout parameters configuration through CSS as follows:

For more information on configuring the link layout in a network view, refer to the class IlpLinkLayoutRenderer.

The LabelLayout rule

This rule controls the automatic label layout in the view.

The mandatory property class specifies the label layout class, a subclass of IlvLabelLayout. Additional Bean properties can be specified, depending on the class. The usual setting is IltAnnealingLabelLayout.

The following CSS sample shows how to customize the label layout:

Note that some properties can be set within the IltAnnealingLabelLayout and some within the IlvAnnealingLabelLayout. For more details, refer to the Rogue Wave JViews TGO Java API Reference Documentation.

For more information on configuring the label layout in a network view, refer to the class IlpLabelLayoutRenderer.

The Backgrounds rule

This rule allows you to configure two kinds of background that affect the network component representation:

Network backgrounds

This refers to background files such as maps or background images. You can specify a network background through:

You can mix and match options 1 and 2 by specifying some backgrounds as beans and some as straight URL strings.

In the case of the Image Tile background type ( IlpImageTileBackground ), only the url property can be configured through CSS. For the other properties, use the XML configuration. See Background support.

Manager view background

This refers to the representation of the view as a background for your network backgrounds (the area that the network backgrounds do not cover).

You can configure the manager view background as follows:

For example:

The following table lists the properties that allow you to customize the manager view background:

For more information on configuring the background in a network, refer to the class IlpBackgroundsRenderer.

The Positioning rule

This rule controls the type and converter of the user-defined IlpPosition.

Predefined business objects rely on x- and y-based IlpPosition types such as IlpPoint, IlpRect, and IlpPolygon. The default position converter, IlpDefaultPositionConverter, acts as a pass-through, enabling conversion of these coordinates to x- and y-based view coordinates.

However, custom business objects ( IlpObject ) may define a position system that is not a direct mapping to the view coordinate system, and may require some adaptation to be properly positioned. For these cases, the positioning rule associates an IlpPosition type with a customized position converter.

Typically you set a customized position converter through the Java API, as it must be in place before the JViews TGO component (Network or Equipment) is populated. Alternatively you can use CSS to set the position converter, but the TGO component must be completely empty before you do this.

The property positionClass denotes the Java class name of the class or interface that implements IlpPosition.

The property converterClass denotes a Java class name or CSS bean that implements the IlpPositionConverter interface and determines the conversion between business data coordinates and (x,y) coordinates in the view.

The following CSS sample shows how to set a customized position converter:

For more information on configuring the positioning in a network view, refer to the class IlpPositioningRenderer.

The Adapter rule

This rule controls the configuration of the network adapter. The network adapter is responsible for converting the business objects in the data source to representation objects (network nodes) in the network component. It provides the following features:

These network adapter features can be customized through CSS using the following properties:

How to configure a network adapter in a CSS file

Prior to configuring the adapter, you need to configure the network component so that the adapter configuration is enabled:

After that, you can customize each adapter property in the Adapter rule as illustrated by the following code extract. Refer to The CSS specification in the Styling documentation for details about the CSS syntax.

How to programmatically configure adapter using CSS

You can programmatically modify the CSS configuration of the default network adapter ( IlpNetworkAdapter ) by using mutable style sheets through the IlpMutableStyleSheet API.

To use mutable style sheets:

How to customize the mutable style sheet

Reapplying a CSS configuration may be a heavy task, as the adapter may be forced to review filters, origins, recreate representation objects, and so on. It is important to use the mutable style sheet with care and to customize it properly to reapply the CSS wisely. To do so, there are two methods available in the IlpMutableStyleSheet API: setUpdateMask() and setAdjusting().

For details of the classes involved in the architecture of the network component, see Architecture of the network component.

The following example shows how to configure the network view through the API. For details o programming the individual services, see Network component services.

How to configure the network view with the API

How to configure the network adapter with the API

The following example shows how to configure the network adapter through the API. For details on programming the individual services, see Network component services.

A project is a combination of style sheets that supply rendering information and a data source that supplies the data to be represented in a network component. A project is saved as an XML file with extension .itpr.

Loading a project file is the recommended way to configure a graphic component in Java™ as it is the fastest.

How to load a project file into a network component

The following code sample shows how to load a project file into a network component, using the method setProject.

The project is represented by the IlpTGOProject class, included in the package ilog.cpl.project. When a new project is created, the style sheet and data source are both null.

How to create a new project for the network component

The following code sample shows how to create a new project file by setting the style sheets and data source, then saving the project.

Network nodes and links can be customized through CSS according to their business class. For details, see Customizing network and equipment nodes and Customizing network and equipment links.