ilog.cpl.style
Class IlpStyleValueMapper

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

All Implemented Interfaces:

IlpStyleValueProvider, StyleChangeListener, Serializable, Cloneable, EventListener

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

public class IlpStyleValueMapper
extends IlpKeyStyleValueModifier

Models an object that is responsible for mapping the value retrieved from a style value provider to another value.

Since:

JTGO 3.0

See Also:

IlpValueMap, IlpStyleValueProvider, Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

protected Class

valueMapType Deprecated. Type of the result value in the map

Fields inherited from class ilog.cpl.style.IlpKeyStyleValueModifier

remoteKey, remoteStyle

Fields inherited from class ilog.cpl.style.IlpStyleValueModifier

provider

Fields inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

dependentStyles, styleListeners, supportNotification

Constructor Summary

IlpStyleValueMapper(IlpStyleValueProvider provider, IlpValueMapKey key, Class mapValueType)
Deprecated. IlpStyleValueMapper constructor.

IlpStyleValueMapper(IlpStyleValueProvider provider, IlpValueMapKey key, IlpStyle style)
Deprecated. IlpStyleValueMapper constructor.

Method Summary

Object	clone() Deprecated.
boolean	equals(Object other) Deprecated. This method is needed to search instances in collections.
String	getStringValue() Deprecated. Returns the value for the given style as a string.
Class	getValueType() Deprecated. Returns the mapped value class or Object class if the class could not be retrieved.
Object	modifyValue(IlpKey key, IlpStyle style, Object value) Deprecated. Returns the mapped value, if it is defined in the source value map, or IlpStyle.NotFound.

Methods inherited from class ilog.cpl.style.IlpKeyStyleValueModifier

addDependentStyle, addStyleChangeListener, getRemoteKey, getRemoteStyle, removeDependentStyle, removeStyleChangeListener, styleChanged, toString

Methods inherited from class ilog.cpl.style.IlpStyleValueModifier

getValue, getValueProvider, specificAddDependentStyle, specificRemoveDependentStyle

Methods inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

fireStyleChangeEvent, fireStyleChangeEvent, hasDependentStyles, setSupportNotification

Methods inherited from class java.lang.Object

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

Field Detail

valueMapType

protected Class valueMapType

Deprecated.

Type of the result value in the map

Internal method or field: do not use!

Constructor Detail

IlpStyleValueMapper

public IlpStyleValueMapper(IlpStyleValueProvider provider,
                           IlpValueMapKey key,
                           Class mapValueType)

Deprecated.

IlpStyleValueMapper constructor.

This instance will map the value retrieved from the given style value provider to another value, which is retrieved from an IlpValueMap.

Parameters:

provider - The original style value provider.

key - The key to retrieve the IlpValueMap that will be applied.

mapValueType - The value map type

See Also:

IlpValueMap, IlpValueMapKey

IlpStyleValueMapper

public IlpStyleValueMapper(IlpStyleValueProvider provider,
                           IlpValueMapKey key,
                           IlpStyle style)

Deprecated.

IlpStyleValueMapper constructor.

This instance will map the value retrieved from the given style value provider to another value, which is retrieved from an IlpValueMap.

Parameters:

provider - The original style value provider.

key - The key to retrieve the IlpValueMap that will be applied.

style - Style where the IlpValueMap will be retrieved.

See Also:

IlpValueMap, IlpValueMapKey

Method Detail

modifyValue

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

Deprecated.

Returns the mapped value, if it is defined in the source value map, or IlpStyle.NotFound.

Specified by:

modifyValue in class IlpStyleValueModifier

getValueType

public Class getValueType()

Deprecated.

Returns the mapped value class or Object class if the class could not be retrieved.

Returns:

The expected type of the return value.

getStringValue

public String getStringValue()

Deprecated.

Returns the value for the given style as a string. This method is used by custom implementations of the IlpStyleValueProvider interface to provide the data that should be stored when the style value provider is saved to the persistent storage. Correspondingly, a string-based constructor for the style value provider is needed to restore the value when reading it from the stored styles.

Returns:

Value correctly formatted as a string.

equals

public boolean equals(Object other)

Deprecated.

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

Overrides:

equals in class IlpKeyStyleValueModifier

Internal method or field: do not use!

clone

public Object clone()
             throws CloneNotSupportedException

Deprecated.

Overrides:

clone in class IlpKeyStyleValueModifier

Throws:

CloneNotSupportedException

Internal method or field: do not use!