ilog.views.util.java2d

Class IlvBlinkingMultiColor

java.lang.Object

java.awt.Color

ilog.views.util.java2d.IlvBlinkingMultiColor

All Implemented Interfaces:

IlvBlinkingDrawingResource, Paint, Transparency, Serializable

public class IlvBlinkingMultiColor
extends Color
implements IlvBlinkingDrawingResource

This class defines a blinking color consisting of multiple subcolors. In each stage of the blinking, it displays one of the subcolors. It can be used in classes as colors, if the corresponding property is documented to support blinking colors. Several subclasses of IlvGraphic support blinking colors.

Limitation: For technical reasons, the period duration is 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.

Hashing (tables or maps) of a mixture of blinking colors and normal colors don't work, since the fully transparent white color claims to be equal to any blinking color (i.e. transparentWhite.equals(blinkingColor) returns true). However, this is no problem if the fully transparent color Color(255,255,255,0) never occurs.

Since:

JViews 8.5

See Also:

Serialized Form

Field Summary

Fields inherited from class java.awt.Color

black, BLACK, blue, BLUE, cyan, CYAN, DARK_GRAY, darkGray, gray, GRAY, green, GREEN, LIGHT_GRAY, lightGray, magenta, MAGENTA, orange, ORANGE, pink, PINK, red, RED, white, WHITE, yellow, YELLOW

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Constructor Summary

Constructors

Constructor and Description
IlvBlinkingMultiColor(Color... color) Creates a new multi blinking color.
IlvBlinkingMultiColor(long period, Color... color) Creates a new multi blinking color.

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 IlvBlinkingColor.
Color[]	getColors() Returns the colors used in the different phases.
Color	getCurrentColor() Returns current color.
long	getOffPeriod() Returns the duration, in milliseconds, of the "off" period.
long	getOnPeriod() Returns the duration, in milliseconds, of the "on" period.
long	getPeriod() Returns the duration, in milliseconds, of the "on" and "off" period.
int	getRGB() Returns the RGB value representing the color in the default sRGB ColorModel.
int	getTransparency() Returns the transparency mode for this Color.
int	hashCode() Returns the hash code of this object.
boolean	isOn() Returns true if this color displays like the "on" state, and false if this color displays like the "off" state.
void	notifyUsed(IlvBlinkingObject obj, boolean used) Called by IlvGraphic if this color is used.
void	setOn(boolean flag) Sets whether this color displays like the "on" or "off" state.
void	setTemporarilyDisabled(boolean flag) Temporarily disable the blinking.
String	toString() Returns a string representation of the object.

Methods inherited from class java.awt.Color

brighter, darker, decode, getAlpha, getBlue, getColor, getColor, getColor, getColorComponents, getColorComponents, getColorSpace, getComponents, getComponents, getGreen, getHSBColor, getRed, getRGBColorComponents, getRGBComponents, HSBtoRGB, RGBtoHSB

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBlinkingMultiColor

public IlvBlinkingMultiColor(Color... color)

Creates a new multi blinking color.

Parameters:

color - A number of colors (at least 2) used during the periods.

IlvBlinkingMultiColor

public IlvBlinkingMultiColor(long period,
                             Color... color)

Creates a new multi blinking color.

Parameters:

period - Duration, in milliseconds, of each period

color - A number of colors (at least 2) used during the periods.

Method Detail

equals

public boolean equals(Object obj)

Determines whether another object is equal to this IlvBlinkingColor.

Overrides:

equals in class Color

hashCode

public int hashCode()

Returns the hash code of this object.

Overrides:

hashCode in class Color

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 color", otherwise the "off color".

Specified by:

createContext in interface Paint

Overrides:

createContext in class Color

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:

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

getTransparency

public int getTransparency()

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

Specified by:

getTransparency in interface Transparency

Overrides:

getTransparency in class Color

Returns:

This Color object's transparency mode.

See Also:

Paint, Transparency

getRGB

public int getRGB()

Returns the RGB value representing the color in the default sRGB ColorModel. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).

Overrides:

getRGB in class Color

Returns:

the RGB value of the color in the default sRGB ColorModel.

getCurrentColor

public Color getCurrentColor()

Returns current color.

Returns:

current color

getColors

public Color[] getColors()

Returns the colors used in the different phases.

Returns:

The colors

getPeriod

public long getPeriod()

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

Returns:

The blinkning duration

getOnPeriod

public long getOnPeriod()

Returns the duration, in milliseconds, of the "on" period. This returns always the same value like getPeriod().

Specified by:

getOnPeriod in interface IlvBlinkingDrawingResource

Returns:

The "on" duration

getOffPeriod

public long getOffPeriod()

Returns the duration, in milliseconds, of the "off" period. This returns always the same value like getPeriod().

Specified by:

getOffPeriod in interface IlvBlinkingDrawingResource

Returns:

The "off" duration

setOn

public void setOn(boolean flag)

Sets whether this color 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 color displays like the "on" state, and false if this color 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 displays the first color. 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 color 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.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Color