ilog.cpl.style
Interface IlpStyleValueProvider

All Superinterfaces:

Serializable

All Known Implementing Classes:

IlpAbstractStyleValueProvider, IlpAttributeStyleValueProvider, IlpBoundAttributeStyleValueProvider, IlpKeyStyleValueModifier, IlpRemoteStyleValueProvider, IlpStyleValueDefaultProvider, IlpStyleValueFormatter, IlpStyleValueMapper, IlpStyleValueModifier, IlpStyleValueTypeConverter, IltCollapseStyleValueProvider, IltObject.ListPrimaryStateStyleValueProvider

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

public interface IlpStyleValueProvider
extends Serializable

Interface implemented by classes that calculate style values. It will be invoked by the style.

Since:

JTGO 3.0

Deprecated Since:

JTGO 3.5

Method Summary

void	addDependentStyle(IlpKey key, IlpStyle style) Deprecated. Indicates that the given style is using this style value provider for the given key.
void	addStyleChangeListener(StyleChangeListener l) Deprecated. Registers a listener to style value provider change notifications.
String	getStringValue() Deprecated. Returns the value for the given style as a string.
Object	getValue(IlpKey key, IlpStyle style) Deprecated. Returns the value for the given style.
Class	getValueType() Deprecated. Returns the Java class of the value the style value provider is expected to return.
void	removeDependentStyle(IlpKey key, IlpStyle style) Deprecated. Indicates that the given style is no longer using this style value provider for the given key.
void	removeStyleChangeListener(StyleChangeListener l) Deprecated. Removes a listener of style value provider changes.

Method Detail

getValue

Object getValue(IlpKey key,
                IlpStyle style)

Deprecated.

Returns the value for the given style. Uses the context to obtain any information needed to calculate the value, such as the current value of an attribute for attribute styles.

Parameters:

key - Style key whose value is being requested.

style - Style whose value is requested.

Returns:

Value or IlpStyle.NotFound if the value could not be calculated by this provider.

getValueType

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

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.

addDependentStyle

void addDependentStyle(IlpKey key,
                       IlpStyle style)

Deprecated.

Indicates that the given style is using this style value provider for the given key.

See Also:

IlpStyle.setValueProvider(ilog.cpl.style.key.IlpKey, ilog.cpl.style.IlpStyleValueProvider, boolean)

removeDependentStyle

void removeDependentStyle(IlpKey key,
                          IlpStyle style)

Deprecated.

Indicates that the given style is no longer using this style value provider for the given key.

See Also:

IlpStyle.setValueProvider(ilog.cpl.style.key.IlpKey, ilog.cpl.style.IlpStyleValueProvider, boolean)

addStyleChangeListener

void addStyleChangeListener(StyleChangeListener l)

Deprecated.

Registers a listener to style value provider change notifications.

removeStyleChangeListener

void removeStyleChangeListener(StyleChangeListener l)

Deprecated.

Removes a listener of style value provider changes.