ilog.tgo.css.function
Class IltBlinkingColorFunction

java.lang.Object
  ilog.views.util.styling.IlvCSSFunction
      ilog.cpl.css.function.IlpConvertionFunction
          ilog.tgo.css.function.IltBlinkingColorFunction

All Implemented Interfaces:

Serializable

public class IltBlinkingColorFunction
extends IlpConvertionFunction

Function to create blinking colors.

The function should be defined as follows:

    aColor : '@|blinkingcolor("green", "red")'
    bColor : '@|blinkingcolor("#FF00FF00", "255, 0, 0")'
    cColor : '@|blinkingcolor("black", "white", "1000", "500")'
    dColor : '@|blinkingcolor("green")'
   

This definition will create a blinking color with the corresponding colors. The first argument is the on color. The following arguments are optional:

• The off color; if not present, a transparent color will be used.
• The on period in milliseconds.
• The off period in milliseconds.

The on color and off color may be given by name, their RGB components, or the combined RGBA (alpha is optional) components.

Note1: The function must be fully quoted in order to be parsed correctly.

Note2: The color arguments for the function are based on the java.awt.Color decoding mechanism. The color conversion has been extended to recognize full names from Java definition and SVG. Refer to SVG Color Keywords for more details.

If the function argument is not valid or cannot be parsed, an IllegalArgumentException will be thrown.

Since:

JTGO 3.5

See Also:

Serialized Form

Constructor Summary

IltBlinkingColorFunction()
Constructor.

IltBlinkingColorFunction(IlpContext context)
Constructor.

Method Summary

Object	call(Object[] args, Class type, ilog.views.util.css.IlvCSSModel model, Object node, Object target, Object closure) Method called to execute the function.
String	getDelimiters() Returns the delimiters of the function parameters.
String	getName() Retrieves the name of the function, which is "blinkingcolor".
boolean	returnDelimitersAsToken() Returns true whether the delimiters are returned also as token.

Methods inherited from class ilog.cpl.css.function.IlpConvertionFunction

convertColor, getContext

Methods inherited from class ilog.views.util.styling.IlvCSSFunction

getImportance, getShortDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

IltBlinkingColorFunction

public IltBlinkingColorFunction()

Constructor.

It has no arguments and gets the default context from IlpSystem.

IltBlinkingColorFunction

public IltBlinkingColorFunction(IlpContext context)

Constructor.

Parameters:

context - A context to be used by the function.

Method Detail

getName

public String getName()

Retrieves the name of the function, which is "blinkingcolor".

Specified by:

getName in class IlvCSSFunction

getDelimiters

public String getDelimiters()

Returns the delimiters of the function parameters.

Overrides:

getDelimiters in class IlvCSSFunction

Returns:

A string containing the accepted delimiters for this function, which is ",".

returnDelimitersAsToken

public boolean returnDelimitersAsToken()

Returns true whether the delimiters are returned also as token.

Overrides:

returnDelimitersAsToken in class IlvCSSFunction

Returns:

For this function it returns false.

call

public Object call(Object[] args,
                   Class type,
                   ilog.views.util.css.IlvCSSModel model,
                   Object node,
                   Object target,
                   Object closure)

Method called to execute the function.

Specified by:

call in class IlvCSSFunction

Parameters:

args - List of arguments passed to the function.

type - Expected type of the object returned by the function.

model - The CSS model being used.

node - Current model object being called on

target - The target object where the returned object will be applied.

closure - An object set by IlvCSSBeans.setFunctionClosure(java.lang.Object)

Returns:

The value computed by this function, which is Color.