ilog.views.sdm.renderer

Class IlvSDMCSSFunction.SymbolInteractor

java.lang.Object

ilog.views.util.styling.IlvCSSFunction

ilog.views.sdm.renderer.IlvSDMCSSFunction

ilog.views.sdm.renderer.IlvSDMCSSFunction.SymbolInteractor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvSDMCSSFunction.NumericSymbolInteractor, IlvSDMCSSFunction.StateSymbolInteractor

Enclosing class:

IlvSDMCSSFunction

public static class IlvSDMCSSFunction.SymbolInteractor
extends IlvSDMCSSFunction

CSS function to handle symbol interactions in a cleaner way. This is the base class. see subclasses for interactor that deal with numerical and String types.

The handler is able to call an ActionListener when interaction is performed.

The function has 2 optional parameters. The first one is the name of a model attribute which will hold the interaction values, read and write. The second parameter is the initial value, in case the model attribute doesn't yet exist.

If the first parameter is not specified, then an internal variable is used (actually: a property on the graphic object). Then the model is left unaffected by interactions.

Since:

JViews 8.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

Modifier and Type	Field and Description
protected Object	_initialValue Initial default value, type String.

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

ANY, ANY_PROPERTIES, ANY_PSEUDOCLASSES

Constructor Summary

Constructors

Constructor and Description
SymbolInteractor() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addActionListener(ActionListener l) Registers a listener.
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.
void	removeActionListener(ActionListener l) Removes a listener.

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

Field Detail

_initialValue

protected Object _initialValue

Initial default value, type String.

Constructor Detail

SymbolInteractor

public SymbolInteractor()

Default constructor

Method Detail

addActionListener

public void addActionListener(ActionListener l)

Registers a listener.

Parameters:

l - the new listener

removeActionListener

public void removeActionListener(ActionListener l)

Removes a listener.

Parameters:

l - the listener to remove

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)

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.