ilog.views.sdm.renderer

Class IlvInfoBalloonRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvInfoBalloonRenderer

public class IlvInfoBalloonRenderer
extends IlvFilterSDMRenderer

The class IlvInfoBalloonRenderer displays selected properties of a data object in an "information balloon" when the user clicks the object.

The contents of the info balloon can be customized in two ways:

1. Globally for all the objects, by setting the properties nodeBalloonLines and/or linkBalloonLines.
2. Locally for each object, by setting the rendering property InfoBalloonLines.

The syntax of all these properties is:

  "line1,First property: ,prop1;line2,Second property: ,prop2"
  

Each line is described by a sequence of 3 properties separated by commas: the name of a property of the info balloon, the title to display, and the name of the object property whose value is to be displayed. The line descriptions are separated by semi-colons.

Example

  SDM {
    InfoBalloon : "true";
  }
  InfoBalloon {
    nodeBalloonLines : "line1,Town: ,town;line2,Population: ,population";
    linkBalloonLines : "line1,Distance: ,distance";
  }
  node[capitalState] {
    InfoBalloonLines : "line1,Town: ,town;line2,Population: ,population;Capital of: ,capitalState";
  }
  

The info balloon is represented using a JViews prototype (a BGO). The info balloon properties (line1, line2, and so on) may depend on the prototype that is used. By default, a built-in prototype that can display up to 5 lines is used. You can specify a custom info balloon prototype using #setPrototype.

CSS example:

ilvInfoBalloonRenderer {
class : "ilog.views.sdm.renderer.IlvInfoBalloonRenderer";
alias : "<value>";
enabled : "false";
linkBalloonLines : "<value>";
nodeBalloonLines : "<value>";
parameter : "<value>";
prototype : "<value>";
}

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	enabled Enable or disable this renderer.
java.lang.String	linkBalloonLines Sets the descriptions of the lines to be displayed in the information balloon when the user clicks a link.
java.lang.String	nodeBalloonLines Sets the descriptions of the lines to be displayed in the information balloon when the user clicks a node.
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.
java.lang.String	prototype Sets the prototype (BGO) used by this renderer to represent the info balloons.

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

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

enabled

public boolean enabled

Enable or disable this renderer.

CSS example: enabled : "false";

linkBalloonLines

public java.lang.String linkBalloonLines

Sets the descriptions of the lines to be displayed in the information balloon when the user clicks a link. See #setNodeBalloonLines for a description of the syntax.

CSS example: linkBalloonLines : "<value>";

nodeBalloonLines

public java.lang.String nodeBalloonLines

Sets the descriptions of the lines to be displayed in the information balloon when the user clicks a node. The lines argument contains a list of strings separated by semi-colon (';') characters. Each string has three parts, separated by commas (','): The first part is the name of the balloon prototype's property to set. The second part is a label that will form the beginning of the line. The third part is the name of the data object property whose value will be appended to the line.

See the class description for examples.

CSS example: nodeBalloonLines : "<value>";

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

prototype

public java.lang.String prototype

Sets the prototype (BGO) used by this renderer to represent the info balloons.

You can supply several variants of the prototype to fit different locations of the object in the view (near a corner, near the top, and so on). The variants of the prototype should be suffixed by an integer (starting with 0). The renderer will try all the variants of the prototype until it finds one that is fully visible in the view. If none is fully visible, it will choose the most visible variant.

For example, if you supply the prototype URL myprotos.ivl#myballoon, the renderer will try the prototypes myballoon0, myballoon1, myballoon2, and so on until no prototype is found.

You must supply at least one variant (with the suffix 0).

CSS example: prototype : "<value>";