ilog.tgo.css.function

Class IltSettingsFunction

java.lang.Object

ilog.tgo.css.function.IltSettingsFunction

All Implemented Interfaces:

IlpCSSFunction, Serializable

public class IltSettingsFunction
extends Object
implements IlpCSSFunction

Defines a function to retrieve the value of a JTGO setting. The function should be defined as follows:

   icon : '@|settings("Link.Media.Fiber.Icon")';
 

Since:

JTGO 4.5

See Also:

IltSettings, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IltSettingsFunction() The constructor.

Method Summary

Modifier and Type	Method and Description
Object	call(Object[] args, Class type, IlpContext appc, IlpGraphicView view, IlpRepresentationObject ro, IlpAttribute attribute) Calls the function.
String	getDelimiters() Returns the delimiters of the function parameters.
String	getName() Retrieves the name of the function.
boolean	returnDelimitersAsToken() If delimiters are also returned as token, true is returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

IltSettingsFunction

public IltSettingsFunction()

The constructor.

Method Detail

getName

public String getName()

Retrieves the name of the function.

Specified by:

getName in interface IlpCSSFunction

Returns:

This method always returns "settings".

getDelimiters

public String getDelimiters()

Returns the delimiters of the function parameters.

Specified by:

getDelimiters in interface IlpCSSFunction

Returns:

Returns ",".

returnDelimitersAsToken

public boolean returnDelimitersAsToken()

If delimiters are also returned as token, true is returned.

Specified by:

returnDelimitersAsToken in interface IlpCSSFunction

Returns:

If the delimiters are discarded, false is returned.

call

public Object call(Object[] args,
                   Class type,
                   IlpContext appc,
                   IlpGraphicView view,
                   IlpRepresentationObject ro,
                   IlpAttribute attribute)

Calls the function.

Specified by:

call in interface IlpCSSFunction

Parameters:

args - The function parameters.

type - The expected type to be returned. This parameter can be null.

appc - The application context.

view - The graphic view.

ro - The current representation object.

attribute - The business attribute.

Returns:

The value computed by this function, which is a Color.