ilog.cpl.style
Class IlpKeyStyleValueModifier

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

All Implemented Interfaces:

IlpStyleValueProvider, StyleChangeListener, Serializable, Cloneable, EventListener

Direct Known Subclasses:

IlpStyleValueDefaultProvider, IlpStyleValueFormatter, IlpStyleValueMapper

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

public abstract class IlpKeyStyleValueModifier
extends IlpStyleValueModifier

Models a basic style value modifier, which is dependent on a style and a key. This is the class that should be subclassed if you are interested in creating a new style value modifier that depends on remote 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.IlpStyleValueModifier

provider

Fields inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

dependentStyles, styleListeners, supportNotification

Constructor Summary

IlpKeyStyleValueModifier(IlpStyleValueProvider provider, IlpKey key, IlpStyle style)
Deprecated. IlpKeyStyleValueModifier 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	getRemoteKey() Deprecated. Get remote key.
IlpStyle	getRemoteStyle() Deprecated. Get remote style.
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 the inner style value provider has its value changed somehow.
String	toString() Deprecated.

Methods inherited from class ilog.cpl.style.IlpStyleValueModifier

getValue, getValueProvider, modifyValue, 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

Methods inherited from interface ilog.cpl.style.IlpStyleValueProvider

getStringValue, getValueType

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

IlpKeyStyleValueModifier

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

Deprecated.

IlpKeyStyleValueModifier constructor.

Parameters:

provider - The original style value provider.

key - The key to retrieve the value

style - Style to retrieve the value or null if the current style should be used.

Method Detail

getRemoteKey

public IlpKey getRemoteKey()

Deprecated.

Get remote key.

Internal method or field: do not use!

getRemoteStyle

public IlpStyle getRemoteStyle()

Deprecated.

Get remote style.

Internal method or field: do not use!

toString

public String toString()

Deprecated.

Overrides:

toString in class IlpStyleValueModifier

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!

addDependentStyle

public void addDependentStyle(IlpKey key,
                              IlpStyle style)

Deprecated.

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

This method is called whenever this instance is set in a style, using IlpStyle.setValueProvider.

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)

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.

This method is called whenever this instance is removed from a style, either calling IlpStyle.resetToDefaultValue or IlpStyle.setValueProvider.

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)

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 IlpStyleValueModifier

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 IlpStyleValueModifier

Parameters:

l - Listener to style changes

Internal method or field: do not use!

styleChanged

public void styleChanged(StyleChangeEvent e)

Deprecated.

Called when the inner style value provider has its value changed somehow.

Specified by:

styleChanged in interface StyleChangeListener

Overrides:

styleChanged in class IlpStyleValueModifier

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 IlpStyleValueModifier

Throws:

CloneNotSupportedException

Internal method or field: do not use!