ilog.cpl.style
Class IlpAbstractStyleValueProvider

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

All Implemented Interfaces:

IlpStyleValueProvider, StyleChangeListener, Serializable, Cloneable, EventListener

Direct Known Subclasses:

IlpAttributeStyleValueProvider, IlpRemoteStyleValueProvider, IlpStyleValueModifier, 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 abstract class IlpAbstractStyleValueProvider
extends Object
implements IlpStyleValueProvider, StyleChangeListener, Cloneable

Models an abstract style value provider that can provide notification support.

Since:

JTGO 3.0

See Also:

Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

protected Map	dependentStyles Deprecated. All the styles that dependent on this value provider
protected Map	styleListeners Deprecated. Style change listeners
protected boolean	supportNotification Deprecated. Indicates if this instance will support style notification or not

Constructor Summary

protected

IlpAbstractStyleValueProvider(boolean supportNotification) Deprecated. Creates a value provider indicating whether it is going to provide notification support to its dependent styles.

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.
protected void	fireStyleChangeEvent() Deprecated. Fires a style change event to all interested listeners.
protected void	fireStyleChangeEvent(StyleChangeEvent ev) Deprecated. Fires the given event to all listeners.
boolean	hasDependentStyles() Deprecated. Returns whether there are styles dependent on this style value provider.
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.
protected void	setSupportNotification(boolean support) Deprecated. Indicates whether this instance will provide notifications to all dependent styles or not.
protected void	specificAddDependentStyle(IlpKey key, IlpStyle style) Deprecated. Executes a specific operation when this value provider is registered for the given key in the given style.
protected void	specificRemoveDependentStyle(IlpKey key, IlpStyle style) Deprecated. Executes a specific operation when this value provider is no longer being used by the given key in the style.
void	styleChanged(StyleChangeEvent e) Deprecated. Called when the inner style value provider has its value changed somehow.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ilog.cpl.style.IlpStyleValueProvider

getStringValue, getValue, getValueType

Field Detail

supportNotification

protected boolean supportNotification

Deprecated.

Indicates if this instance will support style notification or not

Internal method or field: do not use!

dependentStyles

protected Map dependentStyles

Deprecated.

All the styles that dependent on this value provider

Internal method or field: do not use!

styleListeners

protected Map styleListeners

Deprecated.

Style change listeners

Internal method or field: do not use!

Constructor Detail

IlpAbstractStyleValueProvider

protected IlpAbstractStyleValueProvider(boolean supportNotification)

Deprecated.

Creates a value provider indicating whether it is going to provide notification support to its dependent styles.

Parameters:

supportNotification - Indicates whether this value provider is going to support notifications to the dependent styles.

Method Detail

setSupportNotification

protected void setSupportNotification(boolean support)

Deprecated.

Indicates whether this instance will provide notifications to all dependent styles or not.

This method should be called at construction time.

Parameters:

support - Indicates whether this style value provider will provide notifications in case of changes in its value.

hasDependentStyles

public boolean hasDependentStyles()

Deprecated.

Returns whether there are styles dependent on this style value provider.

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

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, calling either IlpStyle.resetToDefaultValue or IlpStyle.setValueProvider.

Specified by:

removeDependentStyle in interface IlpStyleValueProvider

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

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

Parameters:

l - Listener to style changes

Internal method or field: do not use!

fireStyleChangeEvent

protected void fireStyleChangeEvent(StyleChangeEvent ev)

Deprecated.

Fires the given event to all listeners.

Parameters:

ev - The style change event indicating the key which value was changed.

fireStyleChangeEvent

protected void fireStyleChangeEvent()

Deprecated.

Fires a style change event to all interested listeners.

specificAddDependentStyle

protected void specificAddDependentStyle(IlpKey key,
                                         IlpStyle style)

Deprecated.

Executes a specific operation when this value provider is registered for the given key in the given style.

This method is called just after registering the style and key in the dependent list.

Parameters:

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

style - The style with the dependent key.

specificRemoveDependentStyle

protected void specificRemoveDependentStyle(IlpKey key,
                                            IlpStyle style)

Deprecated.

Executes a specific operation when this value provider is no longer being used by the given key in the style.

This method is called just before removing the style and key from the dependent list.

Parameters:

key - Key that is dependent on this style value provider

style - Style where the key is dependent

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

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 Object

Throws:

CloneNotSupportedException

Internal method or field: do not use!