ilog.views.util.styling

Class IlvCSSFunction

java.lang.Object

ilog.views.util.styling.IlvCSSFunction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlpConvertionFunction, IlpUIManagerResourceFunction, IltLinkPortFunction, IltPatternFunction, IlvGanttFunction.ActivityProperty, IlvGanttFunction.DarkerColor, IlvGanttFunction.FormatDate, IlvGanttFunction.FormatDuration, IlvSDMCSSFunction

public abstract class IlvCSSFunction
extends Object
implements Serializable

The abstract base class that defines functions in CSS expressions so that they can be called from a style sheet. An implementation must be registered IlvAcceptFunctions.registerFunction(ilog.views.util.styling.IlvCSSFunction) before being usable. See the User Manual for more details.

The following functions are registered by default: concat, id, type. int, long, float, double, The first one concatenates strings, the next two returns current node ID and type respectively, the others compute an arithmetic function of the suggested type. Example:

 foo[speed] {
     mph = @|float(@speed*1.6);
 }
 

Since:

JViews 6.0

See Also:

IlvAcceptFunctions.registerFunction(ilog.views.util.styling.IlvCSSFunction), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY This placeholder can be used in dependencies sets, and can be returned from the getDependencies(String[]) method, indicating anything: all possible properties, all possible pseudoclasses, and even influenced from outside (such as state contained in the closure, or random numbers).
static String	ANY_PROPERTIES This placeholder can be used in dependencies sets, and can be returned from the getDependencies(String[]) method, indicating all possible model properties.
static String	ANY_PSEUDOCLASSES This placeholder can be used in dependencies sets, and can be returned from the getDependencies(String[]) method, indicating all possible pseudoclasses.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvCSSFunction() Creates a new IlvCSSFunction.

Method Summary

Modifier and Type	Method and Description
abstract Object	call(Object[] args, Class<?> type, ilog.views.util.css.IlvCSSModel model, Object node, Object target, Object closure) Calls the function.
String	getDelimiters() Returns the delimiters of the function parameters.
Collection<String>	getDependencies(String[] args) Returns the dependencies of this function.
float	getImportance() Returns the importance of the function.
abstract String	getName() Returns the name of the function that will be known in the style sheet.
String	getShortDescription() Returns a short description of the function.
boolean	returnDelimitersAsToken() Returns whether the delimiters are also returned as tokens.

Methods inherited from class java.lang.Object

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

Field Detail

ANY_PROPERTIES

public static final String ANY_PROPERTIES

This placeholder can be used in dependencies sets, and can be returned from the getDependencies(String[]) method, indicating all possible model properties.

Since:

JViews 8.5

See Also:

Constant Field Values

ANY_PSEUDOCLASSES

public static final String ANY_PSEUDOCLASSES

This placeholder can be used in dependencies sets, and can be returned from the getDependencies(String[]) method, indicating all possible pseudoclasses.

Since:

JViews 8.5

See Also:

Constant Field Values

ANY

public static final String ANY

This placeholder can be used in dependencies sets, and can be returned from the getDependencies(String[]) method, indicating anything: all possible properties, all possible pseudoclasses, and even influenced from outside (such as state contained in the closure, or random numbers).

Since:

JViews 8.5

See Also:

Constant Field Values

Constructor Detail

IlvCSSFunction

protected IlvCSSFunction()

Creates a new IlvCSSFunction.

Method Detail

getName

public abstract String getName()

Returns the name of the function that will be known in the style sheet.

getDelimiters

public String getDelimiters()

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

Warning: css functions are processed inside an expression module which evaluates arithmetic operations before breaking the argument according to the delimiters. For example if "+" is a delimiter, the argument "3+1" will be evaluated to "4" instead of two arguments (3,1).

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.

returnDelimitersAsToken

public boolean returnDelimitersAsToken()

Returns whether the delimiters are also returned as tokens.

Returns:

true means the delimiters are returned as tokens, false means the delimiters are discarded (default).

call

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

Calls the function.

Parameters:

args - The parameters of the function.

type - The expected returned type, which may be null. It is wise to return an object compatible with the expected type, or a String.

model - The current model. Usually the model comes from the engine, but there are some situations where it is a new model.

node - The current node. This is the current model object being called on. Inside a @# construct, node represents the parent of the fake node indeed used to process the @# construct, i.e. the real node of interest.

target - The current rendered object being called on.

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

Returns:

The value computed by this function.

getDependencies

public Collection<String> getDependencies(String[] args)

Returns the dependencies of this function. This is the list of things that may cause the call(java.lang.Object[], java.lang.Class<?>, ilog.views.util.css.IlvCSSModel, java.lang.Object, java.lang.Object, java.lang.Object) method, called with the same arguments, to return a different value. Possible elements are:

• Property names property. Returned when the call depends on model.getValue(node, property or model.getValueAsObject(node, property.
• ANY_PROPERTIES Any unknown set of properties.
• ANY_PSEUDOCLASSES Any unknown set of pseudoclasses.
• ANY Any other dependencies, such as state contained in the closure, or random numbers. Returned when the call's result must not be cached.

Parameters:

args - The simple identifier arguments of a call to this function. This is an array that contains, for every argument expression, the argument expression if it is a simple identifier, or null if it is a string literal, number literal, boolean literal, or any other kind of expression.

Since:

JViews 8.5

getShortDescription

public String getShortDescription()

Returns a short description of the function. This description is used for instance in the expression editor of the customizers, to describe the function proposed to the user. The description should be localized to the locale returned by IlvLocaleUtil.getCurrentLocale().

Since:

JViews 7.5

getImportance

public float getImportance()

Returns the importance of the function. The importance helps an editor to sort the functions according to their importance. 0 means the function is not important and should be hidden, 1 means it is very important. Default value is 0.7. Built-in functions are between 0.6 and 0.7.
By convention, designers show only functions with importance >= .5
Note that the importance doesn't affect the function itself. 0-importance functions work as well as 1.0 ones.

Returns:

function importance value, a float between 0.0 and 1.0.

Since:

JViews 7.5