ilog.views.sdm.renderer

Class IlvSDMCSSFunction.Test

java.lang.Object

ilog.views.util.styling.IlvCSSFunction

ilog.views.sdm.renderer.IlvSDMCSSFunction

ilog.views.sdm.renderer.IlvSDMCSSFunction.Test

All Implemented Interfaces:

Serializable

Enclosing class:

IlvSDMCSSFunction

public static class IlvSDMCSSFunction.Test
extends IlvSDMCSSFunction

Test function. This function returns its first argument if it exists, or its name.

This function is not registered by default. To register it in the designer, use the edit/Function dialog and enter the qualified name: ilog.views.sdm.renderer.IlvSDMCSSFunction$Test

Since:

JViews-7-5

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.sdm.renderer.IlvSDMCSSFunction

IlvSDMCSSFunction.Feedback, IlvSDMCSSFunction.NumericSymbolInteractor, IlvSDMCSSFunction.StateSymbolInteractor, IlvSDMCSSFunction.SymbolInteractor, IlvSDMCSSFunction.Test

Field Summary

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

ANY, ANY_PROPERTIES, ANY_PSEUDOCLASSES

Constructor Summary

Constructors

Constructor and Description
Test() Default constructor.

Method Summary

Modifier and Type	Method and Description
Object	call(Object[] args, Class<?> type, IlvSDMEngine engine, Object node, Object target) Calls the function.
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.
IlvSDMCSSFunction.Feedback[]	invert(Object[] args, Object value, IlvSDMEngine engine, Object node) This method is called from the style sheet renderer to update a model object property.

Methods inherited from class ilog.views.sdm.renderer.IlvSDMCSSFunction

call, getDelimiters, getDependencies, returnDelimitersAsToken

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

getImportance

Methods inherited from class java.lang.Object

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

Constructor Detail

Test

public Test()

Default constructor.

Method Detail

getName

public String getName()

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

Specified by:

getName in class IlvSDMCSSFunction

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

Overrides:

getShortDescription in class IlvCSSFunction

call

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

Calls the function.

Specified by:

call in class IlvSDMCSSFunction

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.

invert

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

Description copied from class: IlvSDMCSSFunction

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.

Overrides:

invert in class IlvSDMCSSFunction

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.

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