ilog.cpl.service

Interface IlpBlinkingManager

All Superinterfaces:

IlpService

All Known Implementing Classes:

IltDefaultBlinkingManager, IltDefaultBlinkingManager

public interface IlpBlinkingManager
extends IlpService

The blinking manager manages blinking colors.

Since:

JTGO 3.0

Method Summary

Modifier and Type	Method and Description
void	addColor(IlpBlinkingColor color) Adds a blinking color to this object.
long	getCoalesceTime() Deprecated. This method is obsolete. The coalesce time does not exist anymore.
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. This method is obsolete. The coalesce time does not exist anymore.
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.

Method Detail

getOnPeriod

long getOnPeriod()

Returns the default duration of on periods in milliseconds.

setOnPeriod

void setOnPeriod(long onPeriod)

Sets the default duration of on periods in milliseconds.

getOffPeriod

long getOffPeriod()

Returns the default duration of off periods in milliseconds.

setOffPeriod

void setOffPeriod(long offPeriod)

Sets the default duration of off periods in milliseconds.

getCoalesceTime

@Deprecated
long getCoalesceTime()

Deprecated. This method is obsolete. The coalesce time does not exist anymore.

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

Deprecated Since:

JTGO 3.1

setCoalesceTime

@Deprecated
void setCoalesceTime(long coalesceTime)

Deprecated. This method is obsolete. The coalesce time does not exist anymore.

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

Deprecated Since:

JTGO 3.1

addColor

void addColor(IlpBlinkingColor color)

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

Parameters:

color - Blinking color to be added.

removeColor

void removeColor(IlpBlinkingColor color)

Removes a blinking color from this object.

Parameters:

color - Blinking color to be removed.

getColor

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

Returns a blinking color to be used by this blinking manager. The blinking manager can choose to reuse blinking colors or to recreate new ones whenever this method is called.

Parameters:

onColor - Color representing the on blinking state.

offColor - Color representing the off blinking state.

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.

Since:

JTGO 4.0