ilog.views.symbology.interactor

Class IlvSymbolInteractor

java.lang.Object

javax.swing.AbstractAction

ilog.views.symbology.interactor.IlvSymbolInteractor

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

IlvDiscreteSymbolInteractor, IlvPushSymbolInteractor, IlvRangeSymbolInteractor

public abstract class IlvSymbolInteractor
extends AbstractAction

A symbol interactor is an action responding to predefined mouse events that could happen on a symbol. The main purpose of the process is to compute a value according to the event and to update a SDM model with this value. The CSS rules defined in the model could be in charge to change the graphical representation of the underlying symbol. The interactor needs to know the name of the parameter to be modified in the model; by default it will modify the "value" parameter.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
IlvSymbolInteractor() Default empty constructor that creates the instance.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e) Perform the specific interactor task
Object	getCSSValue(IlvCompositeContext compositeContext, IlvComposite source) Gets the value of the parameter in the model.
protected Logger	getLogger() Returns a logger for messages
String	getParameterToModify() Returns the name of the parameters that should be modified in the model.
String	getParameterType(IlvComposite composite) Returns the parameter type of the parameter to modify
abstract IlvMouseGesture[]	getSupportedMouseGestures() Returns a list of mouse gestures supported by this interactor.
void	setParameterToModify(String parameterToModify) Sets the name of the parameter that will be changed in the model

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvSymbolInteractor

public IlvSymbolInteractor()

Default empty constructor that creates the instance. It sets the default value of the parameter name to "value"

Method Detail

actionPerformed

public void actionPerformed(ActionEvent e)

Perform the specific interactor task

getCSSValue

public Object getCSSValue(IlvCompositeContext compositeContext,
                          IlvComposite source)

Gets the value of the parameter in the model.

Parameters:

compositeContext - context of the composite

source - composite component source

Returns:

the value of the parameter.

getParameterType

public String getParameterType(IlvComposite composite)

Returns the parameter type of the parameter to modify

Since:

JViews 8.1

getSupportedMouseGestures

public abstract IlvMouseGesture[] getSupportedMouseGestures()

Returns a list of mouse gestures supported by this interactor. Those gestures can be used in a event map that associates each of them with this action.

setParameterToModify

public void setParameterToModify(String parameterToModify)

Sets the name of the parameter that will be changed in the model

Parameters:

parameterToModify - The name of parameter

getParameterToModify

public String getParameterToModify()

Returns the name of the parameters that should be modified in the model.

getLogger

protected Logger getLogger()

Returns a logger for messages