ilog.tgo.service

Class IltDefaultBlinkingManager

java.lang.Object

ilog.tgo.service.IltDefaultBlinkingManager

All Implemented Interfaces:

IlpBlinkingManager, IlpService

Direct Known Subclasses:

IltDefaultBlinkingManager

public class IltDefaultBlinkingManager
extends Object
implements IlpBlinkingManager

Default implementation of the blinking manager.

Since:

JTGO 4.0

See Also:

IlpBlinkingManager

Constructor Summary

Constructors

Constructor and Description
IltDefaultBlinkingManager(long onPeriod, long offPeriod) Creates a blinking manager.
IltDefaultBlinkingManager(long onPeriod, long offPeriod, long coalesceTime) Deprecated. Please use IltDefaultBlinkingManager(long, long) instead.

Method Summary

Modifier and Type	Method and Description
void	addColor(IlpBlinkingColor color) Adds a blinking color to this object.
void	clearColorMap() Remove all the blinking colors stored in this manager.
long	getCoalesceTime() Deprecated.
IlpBlinkingColor	getColor(Color onColor, Color offColor, long onPeriod, long offPeriod) Returns a blinking color to be used by this blinking manager.
long	getOffPeriod() Returns the default duration of off periods in milliseconds.
long	getOnPeriod() Returns the default duration of on periods in milliseconds.
void	removeColor(IlpBlinkingColor color) Removes a blinking color from this object.
void	setCoalesceTime(long coalesceTime) Deprecated.
void	setOffPeriod(long offPeriod) Sets the default duration of off periods in milliseconds.
void	setOnPeriod(long onPeriod) Sets the default duration of on periods in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

IltDefaultBlinkingManager

@Deprecated
public IltDefaultBlinkingManager(long onPeriod,
                                             long offPeriod,
                                             long coalesceTime)

Deprecated. Please use IltDefaultBlinkingManager(long, long) instead.

Creates a blinking manager.

Parameters:

onPeriod - The duration, in milliseconds, of default on periods

offPeriod - The duration, in milliseconds, of default off periods

coalesceTime - The minimum time between redraw events that will be grouped together

Deprecated Since:

JTGO 3.1

IltDefaultBlinkingManager

public IltDefaultBlinkingManager(long onPeriod,
                                 long offPeriod)

Creates a blinking manager.

Parameters:

onPeriod - The duration, in milliseconds, of default on periods

offPeriod - The duration, in milliseconds, of default off periods

Method Detail

getOnPeriod

public long getOnPeriod()

Description copied from interface: IlpBlinkingManager

Returns the default duration of on periods in milliseconds.

Specified by:

getOnPeriod in interface IlpBlinkingManager

setOnPeriod

public void setOnPeriod(long onPeriod)

Description copied from interface: IlpBlinkingManager

Sets the default duration of on periods in milliseconds.

Specified by:

setOnPeriod in interface IlpBlinkingManager

getOffPeriod

public long getOffPeriod()

Description copied from interface: IlpBlinkingManager

Returns the default duration of off periods in milliseconds.

Specified by:

getOffPeriod in interface IlpBlinkingManager

setOffPeriod

public void setOffPeriod(long offPeriod)

Description copied from interface: IlpBlinkingManager

Sets the default duration of off periods in milliseconds.

Specified by:

setOffPeriod in interface IlpBlinkingManager

getCoalesceTime

@Deprecated
public long getCoalesceTime()

Deprecated.

Description copied from interface: IlpBlinkingManager

Returns the minimum time between redraw events that will be grouped together.

Specified by:

getCoalesceTime in interface IlpBlinkingManager

Deprecated Since:

JTGO 3.1

setCoalesceTime

@Deprecated
public void setCoalesceTime(long coalesceTime)

Deprecated.

Description copied from interface: IlpBlinkingManager

Sets the minimum time between redraw events that will be grouped together.

Specified by:

setCoalesceTime in interface IlpBlinkingManager

Deprecated Since:

JTGO 3.1

addColor

public void addColor(IlpBlinkingColor color)

Description copied from interface: IlpBlinkingManager

Adds a blinking color to this object. A blinking color MUST be added to a blinking manager in order to blink.

Specified by:

addColor in interface IlpBlinkingManager

Parameters:

color - Blinking color to be added.

removeColor

public void removeColor(IlpBlinkingColor color)

Description copied from interface: IlpBlinkingManager

Removes a blinking color from this object.

Specified by:

removeColor in interface IlpBlinkingManager

Parameters:

color - Blinking color to be removed.

getColor

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

Returns a blinking color to be used by this blinking manager.

This blinking manager implementation verifies if a blinking color with the given characteristics already exists. In this case, the existing blinking color is returned. Otherwise a new blinking color is created and registered in this blinking manager.

Specified by:

getColor in interface IlpBlinkingManager

Parameters:

onColor - on color

offColor - off color

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

clearColorMap

public void clearColorMap()

Remove all the blinking colors stored in this manager. The colors are added by the method getColor(Color, Color, long, long).