ilog.views.sdm.renderer

Class IlvInfoBalloonRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvInfoBalloonRenderer

All Implemented Interfaces:

Serializable

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 fields 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(java.lang.String).

Since:

JViews 4.0

See Also:

Serialized Form

Field Summary

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

_renderer

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

PSEUDOCLASS_PREFIX

Constructor Summary

Constructors

Constructor and Description
IlvInfoBalloonRenderer() Creates a new info balloon renderer with a null filtered renderer.
IlvInfoBalloonRenderer(IlvSDMRenderer renderer) Creates a new info balloon renderer for a specified filtered renderer.

Method Summary

Modifier and Type	Method and Description
protected void	addViewListeners(IlvManagerView view) This method can be overridden to add view listeners on any view attached to an SDM engine.
static IlvInfoBalloonRenderer	getInstance(IlvSDMEngine engine) Returns the IlvInfoBalloonRenderer instance which belongs to the specified SDM engine.
String	getLinkBalloonLines() Returns the descriptions of the lines to be displayed in the information balloon when the user clicks a link.
String	getNodeBalloonLines() Returns the descriptions of the lines to be displayed in the information balloon when the user clicks a node.
String	getPrototype() Returns the URL and name of the prototype used by this renderer to represent the info balloons.
boolean	isEnabled() Returns true if the renderer is enabled (default).
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	prepareRendering(IlvSDMEngine engine) Loads the info balloon prototypes.
protected void	removeViewListeners(IlvManagerView view) This method can be overridden to remove view listeners from any view attached to an SDM engine.
void	setEnabled(boolean value) Enable or disable this renderer.
void	setLinkBalloonLines(String lines) Sets the descriptions of the lines to be displayed in the information balloon when the user clicks a link.
void	setNodeBalloonLines(String lines) Sets the descriptions of the lines to be displayed in the information balloon when the user clicks a node.
void	setPrototype(String prototypeURL) Sets the prototype (BGO) used by this renderer to represent the info balloons.

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

addLinkGraphic, addNodeGraphic, computeBBox, createLinkGraphic, createNodeGraphic, customize, getEncapsulatedGraphic, getFilteredRenderer, getGraphicProperty, getLinkConnectionRectangle, linkGraphicAdded, moveResizeNodeGraphic, nodeGraphicAdded, nodeGraphicBBoxChanged, processServerAction, propertiesChanged, removeAll, removeLinkGraphic, removeNodeGraphic, renderingDone, setFilteredRenderer, updateObjectProperties

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

Constructor Detail

IlvInfoBalloonRenderer

public IlvInfoBalloonRenderer(IlvSDMRenderer renderer)

Creates a new info balloon renderer for a specified filtered renderer.

Parameters:

renderer - The filtered renderer.

IlvInfoBalloonRenderer

public IlvInfoBalloonRenderer()

Creates a new info balloon renderer with a null filtered renderer.

Method Detail

setPrototype

public void setPrototype(String prototypeURL)
                  throws IlvSDMException

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).

Parameters:

prototypeURL - A string containing the URL of the library file containing the prototype, followed by a # character, followed by the prototype name.

Throws:

IlvSDMException - if problem with the provided prototype

getPrototype

public String getPrototype()

Returns the URL and name of the prototype used by this renderer to represent the info balloons.

Returns:

A string containing the URL of the library file containing the prototype, followed by a # character, followed by the prototype name.

See Also:

setPrototype(java.lang.String)

setEnabled

public void setEnabled(boolean value)

Enable or disable this renderer.

Parameters:

value - true if enabled.

Since:

JViews 8.5

isEnabled

public boolean isEnabled()

Returns true if the renderer is enabled (default).

Returns:

true if the renderer is enabled.

Since:

JViews 8.5

getInstance

public static IlvInfoBalloonRenderer getInstance(IlvSDMEngine engine)

Returns the IlvInfoBalloonRenderer instance which belongs to the specified SDM engine.

Parameters:

engine - the SDM engine

Returns:

an instance of IlvInfoBalloonRenderer.

Since:

JViews 8.5

prepareRendering

public void prepareRendering(IlvSDMEngine engine)

Loads the info balloon prototypes.

Overrides:

prepareRendering in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

setNodeBalloonLines

public void setNodeBalloonLines(String lines)

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.

Parameters:

lines - The descriptions of the balloon lines, in the form: "line1,label1,property1;line2,label2,property2;...".

getNodeBalloonLines

public String getNodeBalloonLines()

Returns the descriptions of the lines to be displayed in the information balloon when the user clicks a node.

Returns:

node line description

See Also:

setNodeBalloonLines(java.lang.String)

setLinkBalloonLines

public void setLinkBalloonLines(String lines)

Sets the descriptions of the lines to be displayed in the information balloon when the user clicks a link. See setNodeBalloonLines(java.lang.String) for a description of the syntax.

Parameters:

lines - The descriptions of the balloon lines.

getLinkBalloonLines

public String getLinkBalloonLines()

Returns the descriptions of the lines to be displayed in the information balloon when the user clicks a link.

Returns:

link lines description

See Also:

setLinkBalloonLines(java.lang.String)

addViewListeners

protected void addViewListeners(IlvManagerView view)

Description copied from class: IlvSDMRenderer

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()

Description copied from class: IlvSDMRenderer

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)

Description copied from class: IlvSDMRenderer

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()