ilog.views.util.java2d

Class IlvBlinkingPaint

java.lang.Object

ilog.views.util.java2d.IlvBlinkingPaint

All Implemented Interfaces:

IlvAdaptablePaint, IlvBlinkingDrawingResource, Paint, Transparency

public class IlvBlinkingPaint
extends Object
implements Paint, IlvAdaptablePaint, IlvBlinkingDrawingResource

This class defines a blinking paint. It can be used in classes as paints, if the corresponding property is documented to support blinking paints. Several subclasses of IlvGraphic support blinking paints.

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

Field Summary

Fields inherited from interface ilog.views.util.java2d.IlvAdaptablePaint

KEY_USER_BOUNDS

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Constructor Summary

Constructors

Constructor and Description
IlvBlinkingPaint(Paint onPaint, Paint offPaint) Creates a new blinking paint.
IlvBlinkingPaint(Paint onPaint, Paint offPaint, long onPeriod, long offPeriod) Creates a new blinking paint.

Method Summary

Modifier and Type	Method and Description
PaintContext	createContext(ColorModel cm, Rectangle r, Rectangle2D r2d, AffineTransform xform, RenderingHints hints) Creates and returns a PaintContext.
boolean	equals(Object obj) Determines whether another object is equal to this IlvBlinkingPaint.
Paint	getCurrentPaint() Returns current paint.
Paint	getOffPaint() Returns the paint of the "off" period.
long	getOffPeriod() Returns the duration, in milliseconds, of the "off" period.
Paint	getOnPaint() Returns the paint of the "on" period.
long	getOnPeriod() Returns the duration, in milliseconds, of the "on" period.
int	getTransparency() Returns the transparency mode for this Paint.
int	hashCode() Returns the hash code of this object.
boolean	isAdapting() Returns true if the createContext method of this object may rely on its userBounds argument.
boolean	isOn() Returns true if this paint displays like the "on" state, and false if this paint displays like the "off" state.
void	notifyUsed(IlvBlinkingObject obj, boolean used) Called by IlvGraphic if this paint is used.
void	setOn(boolean flag) Sets whether this paint displays like the "on" or "off" state.
void	setTemporarilyDisabled(boolean flag) Temporarily disable the blinking.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBlinkingPaint

public IlvBlinkingPaint(Paint onPaint,
                        Paint offPaint)

Creates a new blinking paint.

Parameters:

onPaint - Paint used during the "on" period

offPaint - Paint used during the "off" period

IlvBlinkingPaint

public IlvBlinkingPaint(Paint onPaint,
                        Paint offPaint,
                        long onPeriod,
                        long offPeriod)

Creates a new blinking paint.

Parameters:

onPaint - Paint used during the "on" period

offPaint - Paint used during the "off" period

onPeriod - Duration, in milliseconds, of the "on" period

offPeriod - Duration, in milliseconds, of the "off" period

Method Detail

equals

public boolean equals(Object obj)

Determines whether another object is equal to this IlvBlinkingPaint.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns the hash code of this object.

Overrides:

hashCode in class Object

createContext

public PaintContext createContext(ColorModel cm,
                                  Rectangle r,
                                  Rectangle2D r2d,
                                  AffineTransform xform,
                                  RenderingHints hints)

Creates and returns a PaintContext. If the current state is on, it returns a context representing the "on paint", otherwise the "off paint".

Specified by:

createContext in interface Paint

Parameters:

cm - the specified ColorModel

r - the specified Rectangle

r2d - the specified Rectangle2D

xform - the specified AffineTransform

hints - the specified RenderingHints

Returns:

a PaintContext that is used to generate a solid color pattern.

See Also:

Paint.createContext(java.awt.image.ColorModel, java.awt.Rectangle, java.awt.geom.Rectangle2D, java.awt.geom.AffineTransform, java.awt.RenderingHints), Paint, PaintContext, getOnPaint(), getOffPaint()

getTransparency

public int getTransparency()

Returns the transparency mode for this Paint. If the current state is on, it returns a transparency of the "on paint", otherwise of the "off paint".

Specified by:

getTransparency in interface Transparency

Returns:

This Paint object's transparency mode.

See Also:

Paint, Transparency, getOnPaint(), getOffPaint()

isAdapting

public boolean isAdapting()

Returns true if the createContext method of this object may rely on its userBounds argument.

Specified by:

isAdapting in interface IlvAdaptablePaint

Since:

JViews 8.8

getCurrentPaint

public Paint getCurrentPaint()

Returns current paint.

Returns:

current paint

getOnPaint

public Paint getOnPaint()

Returns the paint of the "on" period.

Returns:

The "on" paint

getOffPaint

public Paint getOffPaint()

Returns the paint of the "off" period.

Returns:

The "off" paint

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 paint displays like the "on" or "off" state.

Specified by:

setOn in interface IlvBlinkingDrawingResource

Parameters:

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

isOn

public boolean isOn()

Returns true if this paint displays like the "on" state, and false if this paint 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 paint is used. You should not call this method.

Specified by:

notifyUsed in interface IlvBlinkingDrawingResource

Parameters:

obj - The blinking object.

used - Whether the paint is used.