ilog.views.util.java2d

Interface IlvBlinkingDrawingResource

All Known Implementing Classes:

IlvBlinkingAction, IlvBlinkingColor, IlvBlinkingMultiAction, IlvBlinkingMultiColor, IlvBlinkingMultiPaint, IlvBlinkingPaint

public interface IlvBlinkingDrawingResource

This interface defines colors and paints that can blink. They contain an "on" state and an "off" state. Blinking is done by switching between "on" and "off" state periodically.

Since:

JViews 8.5

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getOnPeriod

long getOnPeriod()

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

Returns:

The "on" duration

getOffPeriod

long getOffPeriod()

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

Returns:

The "off" duration

setOn

void setOn(boolean flag)

Sets whether this drawing resource displays like the "on" or "off" state.

Parameters:

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

isOn

boolean isOn()

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

Returns:

Whether it is on or off.

setTemporarilyDisabled

void setTemporarilyDisabled(boolean flag)

Temporarily disable the blinking. When the blinking is temporarily disabled, the status should be the "on" state. When the blinking gets reenabled later, it should restore the old state. It is recommended to implement this mechanism with a counter to allow reentrance.

Parameters:

flag - true if temporarily disabled.

notifyUsed

void notifyUsed(IlvBlinkingObject obj,
                boolean used)

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

Parameters:

obj - The blinking object.

used - Whether the drawing resource is used.