ilog.cpl.style
Class IlpStyleValueTypeConverter

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

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 IlpStyleValueTypeConverter
extends IlpStyleValueModifier

Models an object that is responsible for converting the value received from a style value provider to another type.

Since:

JTGO 3.0

See Also:

IlpStyleValueProvider, IlpTypeConverter, Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

protected IlpContext	context Deprecated. Context used to retrieve the type converter
protected IlpTypeConverter	converter Deprecated.
protected Class	valueType Deprecated. Target type used to convert the retrieved value

Fields inherited from class ilog.cpl.style.IlpStyleValueModifier

provider

Fields inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

dependentStyles, styleListeners, supportNotification

Constructor Summary

IlpStyleValueTypeConverter(IlpContext context, IlpStyleValueProvider provider, Class target)
Deprecated. IlpStyleValueTypeConverter constructor.

IlpStyleValueTypeConverter(IlpStyleValueProvider provider, Class target)
Deprecated. IlpStyleValueTypeConverter 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.
protected IlpTypeConverter	getTypeConverter(IlpStyle style) Deprecated. Returns the type converter that will be used by this instance.
Class	getValueType() Deprecated. Returns the Java class of the value the style value provider is expected to return.
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	setContext(IlpContext c) Deprecated. Sets the context used by this instance, should only be called after deserialization.
String	toString() Deprecated.

Methods inherited from class ilog.cpl.style.IlpStyleValueModifier

addStyleChangeListener, getValue, getValueProvider, removeStyleChangeListener, specificAddDependentStyle, specificRemoveDependentStyle, styleChanged

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

Field Detail

context

protected IlpContext context

Deprecated.

Context used to retrieve the type converter

Internal method or field: do not use!

converter

protected IlpTypeConverter converter

Deprecated.

Internal method or field: do not use!

valueType

protected Class valueType

Deprecated.

Target type used to convert the retrieved value

Internal method or field: do not use!

Constructor Detail

IlpStyleValueTypeConverter

public IlpStyleValueTypeConverter(IlpContext context,
                                  IlpStyleValueProvider provider,
                                  Class target)

Deprecated.

IlpStyleValueTypeConverter constructor.

This instance will convert the value retrieved from the original style value provider to the target type. The conversion will be achieved using the default type converter implementation.

Parameters:

context - Application context that contains the IlpTypeConverter used by this instance.

provider - The original style value provider.

target - The target type.

IlpStyleValueTypeConverter

public IlpStyleValueTypeConverter(IlpStyleValueProvider provider,
                                  Class target)

Deprecated.

IlpStyleValueTypeConverter constructor.

This instance will convert the value retrieved from the original style value provider to the target type.

Parameters:

provider - The original style value provider.

target - The target type.

Method Detail

getTypeConverter

protected IlpTypeConverter getTypeConverter(IlpStyle style)

Deprecated.

Returns the type converter that will be used by this instance.

Internal method or field: do not use!

modifyValue

public 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.

Specified by:

modifyValue in class IlpStyleValueModifier

getValueType

public Class getValueType()

Deprecated.

Returns the Java class of the value the style value provider is expected to return.

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.

toString

public String toString()

Deprecated.

Overrides:

toString in class IlpStyleValueModifier

Internal method or field: do not use!

setContext

public void setContext(IlpContext c)

Deprecated.

Sets the context used by this instance, should only be called after deserialization.

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 IlpStyleValueModifier

Internal method or field: do not use!

clone

public Object clone()
             throws CloneNotSupportedException

Deprecated.

Overrides:

clone in class IlpStyleValueModifier

Throws:

CloneNotSupportedException

Internal method or field: do not use!