ilog.tgo.css.function

Class IltTinyImageFunction

java.lang.Object

ilog.tgo.css.function.IltTinyImageFunction

All Implemented Interfaces:

IlpCSSFunction, Serializable

public class IltTinyImageFunction
extends Object
implements IlpCSSFunction

Returns the image corresponding to the tiny representation of a predefined business object in the view.

The function should be used as follows:

 object."ilog.tgo.model.IltNetworkElement" {
  icon : '@|tinyImage()';
 }
 
 object."ilog.tgo.model.IltNetworkElement/graphicRepresentation" {
  icon : '@|tinyImage()';
 }
 

Note: This function does not support user-defined business objects.

Since:

JViews 8.5

See Also:

IltObject, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IltTinyImageFunction() Default 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() Returns the function name, tinyImage.
boolean	returnDelimitersAsToken() Returns true if the delimiters are also returned as token.

Methods inherited from class java.lang.Object

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

Constructor Detail

IltTinyImageFunction

public IltTinyImageFunction()

Default constructor

Method Detail

call

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

Description copied from interface: IlpCSSFunction

Calls the function.

Specified by:

call in interface IlpCSSFunction

Parameters:

args - The parameters of the functions.

type - The expected type to be returned. It 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. It is advisable to return an object compatible with the expected type or a String.

getDelimiters

public String getDelimiters()

Description copied from interface: IlpCSSFunction

Returns the delimiters of the function parameters. It is strongly recommended to return at least the comma (","). The default implementation returns ",".

Specified by:

getDelimiters in interface IlpCSSFunction

Returns:

A string containing all the accepted delimiters. A null or empty return value means there is no delimiter, so all the parameters are returned as a single token.

getName

public String getName()

Returns the function name, tinyImage.

Specified by:

getName in interface IlpCSSFunction

returnDelimitersAsToken

public boolean returnDelimitersAsToken()

Description copied from interface: IlpCSSFunction

Returns true if the delimiters are also returned as token.

Specified by:

returnDelimitersAsToken in interface IlpCSSFunction

Returns:

true means the delimiters are returned as token; false means the delimiters are discarded (default).