ilog.cpl.style
Class IlpRemoteStyleValueProvider

java.lang.Object
  ilog.cpl.style.IlpAbstractStyleValueProvider
      ilog.cpl.style.IlpRemoteStyleValueProvider

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 IlpRemoteStyleValueProvider
extends IlpAbstractStyleValueProvider
implements StyleChangeListener

Style value provider for remote style values.

Since:

JTGO 3.0

See Also:

Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

protected IlpKey	remoteKey Deprecated. Remote key
protected IlpStyle	remoteStyle Deprecated. Remote style

Fields inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

dependentStyles, styleListeners, supportNotification

Constructor Summary

IlpRemoteStyleValueProvider(IlpKey remoteKey)
Deprecated. IlpRemoteStyleValueProvider constructor.

IlpRemoteStyleValueProvider(IlpKey remoteKey, IlpStyle remoteStyle)
Deprecated. IlpRemoteStyleValueProvider constructor.

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.
Object	clone() Deprecated.
boolean	equals(Object other) Deprecated. This method is needed to search instances in collections.
IlpKey	getKey() Deprecated. Returns the IlpKey pointed to by this IlpRemoteStyleValueProvider.
String	getStringValue() Deprecated. Returns the value for the given style as a string.
IlpStyle	getStyle() Deprecated. Returns the IlpStyle pointed to by this IlpRemoteStyleValueProvider.
IlpStyle	getStyle(IlpStyle style) Deprecated. Returns the IlpStyle pointed to by this IlpRemoteStyleValueProvider or the given default style.
Object	getValue(IlpKey key, IlpStyle style) Deprecated. Returns the value of the remote key on the remote 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.
void	styleChanged(StyleChangeEvent e) Deprecated. Called when style values have changed.
String	toString() Deprecated.

Methods inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

fireStyleChangeEvent, fireStyleChangeEvent, hasDependentStyles, setSupportNotification, specificAddDependentStyle, specificRemoveDependentStyle

Methods inherited from class java.lang.Object

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

Field Detail

remoteKey

protected IlpKey remoteKey

Deprecated.

Remote key

Internal method or field: do not use!

remoteStyle

protected IlpStyle remoteStyle

Deprecated.

Remote style

Internal method or field: do not use!

Constructor Detail

IlpRemoteStyleValueProvider

public IlpRemoteStyleValueProvider(IlpKey remoteKey)

Deprecated.

IlpRemoteStyleValueProvider constructor. Creates a remote style value provider linked to the given remote key in the same style.

Parameters:

remoteKey - Key in the remote style.

IlpRemoteStyleValueProvider

public IlpRemoteStyleValueProvider(IlpKey remoteKey,
                                   IlpStyle remoteStyle)

Deprecated.

IlpRemoteStyleValueProvider constructor. Creates a remote style value provider linked to the given remote key.

Parameters:

remoteKey - Key in the remote style.

remoteStyle - Remote style where the remote value is located.

Method Detail

getValueType

public Class getValueType()

Deprecated.

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

Specified by:

getValueType in interface IlpStyleValueProvider

Returns:

The expected type of the return value.

getValue

public Object getValue(IlpKey key,
                       IlpStyle style)

Deprecated.

Returns the value of the remote key on the remote style.

Specified by:

getValue in interface IlpStyleValueProvider

Parameters:

key - Remote style key

style - Style context used to resolve the value.

Returns:

Value of remote key.

getStyle

public IlpStyle getStyle(IlpStyle style)

Deprecated.

Returns the IlpStyle pointed to by this IlpRemoteStyleValueProvider or the given default style.

Returns:

The remote style.

Internal method or field: do not use!

getStyle

public IlpStyle getStyle()

Deprecated.

Returns the IlpStyle pointed to by this IlpRemoteStyleValueProvider.

Returns:

The remote style.

getKey

public IlpKey getKey()

Deprecated.

Returns the IlpKey pointed to by this IlpRemoteStyleValueProvider.

Returns:

The remote key.

getStringValue

public String getStringValue()

Deprecated.

Returns the value for the given style as a string. This method is not used by remote style value providers and simply returns null.

Specified by:

getStringValue in interface IlpStyleValueProvider

Returns:

Value correctly formatted as a string.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

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 Object

Internal method or field: do not use!

addDependentStyle

public void addDependentStyle(IlpKey key,
                              IlpStyle style)

Deprecated.

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

Specified by:

addDependentStyle in interface IlpStyleValueProvider

Overrides:

addDependentStyle in class IlpAbstractStyleValueProvider

Parameters:

key - The key which is dependent on this style value provider.

style - The style with the dependent key.

See Also:

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

Internal method or field: do not use!

removeDependentStyle

public void removeDependentStyle(IlpKey key,
                                 IlpStyle style)

Deprecated.

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

Specified by:

removeDependentStyle in interface IlpStyleValueProvider

Overrides:

removeDependentStyle in class IlpAbstractStyleValueProvider

Parameters:

key - The key that was dependent on this style value provider.

style - The style with the dependent key.

See Also:

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

Internal method or field: do not use!

addStyleChangeListener

public void addStyleChangeListener(StyleChangeListener l)

Deprecated.

Registers a listener to style value provider change notifications.

Specified by:

addStyleChangeListener in interface IlpStyleValueProvider

Overrides:

addStyleChangeListener in class IlpAbstractStyleValueProvider

Parameters:

l - Listener to style changes

Internal method or field: do not use!

removeStyleChangeListener

public void removeStyleChangeListener(StyleChangeListener l)

Deprecated.

Removes a listener of style value provider changes.

Specified by:

removeStyleChangeListener in interface IlpStyleValueProvider

Overrides:

removeStyleChangeListener in class IlpAbstractStyleValueProvider

Parameters:

l - Listener to style changes

Internal method or field: do not use!

styleChanged

public void styleChanged(StyleChangeEvent e)

Deprecated.

Called when style values have changed. This method does the following:

• If the remote style is not set: we verify which one of the dependent styles has generated this notification. And we send the notification of change with the associated key only to this style.
• If the remote style is set: we verify if the notification comes from this style, and then we notify all the dependent styles of this change.

Specified by:

styleChanged in interface StyleChangeListener

Overrides:

styleChanged in class IlpAbstractStyleValueProvider

Parameters:

e - Style change event indicating which key has changed.

Internal method or field: do not use!

clone

public Object clone()
             throws CloneNotSupportedException

Deprecated.

Overrides:

clone in class IlpAbstractStyleValueProvider

Throws:

CloneNotSupportedException

Internal method or field: do not use!