ilog.cpl.style

Class IlpAttributeStyleValueProvider

java.lang.Object

ilog.cpl.style.IlpAbstractStyleValueProvider

ilog.cpl.style.IlpAttributeStyleValueProvider

All Implemented Interfaces:

IlpStyleValueProvider, StyleChangeListener, Serializable, Cloneable, EventListener

Direct Known Subclasses:

IlpBoundAttributeStyleValueProvider

Deprecated.

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

@Deprecated
public class IlpAttributeStyleValueProvider
extends IlpAbstractStyleValueProvider

Returns the value of an attribute in a specific instance of IlpAttributeValueHolder. By default, the attribute used is obtained from the style identifier, but a custom attribute may also be specifically provided. If no attribute is provided and the style identifier does not contain one, null will be returned.

Attribute value changes are not automatically notified to the style where this instance is registered.

Since:

JTGO 3.0

See Also:

Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected IlpAttribute	valueAttribute Deprecated. Value attribute
protected Class	valueType Deprecated. Value type

Fields inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

dependentStyles, styleListeners, supportNotification

Constructor Summary

Constructors

Constructor and Description
IlpAttributeStyleValueProvider(Class valueType) Deprecated. IlpAttributeStyleValueProvider constructor.
IlpAttributeStyleValueProvider(IlpAttribute valueAttribute) Deprecated. IlpAttributeStyleValueProvider constructor.
IlpAttributeStyleValueProvider(IlpAttribute valueAttribute, Class valueType) Deprecated. IlpAttributeStyleValueProvider constructor.

Method Summary

Modifier and Type	Method and Description
Object	clone() Deprecated.
Object	getAttributeValue(IlpStyleContext styleContext) Deprecated. Returns the current value of the attribute.
String	getStringValue() Deprecated. Returns the value of the given style as a string.
Object	getValue(IlpKey key, IlpStyle style) Deprecated. Returns the current value of the attribute (as returned by getAttributeValue()), after converting it to a string.
IlpAttribute	getValueAttribute() Deprecated. Returns the currently specified attribute, if one has been specified for the value provider.
Class	getValueType() Deprecated. Returns the Java class of the value which the attribute style value provider is expected to return.
String	toString() Deprecated.

Methods inherited from class ilog.cpl.style.IlpAbstractStyleValueProvider

addDependentStyle, addStyleChangeListener, fireStyleChangeEvent, fireStyleChangeEvent, hasDependentStyles, removeDependentStyle, removeStyleChangeListener, setSupportNotification, specificAddDependentStyle, specificRemoveDependentStyle, styleChanged

Methods inherited from class java.lang.Object

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

Field Detail

valueAttribute

protected IlpAttribute valueAttribute

Deprecated.

Value attribute

Internal: do not use!

valueType

protected Class valueType

Deprecated.

Value type

Internal: do not use!

Constructor Detail

IlpAttributeStyleValueProvider

public IlpAttributeStyleValueProvider(Class valueType)

Deprecated.

IlpAttributeStyleValueProvider constructor. No specific attribute is given, so the attribute is taken from the context instead.

Parameters:

valueType - Class of the value handled by the value provider.

IlpAttributeStyleValueProvider

public IlpAttributeStyleValueProvider(IlpAttribute valueAttribute)

Deprecated.

IlpAttributeStyleValueProvider constructor. The given attribute is used instead of the one from the style context.

Parameters:

valueAttribute - Specific attribute to use.

IlpAttributeStyleValueProvider

public IlpAttributeStyleValueProvider(IlpAttribute valueAttribute,
                                      Class valueType)

Deprecated.

IlpAttributeStyleValueProvider constructor. The given attribute is used instead of the one from the style context.

Parameters:

valueAttribute - Specific attribute to use.

valueType - Class of the value handled by the value provider.

Method Detail

getValue

public Object getValue(IlpKey key,
                       IlpStyle style)

Deprecated.

Returns the current value of the attribute (as returned by getAttributeValue()), after converting it to a string.

Parameters:

key - Style key whose value is being queried

style - Style where the value has been initialize requested

Returns:

Current value of the attribute.

getAttributeValue

public Object getAttributeValue(IlpStyleContext styleContext)

Deprecated.

Returns the current value of the attribute. The attribute value holder is obtained from the style context. If there is no holder, null is returned. If a specific attribute was provided, it is used to obtain the value. Otherwise, the attribute stored in the style identifier is used, if there is one. If not, null is returned

Parameters:

styleContext - Style context.

Returns:

Current value of the attribute.

getValueAttribute

public IlpAttribute getValueAttribute()

Deprecated.

Returns the currently specified attribute, if one has been specified for the value provider. Returns null if none has been specified.

Returns:

The locally defined attribute.

getValueType

public Class getValueType()

Deprecated.

Returns the Java class of the value which the attribute 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 not used by attribute style value providers and simply returns null.

Returns:

Value correctly formatted as a string.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

Internal: do not use!

clone

public Object clone()
             throws CloneNotSupportedException

Deprecated.

Overrides:

clone in class IlpAbstractStyleValueProvider

Throws:

CloneNotSupportedException

Internal: do not use!