ilog.views.sdm.renderer

Class IlvSDMCSSFunction

java.lang.Object

ilog.views.util.styling.IlvCSSFunction

ilog.views.sdm.renderer.IlvSDMCSSFunction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvSDMCSSFunction.SymbolInteractor, IlvSDMCSSFunction.Test

public abstract class IlvSDMCSSFunction
extends IlvCSSFunction
implements Serializable

This interface define functions in IlvStyleSheetRenderer, so x they can be called from a style sheet. An implementation must be registered before being usable, either directly in Java or through the style sheet itself. See the User Manual for more details.

Note that this class inherits from class IlvCSSFunction to ease compatibility with other JViews modules. However all methods are overloaded here.

Since:

JViews 6.0

See Also:

IlvStyleSheetRenderer.registerFunction(ilog.views.sdm.renderer.IlvSDMCSSFunction), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvSDMCSSFunction.Feedback A placeholder which contains a String and an object.
static class	IlvSDMCSSFunction.NumericSymbolInteractor SymbolInteractor subclass to handle numerical values.
static class	IlvSDMCSSFunction.StateSymbolInteractor SymbolInteractor subclass to handle String values.
static class	IlvSDMCSSFunction.SymbolInteractor CSS function to handle symbol interactions in a cleaner way.
static class	IlvSDMCSSFunction.Test Test function.

Field Summary

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

ANY, ANY_PROPERTIES, ANY_PSEUDOCLASSES

Constructor Summary

Constructors

Constructor and Description
IlvSDMCSSFunction() Constructor for IlvSDMCSSFunction.

Method Summary

Modifier and Type	Method and Description
Object	call(Object[] args, Class<?> type, ilog.views.util.css.IlvCSSModel model, Object node, Object target, Object closure) This method comes from the superclass and isn't used inside SDM scope.
abstract Object	call(Object[] args, Class<?> type, IlvSDMEngine engine, Object node, Object target) Calls the function.
String	getDelimiters() Returns the delimiters of the function parameters.
Collection<String>	getDependencies(String[] args) Returns the dependencies of this function.
abstract String	getName() Returns the name of the function that will be known in the style sheet.
IlvSDMCSSFunction.Feedback[]	invert(Object[] args, Object value, IlvSDMEngine engine, Object target) This method is called from the style sheet renderer to update a model object property.
boolean	returnDelimitersAsToken() Returns whether the delimiters are also returned as tokens.

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

IlvSDMCSSFunction

public IlvSDMCSSFunction()

Constructor for IlvSDMCSSFunction.

Method Detail

getName

public abstract String getName()

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

Specified by:

getName in class IlvCSSFunction

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).

Overrides:

getDelimiters in class IlvCSSFunction

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.

Overrides:

returnDelimitersAsToken in class IlvCSSFunction

Returns:

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

call

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

This method comes from the superclass and isn't used inside SDM scope.

Specified by:

call in class IlvCSSFunction

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.

See Also:

call(Object[], Class, ilog.views.sdm.IlvSDMEngine, Object, Object)

call

public abstract Object call(Object[] args,
                            Class<?> type,
                            IlvSDMEngine engine,
                            Object node,
                            Object target)

Calls the function.

Parameters:

args - The parameters of the function.

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

engine - The current engine. It may be null if the IlvStyleSheetRenderer is disconnected from an engine.

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. Note that the model object can easily be found if args contains the parameter id.

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 engine.getModel().getObjectProperty(node, property.
• IlvCSSFunction.ANY_PROPERTIES Any unknown set of properties.
• IlvCSSFunction.ANY_PSEUDOCLASSES Any unknown set of pseudoclasses.
• IlvCSSFunction.ANY Any other dependencies, such as state contained in global variables, or random numbers. Returned when the call's result must not be cached.

This implementation returns [ ANY ].

Overrides:

getDependencies in class IlvCSSFunction

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

invert

public IlvSDMCSSFunction.Feedback[] invert(Object[] args,
                                           Object value,
                                           IlvSDMEngine engine,
                                           Object target)

This method is called from the style sheet renderer to update a model object property. When a graphic object has changed one of its properties, for example in an editor, the new value must be propagated to the model. Usually the the graphic property comes from the model through a declaration such as "label : @text;", meaning that when the label is edited, the text property should be updated. Now if a function is modifying the property translation on the fly, the function should be able to compute the right value. This is the purpose of this method.

NOTE: inverting a function is not always possible. This method can return null to indicate the inversion fails.

Parameters:

args - The parameters of the functions, as they come from the style sheet.

value - The value coming from the graphic objects.

engine - The current engine.

target - The model object.

Returns:

An array of model properties/values to assign to them. The method throws an IllegalArgumentException if the function is not able to compute back the result, or null if "don't care." The default implementation returns null.