ilog.views.sdm.renderer

Class IlvHalfZoomingRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvHalfZoomingRenderer

All Implemented Interfaces:

Serializable

public class IlvHalfZoomingRenderer
extends IlvFilterSDMRenderer

The class IlvHalfZoomingRenderer is a filtering renderer that prevents the nodes of the graph to zoom in and/or out beyond given limits.

The half-zooming renderer wraps each graphic node created by the filtered renderer in an IlvHalfZoomingGraphic.

The minimum zoom, maximum zoom, initial zoom and rotatable flag are fetched from the style sheet using the rendering properties MinZoom, MaxZoom, InitialZoom, and Rotatable.

When the view is zoomed in and the zoom level becomes greater than the maximum zoom, the nodes keep a fixed size.

When the view is zoomed out and the zoom level becomes smaller than the minimum zoom, the nodes are replaced by gray boxes. The gray boxes keep getting smaller as the view is zoomed out.

If the minimum zoom is 0, the objects are zoomed out normally, as if the half-zooming renderer was not present. Similarly, if the maximum zoom is 0, the objects always get bigger when the view is zoomed in, as if the half-zooming renderer was not present.

For example, with the following CSS rule, the nodes will no longer grow as soon as the zoom level becomes larger than 4, and they are grayed out when the zoom becomes smaller than 0.25:

 SDM {
   HalfZooming : "true";
 }
 node {
   MaxZoom : "4";
   MinZoom : "0.25";
 }
 

The zoom thresholds can also be set globally for all the nodes by setting the minZoom and maxZoom directly on the renderer, as follows:

 SDM {
   HalfZooming : "true";
 }
 HalfZooming {
   maxZoom : "4";
   minZoom : "0.25";
 }
 

The half zooming renderer supports node alpha transparency. Use this feature to add transparency to specific nodes without changing the individual foreground, background and stroke colors for the node.

For any node, the alpha transparency value must be between 0 and 1. The following CSS rule specifies that certain nodes must appear transparent with an alpha value of 0.3:

 SDM {
   HalfZooming : "true";
 }
 node.MyType {
   MaxZoom : "4";
   MinZoom : "0.25";
   Alpha: "0.3";
 }
 

The following CSS rule sets the default alpha transparency for all nodes:

 SDM {
   HalfZooming : "true";
 }
 HalfZooming {
   alpha : "0.4";
 }
 

Since:

JViews 4.0

See Also:

IlvHalfZoomingGraphic, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvHalfZoomingRenderer.HalfZoomingGraphic This subclass of IlvHalfZoomingGraphic is used internally by the IlvHalfZoomingRenderer.

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
IlvHalfZoomingRenderer() Creates a new half-zooming renderer with a null filtered renderer.
IlvHalfZoomingRenderer(IlvSDMRenderer renderer) Creates a new half-zooming renderer for a specified filtered renderer.

Method Summary

Modifier and Type	Method and Description
IlvGraphic	createNodeGraphic(IlvSDMEngine engine, Object node) Wraps the graphic node created by the filtered renderer in an instance of IlvHalfZoomingGraphic.
void	customize(IlvSDMEngine engine, Object object, IlvGraphic g, String[] pseudoClass) Customizes the graphic object encapsulated in the half-zooming graphic.
float	getAlpha() Returns the alpha transparency value for the objects.
IlvGraphic	getEncapsulatedGraphic(IlvGraphic graphic) Returns the graphic object encapsulated in the half-zooming graphic.
double	getInitialZoom() Returns the initial zoom level.
IlvRect	getLinkConnectionRectangle(IlvSDMEngine engine, IlvGraphic graphic, IlvTransformer t, IlvLinkConnector lc) Computes the rectangle on which the connection points of the links to/from this node should be located, taking into account that the nodes do not always zoom according to the view transformer.
double	getMaxZoom() Returns the maximum zoom level above which the objects stop zooming.
double	getMinZoom() Returns the minimum zoom level below which the objects are replaced by gray boxes.
Color	getUnzoomedBackground() Returns the background color used to fill the nodes below the minimum zoom level.
Color	getUnzoomedForeground() Returns the foreground color used to draw the outline of the nodes below the minimum zoom level.
boolean	isGrayedWhenUnzoomed() Returns the flag specifying whether half-zooming objects are drawn as gray boxes when the zoom level is less than the minimum zoom, or if they are drawn at their minimum size.
boolean	isRotatable() Tests if the objects support rotation.
protected void	moveResizeNodeGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, IlvRect newBBox, int anchor) Move the graphic to its final position
void	propertiesChanged(IlvSDMEngine engine, Object object, Collection<String> propertyNames, IlvGraphic graphic) Updates the properties of the graphic object encapsulated in the half-zooming graphic.
void	setAlpha(float alpha) Changes the alpha transparency value for the objects.
void	setGrayedWhenUnzoomed(boolean grayedWhenUnzoomed) Specifies whether half-zooming objects are drawn as gray boxes when the zoom level is less than the minimum zoom, or if they are drawn at their minimum size.
void	setInitialZoom(double initialZoom) Changes the initial zoom level.
void	setMaxZoom(double maxZoom) Changes the maximum zoom level above which the objects stop zooming.
void	setMinZoom(double minZoom) Changes the minimum zoom level below which the objects are replaced by gray boxes.
void	setRotatable(boolean rotatable) Sets whether the objects support rotation.
void	setUnzoomedBackground(Color unzoomedBackground) Sets the background color used to fill the nodes below the minimum zoom level.
void	setUnzoomedForeground(Color unzoomedForeground) Sets the foreground color used to draw the outline of the nodes below the minimum zoom level.

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

addLinkGraphic, addNodeGraphic, computeBBox, createLinkGraphic, getFilteredRenderer, getGraphicProperty, linkGraphicAdded, nodeGraphicAdded, nodeGraphicBBoxChanged, prepareRendering, processServerAction, removeAll, removeLinkGraphic, removeNodeGraphic, renderingDone, setFilteredRenderer, updateObjectProperties

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

addViewListeners, callMoveResizeNodeGraphic, convert, convert, getAlias, getAuxiliaryBean, getAuxiliaryBeans, getEngine, getLinkConnectionRectangle, getLocation, getParameter, needsViewListeners, propertyChanged, removeViewListeners, setAlias, setEngine, setLayerName, setParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvHalfZoomingRenderer

public IlvHalfZoomingRenderer(IlvSDMRenderer renderer)

Creates a new half-zooming renderer for a specified filtered renderer.

Parameters:

renderer - The filtered renderer.

IlvHalfZoomingRenderer

public IlvHalfZoomingRenderer()

Creates a new half-zooming renderer with a null filtered renderer.

Method Detail

getMinZoom

public double getMinZoom()

Returns the minimum zoom level below which the objects are replaced by gray boxes.

setMinZoom

public void setMinZoom(double minZoom)

Changes the minimum zoom level below which the objects are replaced by gray boxes.

This global minimum zoom level is used as a default when no MinZoom property has been set in the CSS rules for the nodes.

Parameters:

minZoom - The minimum zoom level.

getMaxZoom

public double getMaxZoom()

Returns the maximum zoom level above which the objects stop zooming.

setMaxZoom

public void setMaxZoom(double maxZoom)

Changes the maximum zoom level above which the objects stop zooming.

This global maximum zoom level is used as a default when no MaxZoom property has been set in the CSS rules for the nodes.

Parameters:

maxZoom - The maximum zoom level.

getInitialZoom

public double getInitialZoom()

Returns the initial zoom level.

setInitialZoom

public void setInitialZoom(double initialZoom)

Changes the initial zoom level.

This global initial zoom level is used as a default when no InitialZoom property has been set in the CSS rules for the nodes.

Parameters:

initialZoom - The initial zoom level.

getAlpha

public float getAlpha()

Returns the alpha transparency value for the objects.

Since:

JViews 8.0

setAlpha

public void setAlpha(float alpha)

Changes the alpha transparency value for the objects. The alpha value is used to render the transparency level of the wrapped object. The value must be in the range of [0.0, 1.0]. Setting the alpha value to 1 means that the object is totally transparent.

This global alpha transparency value is used as a default when the Alpha property has not been set in the CSS rules for the nodes.

Parameters:

alpha - The new alpha transparency level.

Since:

JViews 8.0

setRotatable

public void setRotatable(boolean rotatable)

Sets whether the objects support rotation.

The rotation setting is not delegated to the wrapped object:

• If rotation support is disabled, the objects always stay in the upright position. This is true even if a wrapped object supports rotation.
• If rotation support is enabled, and the wrapped object also supports rotation, it will rotate normally. If the wrapped object does not support rotation, it will remain static.

Parameters:

rotatable - Set to true to enable rotation. The default value is true.

Since:

JViews 8.1

See Also:

isRotatable()

isRotatable

public boolean isRotatable()

Tests if the objects support rotation.

The rotation setting is not delegated to the wrapped object:

• If rotation support is disabled, the objects always stay in the upright position. This is true even if a wrapped object supports rotation.
• If rotation support is enabled, and the wrapped object also supports rotation, it will rotate normally. If the wrapped object does not support rotation, it will remain static.

Returns:

If the objects support rotation, true is returned.

Since:

JViews 8.1

See Also:

setRotatable(boolean)

setUnzoomedForeground

public void setUnzoomedForeground(Color unzoomedForeground)

Sets the foreground color used to draw the outline of the nodes below the minimum zoom level.

Parameters:

unzoomedForeground - The new outline color for the unzoomed boxes.

getUnzoomedForeground

public Color getUnzoomedForeground()

Returns the foreground color used to draw the outline of the nodes below the minimum zoom level.

setUnzoomedBackground

public void setUnzoomedBackground(Color unzoomedBackground)

Sets the background color used to fill the nodes below the minimum zoom level.

Parameters:

unzoomedBackground - The new fill color for the unzoomed boxes.

getUnzoomedBackground

public Color getUnzoomedBackground()

Returns the background color used to fill the nodes below the minimum zoom level.

setGrayedWhenUnzoomed

public void setGrayedWhenUnzoomed(boolean grayedWhenUnzoomed)

Specifies whether half-zooming objects are drawn as gray boxes when the zoom level is less than the minimum zoom, or if they are drawn at their minimum size.

The default value of true.

Parameters:

grayedWhenUnzoomed - If true, half-zooming objects are drawn as gray boxes when the zoom level is less than the minimum zoom, and the gray boxes keep unzooming as the zoom level decreases. If false, the objects are always drawn at their minimum size whenever the zoom level is below the minimum zoom.

Since:

JViews 5.5

isGrayedWhenUnzoomed

public boolean isGrayedWhenUnzoomed()

Returns the flag specifying whether half-zooming objects are drawn as gray boxes when the zoom level is less than the minimum zoom, or if they are drawn at their minimum size.

Since:

JViews 5.5

createNodeGraphic

public IlvGraphic createNodeGraphic(IlvSDMEngine engine,
                                    Object node)

Wraps the graphic node created by the filtered renderer in an instance of IlvHalfZoomingGraphic.

Overrides:

createNodeGraphic in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine associated with the grapher in which the graphic object will be added.

node - The data node to translate into an IlvGraphic.

propertiesChanged

public void propertiesChanged(IlvSDMEngine engine,
                              Object object,
                              Collection<String> propertyNames,
                              IlvGraphic graphic)

Updates the properties of the graphic object encapsulated in the half-zooming graphic.

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

customize

public void customize(IlvSDMEngine engine,
                      Object object,
                      IlvGraphic g,
                      String[] pseudoClass)

Customizes the graphic object encapsulated in the half-zooming graphic.

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-classes of the object. This parameter can be null.

getLinkConnectionRectangle

public IlvRect getLinkConnectionRectangle(IlvSDMEngine engine,
                                          IlvGraphic graphic,
                                          IlvTransformer t,
                                          IlvLinkConnector lc)

Computes the rectangle on which the connection points of the links to/from this node should be located, taking into account that the nodes do not always zoom according to the view transformer.

Overrides:

getLinkConnectionRectangle in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

graphic - The graphic object returned by createNodeGraphic.

t - The transformer of the view.

lc - The link connector from which this is called.

Returns:

A rectangle in view coordinates.

getEncapsulatedGraphic

public IlvGraphic getEncapsulatedGraphic(IlvGraphic graphic)

Returns the graphic object encapsulated in the half-zooming graphic.

Overrides:

getEncapsulatedGraphic in class IlvFilterSDMRenderer

Parameters:

graphic - A graphic object returned by createNodeGraphic.

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