ilog.views.sdm.renderer

Class IlvBlinkingRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvBlinkingRenderer

All Implemented Interfaces:

Serializable

public class IlvBlinkingRenderer
extends IlvFilterSDMRenderer

The class IlvBlinkingRenderer is a filtering renderer that makes the grapher objects blinking. It works together the classes IlvBlinkingColor, IlvBlinkingPaint, IlvBlinkingMultiColor, and IlvBlinkingMultiPaint.

This example shows how to toggle the colors of the grapher objects every seconds.

 SDM {
   Blinking : "true";
 }
 Blinking {
   onPeriod : 1000;  // Every second
   offPeriod : 1000;  // Every second
 }
 node {
   class : "ilog.views.sdm.graphic.IlvGeneralNode" ;
   label : "@name" ;
   // toggles from red to black (2 states):
   fillColor1 : "B1000/1000[red/black]" ; 
   // toggles from black to transparent red to yellow (3 states):
   labelColor : "B500[black/#aaff0000/yellow]" ;
 }
 

An alternative way to specify blinking 2-state colors is by using the blinkingColor function:

 node {
   class : "ilog.views.sdm.graphic.IlvGeneralNode" ;
   label : "@name" ;
   // toggles from red to black:
   fillColor1 : "@|blinkingColor(red,black)" ; 
   // toggles from black to fully transparent (that is, invisible): 
   labelColor : "@|blinkingColor(black,#00000000)" ; 
 }
 

This example extract shows how to specify a more complex blinking paint that toggles between two paints every seconds.

 node {
   class : "ilog.views.graphic.IlvGeneralPath";
   fillPaint : "@=fillPaint";
   fillOn : "true";
 }
 Subobject#fillPaint {
   class : "ilog.views.util.java2d.IlvBlinkingPaint(onPaint,offPaint,onPeriod,offPeriod)";
   onPaint : "@#onPaint";
   offPaint : "@#offPaint";
   onPeriod : "1000";
   offPeriod : "1000";
 }
 Subobject#onPaint {
   class : "java.awt.GradientPaint(point1,color1,point2,color2)";
   point1 : "0.0,0.0";
   color1 : "white";
   point2 : "72.0,72.0";
   color2 : "255,0,51";
 }
 Subobject#offPaint {
   class : "java.awt.GradientPaint(point1,color1,point2,color2)";
   point1 : "0.0,0.0";
   color1 : "255,0,51";
   point2 : "72.0,72.0";
   color2 : "white";
 }
 

Besides blinking colors and paints, the rendering property ToggleVisibility switches the visibility of the objects. For instance:

 SDM {
   Blinking: "true";
 }
 Blinking {
   onPeriod: 1000;  // Every second
   offPeriod: 1000;  // Every second
 }
 node {
   ToggleVisibility : "true";
   class : "ilog.views.sdm.graphic.IlvGeneralNode";
   label : @Name;
 }
 

Since:

JViews 6.0

See Also:

IlvBlinkingColor, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TOGGLE_VISIBILITY The ToggleVisibility renderer property.

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

Method Summary

Modifier and Type	Method and Description
void	addNodeGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw) Adds the graphic object returned by createNodeGraphic() to the grapher of the SDM engine.
void	customize(IlvSDMEngine engine, Object object, IlvGraphic g, String[] pseudoClasses) This method simply calls the customize method of the filtered renderer.
IlvBlinkingColor	getColor(Color onColor, Color offColor, long onPeriod, long offPeriod) Returns a blinking color to be used by this blinking manager.
int	getOffPeriod() Returns the off period.
int	getOnPeriod() Returns the on period.
boolean	isEnabled() Tests if blinking is enabled.
void	propertiesChanged(IlvSDMEngine engine, Object node, Collection<String> propertyNames, IlvGraphic graphic) This method simply calls the propertiesChanged method of the filtered renderer.
void	registerToggleGraphic(IlvGraphic graphic)
void	removeNodeGraphic(IlvSDMEngine engine, Object node, IlvGraphic graphic, boolean redraw) Removes a graphic object representing a node of the SDM data model from the grapher.
void	setEnabled(boolean on) Sets whether blinking is enabled.
void	setOffPeriod(int offPeriod) Sets the off period.
void	setOnPeriod(int onPeriod) Sets the on period
void	unregisterToggleGraphic(IlvGraphic graphic)

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

addLinkGraphic, computeBBox, createLinkGraphic, createNodeGraphic, getEncapsulatedGraphic, getFilteredRenderer, getGraphicProperty, getLinkConnectionRectangle, linkGraphicAdded, moveResizeNodeGraphic, nodeGraphicAdded, nodeGraphicBBoxChanged, prepareRendering, processServerAction, removeAll, removeLinkGraphic, 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

Field Detail

TOGGLE_VISIBILITY

public static final String TOGGLE_VISIBILITY

The ToggleVisibility renderer property.

Since:

JViews 8.0

See Also:

Constant Field Values

Constructor Detail

IlvBlinkingRenderer

public IlvBlinkingRenderer(IlvSDMRenderer renderer)

Creates a new IlvBlinkingRenderer renderer for a specified filtered renderer.

Parameters:

renderer - the next renderer in chain

IlvBlinkingRenderer

public IlvBlinkingRenderer()

Creates a new IlvBlinkingRenderer renderer with a null filtered renderer.

Method Detail

setOnPeriod

public void setOnPeriod(int onPeriod)

Sets the on period

Parameters:

onPeriod - the new value

getOnPeriod

public int getOnPeriod()

Returns the on period.

Returns:

on period

setOffPeriod

public void setOffPeriod(int offPeriod)

Sets the off period.

Parameters:

offPeriod - the new value

getOffPeriod

public int getOffPeriod()

Returns the off period.

Returns:

the off period

setEnabled

public void setEnabled(boolean on)

Sets whether blinking is enabled.

Parameters:

on - Set to false to disable blinking. The default value is false.

Since:

JViews 8.1

isEnabled

public boolean isEnabled()

Tests if blinking is enabled.

Returns:

If blinking is enabled, true is returned.

Since:

JViews 8.1

getColor

public IlvBlinkingColor getColor(Color onColor,
                                 Color offColor,
                                 long onPeriod,
                                 long offPeriod)

Returns a blinking color to be used by this blinking manager. The blinking manager can choose to reuse blinking colors or to recreate new blinking colors whenever this method is called.

Parameters:

onColor - The color of the on period.

offColor - The color of the off period.

onPeriod - duration in milliseconds of the period to display the onColor

offPeriod - duration in milliseconds of the period to display the offColor

Returns:

the blinking color.

Since:

JViews 8.5

addNodeGraphic

public void addNodeGraphic(IlvSDMEngine engine,
                           Object node,
                           IlvGraphic graphic,
                           boolean redraw)

Adds the graphic object returned by createNodeGraphic() to the grapher of the SDM engine.

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 to translate into an IlvGraphic.

graphic - The graphic object returned by createGraphic.

redraw - If true, the region covered by the new graphic object must be redrawn.

See Also:

IlvSDMRenderer.createNodeGraphic(ilog.views.sdm.IlvSDMEngine, java.lang.Object)

removeNodeGraphic

public void removeNodeGraphic(IlvSDMEngine engine,
                              Object node,
                              IlvGraphic graphic,
                              boolean redraw)

Removes a graphic object representing a node of the SDM data model from the grapher.

Overrides:

removeNodeGraphic in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine associated with the grapher from which the graphic object will be removed.

node - The node that has been removed or modified in the data model.

graphic - The graphic object that must be removed from the grapher.

redraw - If true, the region covered by the graphic object must be redrawn.

propertiesChanged

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

This method simply calls the propertiesChanged method of the filtered renderer.

Overrides:

propertiesChanged in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine associated with the grapher in which the graphic object is displayed.

node - 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[] pseudoClasses)

This method simply calls the customize method of the filtered renderer.

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.

pseudoClasses - The pseudo-classes of the object. This parameter can be null.

registerToggleGraphic

public void registerToggleGraphic(IlvGraphic graphic)

Parameters:

graphic - the graphic

Internal: do not use!

unregisterToggleGraphic

public void unregisterToggleGraphic(IlvGraphic graphic)

Parameters:

graphic - the graphic

Internal: do not use!