ilog.cpl.style
Class IlpStyleValueModifier

java.lang.Object
  ilog.cpl.style.IlpAbstractStyleValueProvider
      ilog.cpl.style.IlpStyleValueModifier

All Implemented Interfaces:

IlpStyleValueProvider, StyleChangeListener, Serializable, Cloneable, EventListener

Direct Known Subclasses:

IlpKeyStyleValueModifier, IlpStyleValueTypeConverter

Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Refer to the User's Manual for further information.

public abstract class IlpStyleValueModifier
extends IlpAbstractStyleValueProvider
implements StyleChangeListener

Models an object that is responsible for modifying the value retrieved from a style value provider. This value may be modified in many ways, such as by converting it to another type, formatting it to text, or mapping the given value to another.

Since:

JTGO 3.0

See Also:

IlpStyleValueProvider, Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

protected IlpStyleValueProvider

provider Deprecated. This is the original style value provider.

Fields inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

dependentStyles, styleListeners, supportNotification

Constructor Summary

IlpStyleValueModifier(IlpStyleValueProvider provider)
Deprecated. IlpStyleValueModifier constructor.

Method Summary

void	addStyleChangeListener(StyleChangeListener l) Deprecated. Registers a listener to style value provider change notifications.
Object	clone() Deprecated.
boolean	equals(Object other) Deprecated. This method is needed to search instances in collections.
Object	getValue(IlpKey key, IlpStyle style) Deprecated. Returns the value of the remote key on the remote style.
IlpStyleValueProvider	getValueProvider() Deprecated. Returns the Style value provider encapsulated by this instance.
abstract Object	modifyValue(IlpKey key, IlpStyle style, Object value) Deprecated. Modifies the given value; for example, converts it to another type, formats it, or maps it to another value.
void	removeStyleChangeListener(StyleChangeListener l) Deprecated. Removes a listener of style value provider changes.
protected void	specificAddDependentStyle(IlpKey key, IlpStyle style) Deprecated. This method can be overwritten in the subclasses to execute an specific behavior when a dependent style and key is set to this provider.
protected void	specificRemoveDependentStyle(IlpKey key, IlpStyle style) Deprecated. This method can be overwritten in the subclasses to execute an specific behavior when a dependent style and key is removed.
void	styleChanged(StyleChangeEvent e) Deprecated. Called when the inner style value provider has its value changed somehow.
String	toString() Deprecated.

Methods inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

addDependentStyle, fireStyleChangeEvent, fireStyleChangeEvent, hasDependentStyles, removeDependentStyle, setSupportNotification

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.cpl.style.IlpStyleValueProvider

getStringValue, getValueType

Field Detail

provider

protected IlpStyleValueProvider provider

Deprecated.

This is the original style value provider. The value retrieved from this instance will be modified according to the method modifyValue

Internal method or field: do not use!

Constructor Detail

IlpStyleValueModifier

public IlpStyleValueModifier(IlpStyleValueProvider provider)

Deprecated.

IlpStyleValueModifier constructor. Creates a new instance that will modify the value retrieved from the given style value provider in one way or another.

Parameters:

provider - The original style value provider.

Method Detail

modifyValue

public abstract Object modifyValue(IlpKey key,
                                   IlpStyle style,
                                   Object value)

Deprecated.

Modifies the given value; for example, converts it to another type, formats it, or maps it to another value.

getValue

public Object getValue(IlpKey key,
                       IlpStyle style)

Deprecated.

Returns the value of the remote key on the remote style.

Specified by:

getValue in interface IlpStyleValueProvider

Parameters:

key - The remote style key.

style - The style context used to resolve the value.

Returns:

The value of the remote key.

getValueProvider

public IlpStyleValueProvider getValueProvider()

Deprecated.

Returns the Style value provider encapsulated by this instance.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

Internal method or field: do not use!

equals

public boolean equals(Object other)

Deprecated.

This method is needed to search instances in collections. Don't remove.

Overrides:

equals in class Object

Internal method or field: do not use!

specificAddDependentStyle

protected void specificAddDependentStyle(IlpKey key,
                                         IlpStyle style)

Deprecated.

This method can be overwritten in the subclasses to execute an specific behavior when a dependent style and key is set to this provider.

Overrides:

specificAddDependentStyle in class IlpAbstractStyleValueProvider

Parameters:

key - The key that is dependent on this style value provider.

style - The style with the dependent key.

Internal method or field: do not use!

specificRemoveDependentStyle

protected void specificRemoveDependentStyle(IlpKey key,
                                            IlpStyle style)

Deprecated.

This method can be overwritten in the subclasses to execute an specific behavior when a dependent style and key is removed.

Overrides:

specificRemoveDependentStyle in class IlpAbstractStyleValueProvider

Parameters:

key - Key that is dependent on this style value provider

style - Style where the key is dependent

Internal method or field: do not use!

addStyleChangeListener

public void addStyleChangeListener(StyleChangeListener l)

Deprecated.

Registers a listener to style value provider change notifications.

Specified by:

addStyleChangeListener in interface IlpStyleValueProvider

Overrides:

addStyleChangeListener in class IlpAbstractStyleValueProvider

Parameters:

l - Listener to style changes

Internal method or field: do not use!

removeStyleChangeListener

public void removeStyleChangeListener(StyleChangeListener l)

Deprecated.

Removes a listener of style value provider changes.

Specified by:

removeStyleChangeListener in interface IlpStyleValueProvider

Overrides:

removeStyleChangeListener in class IlpAbstractStyleValueProvider

Parameters:

l - Listener to style changes

Internal method or field: do not use!

styleChanged

public void styleChanged(StyleChangeEvent e)

Deprecated.

Called when the inner style value provider has its value changed somehow.

Specified by:

styleChanged in interface StyleChangeListener

Overrides:

styleChanged in class IlpAbstractStyleValueProvider

Parameters:

e - Style change event indicating which key has changed.

Internal method or field: do not use!

clone

public Object clone()
             throws CloneNotSupportedException

Deprecated.

Overrides:

clone in class IlpAbstractStyleValueProvider

Throws:

CloneNotSupportedException

Internal method or field: do not use!