ilog.views.java2d

Class IlvBlinkingAction

java.lang.Object

ilog.views.java2d.IlvBlinkingAction

All Implemented Interfaces:

IlvBlinkingDrawingResource

Direct Known Subclasses:

IlvBlinkingMultiAction

public abstract class IlvBlinkingAction
extends Object
implements IlvBlinkingDrawingResource

IlvBlinkingAction is an abstract action that is performed when blinking. During blinking, it periodically calls the method changeState(ilog.views.IlvGraphic, boolean), which can be overridden to modify the associated graphic object depending on the "on" state or "off" state. It allows to modify arbitrary display parameter of the graphic object. Example:

 IlvMarker marker = new IlvMarker(); 
 IlvBlinkingAction action = new IlvBlinkingAction() {
   protected void changeState(IlvGraphic obj, boolean isOn) {
     // no applyToObject necessary because the caller does it already for us
     IlvMarker marker = (IlvMarker)obj;
     if (isOn) {
       marker.setType(IlvMarker.IlvMarkerCircle);
     } else {
       marker.setType(IlvMarker.IlvMarkerPlus);
     }
   }
 };
 marker.setBlinkingAction(action);
 

Blinking actions can be shared among graphic objects, that is, you can set the same blinking action to different graphic objects.

Limitation: For technical reasons, the "on" and "off" durations are limited from 1 to max integer (not max long). It is recommended to use the same durations whenever possible for all objects, and to choose the durations not too small (e.g. not smaller than 100 ms), because otherwise the performance of the system will degrade dramatically.

Since:

JViews 8.5

Constructor Summary

Constructors

Constructor and Description
IlvBlinkingAction() Allocates a new blinking action.
IlvBlinkingAction(long onPeriod, long offPeriod) Allocates a new blinking action.

Method Summary

Modifier and Type	Method and Description
protected abstract void	changeState(IlvGraphic obj, boolean isOn) Implement this method to perform the actions when the state toggles between on and off.
long	getOffPeriod() Returns the duration, in milliseconds, of the "off" period.
long	getOnPeriod() Returns the duration, in milliseconds, of the "on" period.
boolean	isOn() Returns true if this drawing resource displays like the "on" state, and false if it displays like the "off" state.
void	notifyUsed(IlvBlinkingObject obj, boolean used) Called by IlvGraphic if this drawing resource is used.
void	setOn(boolean flag) Sets whether this drawing resource displays like the "on" or "off" state.
void	setTemporarilyDisabled(boolean flag) Temporarily disable the blinking.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBlinkingAction

public IlvBlinkingAction()

Allocates a new blinking action.

IlvBlinkingAction

public IlvBlinkingAction(long onPeriod,
                         long offPeriod)

Allocates a new blinking action.

Parameters:

onPeriod - The "on" duration, in milliseconds.

offPeriod - The "off" duration, in milliseconds.

Method Detail

getOnPeriod

public long getOnPeriod()

Returns the duration, in milliseconds, of the "on" period.

Specified by:

getOnPeriod in interface IlvBlinkingDrawingResource

Returns:

The "on" duration

getOffPeriod

public long getOffPeriod()

Returns the duration, in milliseconds, of the "off" period.

Specified by:

getOffPeriod in interface IlvBlinkingDrawingResource

Returns:

The "off" duration

setOn

public void setOn(boolean flag)

Sets whether this drawing resource displays like the "on" or "off" state. It is always called from the AWT event thread.

Specified by:

setOn in interface IlvBlinkingDrawingResource

Parameters:

flag - true means it displays like the "on" state.

changeState

protected abstract void changeState(IlvGraphic obj,
                                    boolean isOn)

Implement this method to perform the actions when the state toggles between on and off. This is always called inside an applyToObject session of the input graphic object, hence it is possible to modify graphic properties of the object directly. It is always called from the AWT event thread. Here is an example implementation:

 protected void changeState(IlvGraphic obj, boolean isOn) {
   // assume the associated object is always an IlvMarker
   IlvMarker marker = (IlvMarker)obj;
   // no applyToObject necessary because the caller does it already for us
   if (isOn) {
     marker.setType(IlvMarker.IlvMarkerCircle);
   } else {
     marker.setType(IlvMarker.IlvMarkerPlus);
   }
 }
 

Parameters:

obj - The graphic object associated with this action.

isOn - The next state.

isOn

public boolean isOn()

Returns true if this drawing resource displays like the "on" state, and false if it displays like the "off" state.

Specified by:

isOn in interface IlvBlinkingDrawingResource

Returns:

Whether it is on or off.

setTemporarilyDisabled

public void setTemporarilyDisabled(boolean flag)

Temporarily disable the blinking. When the blinking is temporarily disabled, the state is the "on" state. When the blinking gets reenabled later, it restores the old state.

Specified by:

setTemporarilyDisabled in interface IlvBlinkingDrawingResource

Parameters:

flag - true if temporarily disabled.

notifyUsed

public void notifyUsed(IlvBlinkingObject obj,
                       boolean used)

Called by IlvGraphic if this drawing resource is used. You should not call this method.

Specified by:

notifyUsed in interface IlvBlinkingDrawingResource

Parameters:

obj - The blinking object.

used - Whether the color is used.