ilog.cpl.style
Class IlpStyleValueFormatter

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

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 IlpStyleValueFormatter
extends IlpKeyStyleValueModifier

Models an object that is responsible for formatting the value retrieved from a style value provider. Formatting a value always converts the value to a String.

Since:

JTGO 3.0

See Also:

Format, IlpStyleValueProvider, Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

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

IlpStyleValueFormatter(IlpStyleValueProvider provider, IlpFormatKey key)
Deprecated. IlpStyleValueFormatter constructor.

IlpStyleValueFormatter(IlpStyleValueProvider provider, IlpFormatKey key, IlpStyle style)
Deprecated. IlpStyleValueFormatter 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 String class.
Object	modifyValue(IlpKey key, IlpStyle style, Object value) Deprecated. Formats the given value.

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

Constructor Detail

IlpStyleValueFormatter

public IlpStyleValueFormatter(IlpStyleValueProvider provider,
                              IlpFormatKey key)

Deprecated.

IlpStyleValueFormatter constructor.

This instance formats the value retrieved from the original style value provider using the format given by key and style.

Parameters:

provider - The original style value provider.

key - The key to retrieve the format

See Also:

Format, IlpFormatKey

IlpStyleValueFormatter

public IlpStyleValueFormatter(IlpStyleValueProvider provider,
                              IlpFormatKey key,
                              IlpStyle style)

Deprecated.

IlpStyleValueFormatter constructor.

This instance formats the value retrieved from the original style value provider using the format given by key and style.

Parameters:

provider - The original style value provider.

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

style - Style where the format will be retrieved.

Method Detail

modifyValue

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

Deprecated.

Formats the given value.

Specified by:

modifyValue in class IlpStyleValueModifier

getValueType

public Class getValueType()

Deprecated.

Returns the String class. Formatted values are also converted to String.

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!