ilog.cpl.style
Class IlpStyleValueDefaultProvider

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

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

Models an object that is responsible for returning a default value. This default value is returned when the original style value provider is not able to retrieve an appropriate value.

Since:

JTGO 3.0

See Also:

IlpStyleValueProvider, Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

protected Object

defaultValue Deprecated. Default value defined.

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

IlpStyleValueDefaultProvider(IlpStyleValueProvider provider, IlpKey key, IlpStyle style)
Deprecated. IlpStyleValueDefaultProvider constructor.

IlpStyleValueDefaultProvider(IlpStyleValueProvider provider, Object defValue)
Deprecated. IlpStyleValueDefaultProvider 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 of the given style as a string.
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. Returns the default value defined in this instance, if the value parameter is not defined.

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

defaultValue

protected Object defaultValue

Deprecated.

Default value defined. If the value returned by the original Style value provider is IlpStyle.NotFound, then the default value is returned.

Internal method or field: do not use!

Constructor Detail

IlpStyleValueDefaultProvider

public IlpStyleValueDefaultProvider(IlpStyleValueProvider provider,
                                    Object defValue)

Deprecated.

IlpStyleValueDefaultProvider constructor.

This instance returns the given default value, if the original style value provider is not able to return an appropriate value.

Parameters:

provider - The original style value provider.

defValue - Default value of the provider

IlpStyleValueDefaultProvider

public IlpStyleValueDefaultProvider(IlpStyleValueProvider provider,
                                    IlpKey key,
                                    IlpStyle style)

Deprecated.

IlpStyleValueDefaultProvider constructor.

This instance returns the given default value, if the original style value provider is not able to return an appropriate value.

Parameters:

provider - The original style value provider.

key - The key where the default value is stored. The key type must correspond to the style value provider type.

style - Style where the default value is stored.

Method Detail

modifyValue

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

Deprecated.

Returns the default value defined in this instance, if the value parameter is not defined.

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 of 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!