ilog.cpl.style

Class IlpStyle

java.lang.Object

ilog.cpl.style.IlpAbstractStyle

ilog.cpl.style.IlpStyle

All Implemented Interfaces:

StyleChangeListener, StyleListener, Serializable, Cloneable, EventListener

Direct Known Subclasses:

IltAbstractLegend

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 IlpStyle
extends IlpAbstractStyle
implements StyleChangeListener, Cloneable

Contains a set of graphic properties of composite graphic objects. Every composite graphic object contains an instance of this class. These properties override the default behavior.

Since:

JTGO 3.0

See Also:

Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected IlpStyle[]	computedDefaultStyles Deprecated. Default (parent) styles automatically inherited.
protected List<IlpStyle>	computedDefaultStylesUnmodifiable Deprecated.
protected List<IlpStyle>	defaultStylesCache Deprecated. Cache to all default styles list.
protected IlpStyle[]	definedDefaultStyles Deprecated. Default (parent) styles specified by the user.
protected List<IlpStyle>	definedDefaultStylesUnmodifiable Deprecated.
static int	IN_COMPUTE_GRAPHIC Deprecated.
protected StyleListener	owner Deprecated. The owner of the style, it is always a StyleListener with some privileges, like being the first one to be notified when it starts to be changed and the last one when it finishes.
protected IlpStyleContext	styleContext Deprecated. Style context for this style
protected ilog.util.internal.IlFastMap<IlpKey,Map<StyleChangeListener,Integer>>	styleKeyListeners Deprecated. A table List of >.
protected WeakHashMap<StyleListener,Object>	styleListeners Deprecated. A table IlpStyle -> null This map contains listeners for this style.
protected IlpStyle[]	styleSearchOrderCache Deprecated. Unmodifiable list which contains the search order
protected ilog.util.internal.IlFastMap<IlpKey,IlpStyleValueProvider>	valueProviders Deprecated. A table IlpKey -> IlpStyleValueProvider containing the value providers.

Fields inherited from class ilog.cpl.style.IlpAbstractStyle

_StyleLock, appContext, literals, NotFound, searchStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
	IlpStyle() Deprecated. Style object constructor.
	IlpStyle(IlpStyleContext styleContext) Deprecated. Style object constructor.
protected	IlpStyle(IlpStyle defaultStyle, IlpStyleContext styleContext) Deprecated. Style object constructor, adding one default style to the list of default styles.
	IlpStyle(List<IlpStyle> defaultStyles, IlpStyleContext styleContext) Deprecated. Style object constructor, setting the default style.

Method Summary

Modifier and Type	Method and Description
void	addStyleChangeListener(IlpKey key, StyleChangeListener listener) Deprecated. Adds a listener interested in modifications in the given key.
void	addStyleListener(StyleListener listener) Deprecated. Adds a style listener.
void	addStyleListener(StyleListener listener, Object value) Deprecated. Adds a style listener.
boolean	appendComputedDefaultStyle(IlpStyle style) Deprecated. Adds a computed default style at the end of the list.
boolean	appendDefaultStyle(IlpStyle style) Deprecated. Adds a default style at the end of the list.
void	cleanValueProviders() Deprecated. Internally used to clean value providers.
Object	clone() Deprecated. Returns a copy of this style object.
void	debug() Deprecated. Prints a dump of the style, including: - Default styles - Local keys - Style value provider keys - Lazy keys
void	doCleanValueProviders() Deprecated. Internally used to clean value providers.
protected void	doClone(IlpAbstractStyle newStyle) Deprecated. Create internal structures to prepare clone operation.
protected void	doCopyAllContext(IlpAbstractStyle source) Deprecated. Copies all values from a given style.
protected boolean	doCopyAllValues(IlpAbstractStyle source) Deprecated. Perform copy.
protected void	doDispose() Deprecated. Cleans the local values and removes dependences.
protected void	doEndChangingStyleValues(Set<StyleListener> listenersSet) Deprecated. The heart of endChangingStyleValues.
protected void	doFireStyleSearchOrderNotification() Deprecated. This method resets the search order cache when a new style is added or removed to the default style list.
IlpStyle[]	doGetComputedDefaultStyles() Deprecated. Like getComputedDefaultStyles, only more efficient.
IlpStyle[]	doGetDefaultStyles() Deprecated. Like getDefaultStyles, only more efficient.
StyleListener[]	doGetStyleListeners() Deprecated. Optimized variant for use when _StyleLock is already taken.
protected IlpStyle[]	doGetStyleSearchOrder() Deprecated. This method returns the style search order when retrieving a value in this style.
protected boolean	doHasDefaultValue(IlpKey key, boolean checkStatic) Deprecated. Returns true if there is a default value associated with the key.
protected boolean	doHasStaticValue(IlpKey key) Deprecated. Returns true if there is a value associated with the key in a static style.
boolean	doHasValue(IlpKey key, boolean checkStatic) Deprecated. Tests whether a given IlpKey has a value associated with this style, either locally or in default styles.
protected boolean	doHasValueProvider(IlpKey key) Deprecated. Returns true if there is a local value provider associated with the key.
void	doMoveContents(IlpStyle style) Deprecated. This method is internally used to move the contents of this style to the given style.
protected boolean	doRemoveComputedDefaultStyle(IlpStyle style) Deprecated. Removes the given computed default style from the list.
protected Collection<IlpKey>	doRemoveDefaultStyle(IlpStyle defaultStyle) Deprecated. Removes a default style from the list of default styles.
protected Collection<IlpKey>	doResetValueProviders() Deprecated. Reset all value providers and return the list of changed keys.
protected Collection<IlpKey>	doSetDefaultStyles(IlpStyle[] defaultStyles) Deprecated. Sets the entire list of default styles.
protected boolean	doSetValueProvider(IlpKey key, IlpStyleValueProvider valueProvider, boolean doReset) Deprecated. Changes the value provider for the key.
protected void	doStartChangingStyleValues(Set<StyleListener> listenersSet) Deprecated.
protected boolean	doStyleValueChanged(IlpAbstractStyle source, IlpKey key, Set<StyleListener> listenersSet) Deprecated.
void	endChangingStyleValues() Deprecated. Allows the user to buffer and delay the notifications to the dependent telecom objects or styles when some style values are changed.
protected void	fireStyleChangeEvent(IlpKey k) Deprecated. Fires the style change event for the given key.
protected void	fireStyleNotification(Collection<IlpKey> changedKeys) Deprecated. Notifies the change on the given keys.
List<IlpStyle>	getAllDefaultStyles() Deprecated. Returns an unmodifiable list with all the default styles defined for this instance, including the ones defined by the user and those computed automatically based on the model.
List<IlpStyle>	getComputedDefaultStyles() Deprecated. Returns the computed default styles as an unmodifiable list.
IlpStyleContext	getContext() Deprecated. Gets the context for the style.
IlpStyle	getDefaultStyle(int index) Deprecated. Returns a default style by index.
List<IlpStyle>	getDefaultStyles() Deprecated. Returns the user-defined default styles as an unmodifiable list.
int	getFlags() Deprecated. Gets flag value.
Collection<IlpKey>	getKeys() Deprecated. Gets a collection with all keys present in this style, literal and value provider keys.
Collection<IlpKey>	getKnownKeys() Deprecated. Returns an unmodifiable collection with all the known keys of this style.
Object	getLocalValueOrNotFound(IlpKey key, IlpStyle source) Deprecated. Returns the local value for the given key, either if it was defined as a literal or as a value provider.
StyleListener	getOwner() Deprecated.
protected Collection<IlpKey>	getOwnKnownKeys() Deprecated. Returns a modifiable collection with all the keys of this style.
static IlpStyle	GetStyleFromContext(IlpStyleManager manager, IlpStyleContext cxt) Deprecated. Retrieve the style that corresponds to the given style context This method is used to support deserialization See IlpRemoteStyleValueProvider.readObject, IlpStyle.readObject and IlpUnresolvedStyleValueProvider.resolveRemove and resolveModifier
Collection<StyleChangeListener>	getStyleKeyListeners() Deprecated. Returns all the listeners for all the keys registered in this style.
Collection<StyleListener>	getStyleListeners() Deprecated. Gets a collection of Style Listeners.
Object	getValue(IlpKey key) Deprecated. Returns the value of a given IlpKey accessible through this style.
Object	getValue(IlpKey key, IlpStyle defStyle) Deprecated. Returns the value of a given IlpKey accessible through this style.
ilog.cpl.style.internal.IlpStyleValueOrigin	getValueOrigin(IlpKey key) Deprecated. Returns the location where a particular style value comes from.
Object	getValueOrNotFound(IlpKey key) Deprecated. Needed for compliance with IlpAbstractStyle.
Object	getValueOrNotFound(IlpKey key, IlpStyle source) Deprecated. Returns the value associated with the given key (either literal or value provider) or IlpAbstractStyle.NotFound if none is found.
IlpStyleValueProvider	getValueProvider(IlpKey key) Deprecated. Returns the local value provider that calculates the value for this key.
IlpStyleValueProvider	getValueProvider(IlpKey key, boolean searchAllTree) Deprecated. Returns the value provider defined for the given key, either locally or in the default styles.
Object	getValueProviderOrNotFound(IlpKey key) Deprecated. Returns the value provider associated with the given key or IlpAbstractStyle.NotFound if none is found.
ilog.util.internal.IlFastMap<IlpKey,IlpStyleValueProvider>	getValueProviders() Deprecated. Gets the style's value providers.
boolean	hasDefaultValue(IlpKey key) Deprecated. Returns true if there is a default value associated with the key.
boolean	hasDependencies() Deprecated. Returns if this style has dependencies on other styles or style listeners.
boolean	hasDependentValue(IlpKey key) Deprecated. Checks if a key has a dependent value.
boolean	hasValue(IlpKey key) Deprecated. Tests whether a given IlpKey has a value associated with this style, either locally or in default styles.
boolean	hasValue(IlpKey key, boolean checkStatic) Deprecated. Tests whether a given IlpKey has a value associated with this style, either locally or in default styles.
boolean	hasValueProvider(IlpKey key) Deprecated. Returns true if there is a local value provider associated with the key.
boolean	hasValueProvider(IlpKey key, boolean searchAll) Deprecated. Returns true if there is a value provider associated with the key.
protected boolean	isValueProviderValid(IlpKey key, IlpStyleValueProvider provider) Deprecated. Checks if the given value provider can be set.
protected boolean	needStyleValue(IlpKey k) Deprecated. Verifies if the key is really needed for this style.
boolean	prependComputedDefaultStyle(IlpStyle style) Deprecated. Adds a computed default style at the beginning of the list.
boolean	prependDefaultStyle(IlpStyle style) Deprecated. Adds a default style to the front of the list.
protected void	printDefaultStyle(IlpStyle style, String index) Deprecated. Print the style contents
protected void	registerStyleListener(IlpStyle[] styles) Deprecated. Convenience methods to register a style listener in all styles from an array.
protected void	registerStyleListener(List<IlpStyle> styles) Deprecated. Convenience methods to register a style listener in all styles from a list.
boolean	removeComputedDefaultStyle(IlpStyle style) Deprecated. Removes the given computed default style from the list.
boolean	removeDefaultStyle(IlpStyle defaultStyle) Deprecated. Removes a default style from the list of default styles.
void	removeStyleChangeListener(IlpKey key, StyleChangeListener listener) Deprecated. Removes the listener interested in modifications in the given key.
void	removeStyleListener(StyleListener listener) Deprecated. Removes a listener from this style.
boolean	resetAllValues(IlpStyle sourceStyle) Deprecated. This method is normally used in conjunction with useAllValues.
void	resetFlags(int value) Deprecated. Resets flag value.
void	resetStyleSearchOrder() Deprecated. Resets the style search order.
boolean	resetToDefaultValue(IlpKey key) Deprecated. Restores the default value of the key.
boolean	resetValueProvider(IlpKey key) Deprecated. Resets the value provider associated with this key.
void	resetValues() Deprecated. Resets all values defined in this style, literals and value providers.
void	setContext(IlpStyleContext newContext) Deprecated. Sets a new style context for the style.
boolean	setDefaultStyles(List<IlpStyle> defaultStyles) Deprecated. Sets the entire list of default styles.
void	setFlags(int value) Deprecated. Sets flag value.
void	setLiteral(IlpKey key, Object value) Deprecated. Changes the local literal value of a given key in this style.
void	setOwner(StyleListener o) Deprecated.
void	setValue(IlpKey key, Object value) Deprecated. Changes the local value of a given key in this style.
boolean	setValueProvider(IlpKey key, IlpStyleValueProvider valueProvider, boolean doReset) Deprecated. Changes the style value provider of a given key in this style.
void	startChangingStyleValues() Deprecated. Allows the user to buffer and delay the notifications to the dependent telecom objects or styles when some style values are changed.
void	styleChanged(StyleChangeEvent ev) Deprecated. This method is called by the style value providers that are being used by this style, indicating that its value has changed.
void	styleValueChanged(IlpAbstractStyle source, IlpKey key) Deprecated. This method is called whenever a value of a key is changed.
boolean	useAllValues(IlpStyle sourceStyle, boolean doResetValues) Deprecated. This method allows the user to use all values of the sourceStyle.

Methods inherited from class ilog.cpl.style.IlpAbstractStyle

addLiterals, cleanLiterals, coerceFastHashtable, convertFloatArray, convertIntegerArray, copyAllValues, dispose, doCleanLiterals, doHasLiteral, doResetLiteral, doResetLiterals, fireEndChangingStyleValues, fireStartChangingStyleValues, fireStyleValueChanged, getAppContext, getBoolean, getBoolean, getColor, getColor, getDomain, getDomain, getEnum, getEnum, getEnumArray, getEnumArray, getFloat, getFloat, getFloatArray, getFloatArray, getFloatArray, getFont, getFont, getFormat, getFormat, getImage, getImage, getInteger, getInteger, getIntegerArray, getIntegerArray, getIntegerArray, getInteractor, getInteractor, getLiteral, getLiteralOrNotFound, getLiterals, getPoint, getPoint, getRect, getRect, getRenderer, getRenderer, getSearchStrategy, getString, getString, getStringArray, getStringArray, getSwingConstant, getSwingConstant, getValue, getValueMap, getValueMap, hasLiteral, keys, moveContents, resetLiteral, resetLiterals, resetLiteralSilently, setAppContext, setBoolean, setColor, setDomain, setEnum, setEnumArray, setFloat, setFloatArray, setFloatArray, setFont, setFormat, setImage, setInteger, setIntegerArray, setIntegerArray, setInteractor, setLiterals, setLiteralSilently, setPoint, setRect, setRenderer, setSearchStrategy, setString, setStringArray, setSwingConstant, setValueMap, transientInit, verifyNeededStyleKeys

Methods inherited from class java.lang.Object

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

Field Detail

styleContext

protected IlpStyleContext styleContext

Deprecated.

Style context for this style

Internal: do not use!

valueProviders

protected ilog.util.internal.IlFastMap<IlpKey,IlpStyleValueProvider> valueProviders

Deprecated.

A table IlpKey -> IlpStyleValueProvider containing the value providers. Null values are allowed.

Internal: do not use!

styleSearchOrderCache

protected IlpStyle[] styleSearchOrderCache

Deprecated.

Unmodifiable list which contains the search order

Internal: do not use!

definedDefaultStyles

protected IlpStyle[] definedDefaultStyles

Deprecated.

Default (parent) styles specified by the user.

Internal: do not use!

definedDefaultStylesUnmodifiable

protected List<IlpStyle> definedDefaultStylesUnmodifiable

Deprecated.

Internal: do not use!

computedDefaultStyles

protected IlpStyle[] computedDefaultStyles

Deprecated.

Default (parent) styles automatically inherited.

Internal: do not use!

computedDefaultStylesUnmodifiable

protected List<IlpStyle> computedDefaultStylesUnmodifiable

Deprecated.

Internal: do not use!

defaultStylesCache

protected List<IlpStyle> defaultStylesCache

Deprecated.

Cache to all default styles list.

Internal: do not use!

owner

protected StyleListener owner

Deprecated.

The owner of the style, it is always a StyleListener with some privileges, like being the first one to be notified when it starts to be changed and the last one when it finishes.

Internal: do not use!

styleListeners

protected WeakHashMap<StyleListener,Object> styleListeners

Deprecated.

A table IlpStyle -> null This map contains listeners for this style. By default, all the styles that depend on this one are listeners, for instance an object style is a listener of a class style. Also user style listeners can be added.

Internal: do not use!

styleKeyListeners

protected ilog.util.internal.IlFastMap<IlpKey,Map<StyleChangeListener,Integer>> styleKeyListeners

Deprecated.

A table List of >.

This list contains the listeners for a specific key. For instance, a remote style value provider is a listener of a certain key in this style. Or some style value modifiers can also be listener of a specific key. This is an internal list used to support notifications for value providers.

Internal: do not use!

IN_COMPUTE_GRAPHIC

public static final int IN_COMPUTE_GRAPHIC

Deprecated.

See Also:

Constant Field Values

Internal: do not use!

Constructor Detail

IlpStyle

public IlpStyle()

Deprecated.

Style object constructor. Since no style context is given, an empty context is created for the style.

IlpStyle

public IlpStyle(IlpStyleContext styleContext)

Deprecated.

Style object constructor.

Parameters:

styleContext - Style context describing the style.

IlpStyle

protected IlpStyle(IlpStyle defaultStyle,
                   IlpStyleContext styleContext)

Deprecated.

Style object constructor, adding one default style to the list of default styles.

Parameters:

defaultStyle - A style set as a single default (parent) style.

styleContext - Style context describing the style.

IlpStyle

public IlpStyle(List<IlpStyle> defaultStyles,
                IlpStyleContext styleContext)

Deprecated.

Style object constructor, setting the default style.

Parameters:

defaultStyles - The styles set as the default (parent) styles. Note that this list is not copied; don't modify it afterwards.

styleContext - Style context describing the style.

Method Detail

clone

public Object clone()

Deprecated.

Returns a copy of this style object.

Overrides:

clone in class IlpAbstractStyle

Returns:

Returns a copy of this style object.

getContext

public IlpStyleContext getContext()

Deprecated.

Gets the context for the style.

Returns:

Context for the style.

setContext

public void setContext(IlpStyleContext newContext)

Deprecated.

Sets a new style context for the style.

Parameters:

newContext - New context for the style.

Internal: do not use!

getAllDefaultStyles

public List<IlpStyle> getAllDefaultStyles()

Deprecated.

Returns an unmodifiable list with all the default styles defined for this instance, including the ones defined by the user and those computed automatically based on the model.

Returns:

Unmodifiable list of default styles.

getDefaultStyles

public List<IlpStyle> getDefaultStyles()

Deprecated.

Returns the user-defined default styles as an unmodifiable list.

Returns:

Unmodifiable list of default styles.

See Also:

setDefaultStyles(java.util.List<ilog.cpl.style.IlpStyle>)

getComputedDefaultStyles

public List<IlpStyle> getComputedDefaultStyles()

Deprecated.

Returns the computed default styles as an unmodifiable list.

Returns:

Unmodifiable list of computed default styles.

Internal: do not use!

getDefaultStyle

public IlpStyle getDefaultStyle(int index)

Deprecated.

Returns a default style by index.

Parameters:

index - Index in the style list.

Returns:

The style contained in the style list at the given index.

Internal: do not use!

setDefaultStyles

public boolean setDefaultStyles(List<IlpStyle> defaultStyles)

Deprecated.

Sets the entire list of default styles.

Parameters:

defaultStyles - Complete list of default styles to use.

Returns:

Boolean indicating whether the operation succeeded.

Internal: do not use!

prependDefaultStyle

public boolean prependDefaultStyle(IlpStyle style)

Deprecated.

Adds a default style to the front of the list.

Parameters:

style - Style to add.

Returns:

Returns false if the operation cannot be done, true otherwise.

appendDefaultStyle

public boolean appendDefaultStyle(IlpStyle style)

Deprecated.

Adds a default style at the end of the list.

Parameters:

style - Style to add.

Returns:

Returns false if the operation cannot be done, true otherwise.

removeDefaultStyle

public boolean removeDefaultStyle(IlpStyle defaultStyle)

Deprecated.

Removes a default style from the list of default styles.

Parameters:

defaultStyle - Default style to remove.

prependComputedDefaultStyle

public boolean prependComputedDefaultStyle(IlpStyle style)

Deprecated.

Adds a computed default style at the beginning of the list. No need to notify because this operation is done at construction time.

Internal: do not use!

appendComputedDefaultStyle

public boolean appendComputedDefaultStyle(IlpStyle style)

Deprecated.

Adds a computed default style at the end of the list. No need to notify because this operation is done at construction time.

Internal: do not use!

removeComputedDefaultStyle

public boolean removeComputedDefaultStyle(IlpStyle style)

Deprecated.

Removes the given computed default style from the list.

Internal: do not use!

getValueProviders

public ilog.util.internal.IlFastMap<IlpKey,IlpStyleValueProvider> getValueProviders()

Deprecated.

Gets the style's value providers.

Internal: do not use!

hasValue

public boolean hasValue(IlpKey key)

Deprecated.

Tests whether a given IlpKey has a value associated with this style, either locally or in default styles.

Specified by:

hasValue in class IlpAbstractStyle

Parameters:

key - Key for the value to check.

Returns:

Boolean indicating whether the style has a value for the given key.

hasValue

public boolean hasValue(IlpKey key,
                        boolean checkStatic)

Deprecated.

Tests whether a given IlpKey has a value associated with this style, either locally or in default styles.

Parameters:

key - Key for the value to check.

checkStatic - Flag which indicates if the static styles will be checked or not.

Returns:

Boolean indicating whether the style has a value for the given key.

Internal: do not use!

hasValueProvider

public boolean hasValueProvider(IlpKey key)

Deprecated.

Returns true if there is a local value provider associated with the key.

Parameters:

key - Key for the value provider to check.

Returns:

Boolean indicating whether the style has a local value provider for the given key.

hasValueProvider

public boolean hasValueProvider(IlpKey key,
                                boolean searchAll)

Deprecated.

Returns true if there is a value provider associated with the key.

Parameters:

key - Key for the value provider to check.

searchAll - Indicates that a value provider should be searched in the style hierarchy

Returns:

Boolean indicating whether the style has a local value provider for the given key.

Internal: do not use!

hasDefaultValue

public boolean hasDefaultValue(IlpKey key)

Deprecated.

Returns true if there is a default value associated with the key. The ordered list of default styles is searched for the existence of the given key.

Parameters:

key - Key for the value to check.

Returns:

Boolean indicating if the style has a default value for the given key.

getValue

public Object getValue(IlpKey key)

Deprecated.

Returns the value of a given IlpKey accessible through this style. The value is either local or from a default style. If this key is not present, the default key value is returned.

Specified by:

getValue in class IlpAbstractStyle

getValueProvider

public IlpStyleValueProvider getValueProvider(IlpKey key)

Deprecated.

Returns the local value provider that calculates the value for this key.

Parameters:

key - Key for the value provider to retrieve.

Returns:

The retrieved value provider or null if the value provider does not exist.

getValueProvider

public IlpStyleValueProvider getValueProvider(IlpKey key,
                                              boolean searchAllTree)

Deprecated.

Returns the value provider defined for the given key, either locally or in the default styles.

Parameters:

key - Key for the value provider to retrieve.

searchAllTree - Flag indicating whether the search will be in the whole style hierarchy (true) or just local (false.

Returns:

The retrieved value provider or null if the value provider does not exist.

getValue

public Object getValue(IlpKey key,
                       IlpStyle defStyle)

Deprecated.

Returns the value of a given IlpKey accessible through this style. If the value could not be found locally, it will be searched in the given default style.

Internal: do not use!

getValueOrigin

public ilog.cpl.style.internal.IlpStyleValueOrigin getValueOrigin(IlpKey key)

Deprecated.

Returns the location where a particular style value comes from. Must be compatible with getValueOrNotFound.

Internal: do not use!

setValue

public void setValue(IlpKey key,
                     Object value)

Deprecated.

Changes the local value of a given key in this style.

Specified by:

setValue in class IlpAbstractStyle

Parameters:

key - Key for value to set.

value - Value to set. This can be either a literal value or a style value provider.

Throws:

IllegalArgumentException - is the value class does not correspond to the key class

setLiteral

public void setLiteral(IlpKey key,
                       Object value)

Deprecated.

Changes the local literal value of a given key in this style.

Overrides:

setLiteral in class IlpAbstractStyle

Parameters:

key - Key for value to set.

value - Literal value to set.

setValueProvider

public boolean setValueProvider(IlpKey key,
                                IlpStyleValueProvider valueProvider,
                                boolean doReset)

Deprecated.

Changes the style value provider of a given key in this style.

Parameters:

key - Key for value provider to set.

valueProvider - Value provider to set. If the value is null, then the value provider is removed from the style.

doReset - Indicates whether the literal value associated with this key should be reset.

useAllValues

public boolean useAllValues(IlpStyle sourceStyle,
                            boolean doResetValues)

Deprecated.

This method allows the user to use all values of the sourceStyle.

This method calls setRemoteValue on the current style for each key known in the sourceStyle. Locally, a remote style value provider with the identical key name to the remote key name is created for each of the values in the remote style.

If any of the setRemoteValue calls fail, the method returns false, leaving the work partially done. Otherwise it returns true.

If doResetValues is set to true, resetLiteral is called on each defined value.

resetAllValues

public boolean resetAllValues(IlpStyle sourceStyle)

Deprecated.

This method is normally used in conjunction with useAllValues. Using this method, remote values previously set by useAllValues are removed.

The method calls setValueProvider on each value known in sourceStyle, passing null as the remote value, deleting the corresponding remote value.

See Also:

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

resetValueProvider

public boolean resetValueProvider(IlpKey key)

Deprecated.

Resets the value provider associated with this key.

Parameters:

key - The key for the value to reset.

Returns:

true if the operation succeeds, otherwise it returns false.

resetValues

public void resetValues()

Deprecated.

Resets all values defined in this style, literals and value providers.

If a key is used by another style (using style value providers), its value will not be removed.

resetToDefaultValue

public boolean resetToDefaultValue(IlpKey key)

Deprecated.

Restores the default value of the key. The default value is the inherited value, that is, the value of the same name found in the default style. To do this, this method resets the local and value providers if they are present.

addStyleListener

public void addStyleListener(StyleListener listener)

Deprecated.

Adds a style listener.

The given style listener will be notified whenever a key value changes in this style.

Note: The listener is weakly registered. This means that calling addStyleListener will not prevent it from being garbage collected. If you want to make sure that it is not garbage collected and that you continually receive notification through it, you need to keep a reference to it.

See Also:

StyleListener

addStyleListener

public void addStyleListener(StyleListener listener,
                             Object value)

Deprecated.

Adds a style listener.

The given style listener will be notified whenever a key value changes in this style. If value is null, then the notification about end of changes is called outside the Style synchronization. By default, normal style listeners have null value. On the other hand, all listeners registered internally to receive notifications when a default style is changed, must be registered with a non-null value (Boolean.TRUE)

See Also:

StyleListener

Internal: do not use!

removeStyleListener

public void removeStyleListener(StyleListener listener)

Deprecated.

Removes a listener from this style.

See Also:

StyleListener

startChangingStyleValues

public void startChangingStyleValues()

Deprecated.

Allows the user to buffer and delay the notifications to the dependent telecom objects or styles when some style values are changed. The redraws are also delayed. The user can use this method as soon as several calls are performed on the same style. Calls must come in pairs with endChangingStyleValues, and can be nested.

Specified by:

startChangingStyleValues in interface StyleListener

See Also:

endChangingStyleValues()

styleValueChanged

public void styleValueChanged(IlpAbstractStyle source,
                              IlpKey key)

Deprecated.

This method is called whenever a value of a key is changed.

Specified by:

styleValueChanged in interface StyleListener

Parameters:

source - Source style where the event was generated

key - Key that has changed

Internal: do not use!

endChangingStyleValues

public void endChangingStyleValues()

Deprecated.

Allows the user to buffer and delay the notifications to the dependent telecom objects or styles when some style values are changed. The redraws are also delayed. The user can use this method as soon as several calls are performed on the same style. Calls must come in pairs with startChangingStyleValues, and can be nested.

Specified by:

endChangingStyleValues in interface StyleListener

See Also:

startChangingStyleValues()

getKeys

public Collection<IlpKey> getKeys()

Deprecated.

Gets a collection with all keys present in this style, literal and value provider keys.

Overrides:

getKeys in class IlpAbstractStyle

Internal: do not use!

getKnownKeys

public Collection<IlpKey> getKnownKeys()

Deprecated.

Returns an unmodifiable collection with all the known keys of this style.

Returns:

The collection or Collections.EMPTY_COLLECTION.

Internal: do not use!

getOwnKnownKeys

protected Collection<IlpKey> getOwnKnownKeys()

Deprecated.

Returns a modifiable collection with all the keys of this style. This method is to be called with the style locked.

Overrides:

getOwnKnownKeys in class IlpAbstractStyle

Internal: do not use!

doDispose

protected void doDispose()

Deprecated.

Cleans the local values and removes dependences. This method is called when the style is being prepared to be garbage collected.

Overrides:

doDispose in class IlpAbstractStyle

Internal: do not use!

debug

public void debug()

Deprecated.

Prints a dump of the style, including: - Default styles - Local keys - Style value provider keys - Lazy keys

Internal: do not use!

setOwner

@Deprecated
public void setOwner(StyleListener o)

Deprecated.

Sets the owner of the style. This method will be deleted !

Internal: do not use!

getOwner

@Deprecated
public StyleListener getOwner()

Deprecated.

Returns the owner of the style. This method will be deleted !

Internal: do not use!

setFlags

public void setFlags(int value)

Deprecated.

Sets flag value.

Internal: do not use!

resetFlags

public void resetFlags(int value)

Deprecated.

Resets flag value.

Internal: do not use!

getFlags

public int getFlags()

Deprecated.

Gets flag value.

Internal: do not use!

cleanValueProviders

public void cleanValueProviders()

Deprecated.

Internally used to clean value providers.

Internal: do not use!

addStyleChangeListener

public void addStyleChangeListener(IlpKey key,
                                   StyleChangeListener listener)

Deprecated.

Adds a listener interested in modifications in the given key.

This method is used internally when a value provider is using a remote key which is in this style. So we register the value provider as a listener of this key.

This method should not be documented.

Internal: do not use!

removeStyleChangeListener

public void removeStyleChangeListener(IlpKey key,
                                      StyleChangeListener listener)

Deprecated.

Removes the listener interested in modifications in the given key.

Internal: do not use!

fireStyleChangeEvent

protected void fireStyleChangeEvent(IlpKey k)

Deprecated.

Fires the style change event for the given key.

Internal: do not use!

hasDependentValue

public boolean hasDependentValue(IlpKey key)

Deprecated.

Checks if a key has a dependent value.

A key will have a dependent value is there is any value provider in any style which uses this key as a remote key.

Internal: do not use!

getStyleKeyListeners

public Collection<StyleChangeListener> getStyleKeyListeners()

Deprecated.

Returns all the listeners for all the keys registered in this style.

Internal: do not use!

styleChanged

public void styleChanged(StyleChangeEvent ev)

Deprecated.

This method is called by the style value providers that are being used by this style, indicating that its value has changed. So the style can do something, like notify all its own listeners of this change.

Specified by:

styleChanged in interface StyleChangeListener

Internal: do not use!

getStyleListeners

public Collection<StyleListener> getStyleListeners()

Deprecated.

Gets a collection of Style Listeners.

Internal: do not use!

hasDependencies

public boolean hasDependencies()

Deprecated.

Returns if this style has dependencies on other styles or style listeners.

Internal: do not use!

registerStyleListener

protected void registerStyleListener(List<IlpStyle> styles)

Deprecated.

Convenience methods to register a style listener in all styles from a list.

Internal: do not use!

registerStyleListener

protected void registerStyleListener(IlpStyle[] styles)

Deprecated.

Convenience methods to register a style listener in all styles from an array.

Internal: do not use!

fireStyleNotification

protected void fireStyleNotification(Collection<IlpKey> changedKeys)

Deprecated.

Notifies the change on the given keys.

Overrides:

fireStyleNotification in class IlpAbstractStyle

Internal: do not use!

doFireStyleSearchOrderNotification

protected void doFireStyleSearchOrderNotification()

Deprecated.

This method resets the search order cache when a new style is added or removed to the default style list. It must reset my own cache and also those from my listeners. This is executed within a Style lock block !

Internal: do not use!

doStartChangingStyleValues

protected void doStartChangingStyleValues(Set<StyleListener> listenersSet)

Deprecated.

Internal: do not use!

doStyleValueChanged

protected boolean doStyleValueChanged(IlpAbstractStyle source,
                                      IlpKey key,
                                      Set<StyleListener> listenersSet)

Deprecated.

Internal: do not use!

doEndChangingStyleValues

protected void doEndChangingStyleValues(Set<StyleListener> listenersSet)

Deprecated.

The heart of endChangingStyleValues. May notify some other styles. But this is called with _StyleLock held. It must not call the attached listeners directly. Instead it adds them to the listeners set.

Internal: do not use!

getValueOrNotFound

public Object getValueOrNotFound(IlpKey key,
                                 IlpStyle source)

Deprecated.

Returns the value associated with the given key (either literal or value provider) or IlpAbstractStyle.NotFound if none is found.

Parameters:

key - The key to find.

source - The style whose context is used to resolve value providers.

Returns:

The value for the key or NotFound if not found.

Internal: do not use!

getValueOrNotFound

public Object getValueOrNotFound(IlpKey key)

Deprecated.

Needed for compliance with IlpAbstractStyle.

Specified by:

getValueOrNotFound in class IlpAbstractStyle

Internal: do not use!

getLocalValueOrNotFound

public Object getLocalValueOrNotFound(IlpKey key,
                                      IlpStyle source)

Deprecated.

Returns the local value for the given key, either if it was defined as a literal or as a value provider.

Parameters:

key - the key to find

Returns:

the value for the key or NotFound if not found.

Internal: do not use!

getValueProviderOrNotFound

public Object getValueProviderOrNotFound(IlpKey key)

Deprecated.

Returns the value provider associated with the given key or IlpAbstractStyle.NotFound if none is found. Must be called by synchronized methods only.

Internal: do not use!

isValueProviderValid

protected boolean isValueProviderValid(IlpKey key,
                                       IlpStyleValueProvider provider)

Deprecated.

Checks if the given value provider can be set.

Internal: do not use!

doSetValueProvider

protected boolean doSetValueProvider(IlpKey key,
                                     IlpStyleValueProvider valueProvider,
                                     boolean doReset)

Deprecated.

Changes the value provider for the key.

This method is not going to notify, but it will return if the notification should be sent or not.

Returns:

if the value provider was set or not. If the value provider was set, then we should notify changes on the requested key.

Internal: do not use!

needStyleValue

protected boolean needStyleValue(IlpKey k)

Deprecated.

Verifies if the key is really needed for this style. This method must be called within a _StyleLock block.

Internal: do not use!

doHasValue

public boolean doHasValue(IlpKey key,
                          boolean checkStatic)

Deprecated.

Tests whether a given IlpKey has a value associated with this style, either locally or in default styles.

Parameters:

key - Key for the value to check.

Returns:

Boolean indicating whether the style has a value for the given key.

Internal: do not use!

doHasValueProvider

protected boolean doHasValueProvider(IlpKey key)

Deprecated.

Returns true if there is a local value provider associated with the key.

Parameters:

key - Key for the value provider to check.

Returns:

Boolean indicating whether the style has a local value provider for the given key. Must be called from a synchronized block.

Internal: do not use!

doHasStaticValue

protected boolean doHasStaticValue(IlpKey key)

Deprecated.

Returns true if there is a value associated with the key in a static style.

Parameters:

key - Key for the value provider to check.

Returns:

Boolean indicating whether the style has a local value provider for the given key. Must be called from a synchronized block.

Internal: do not use!

doHasDefaultValue

protected boolean doHasDefaultValue(IlpKey key,
                                    boolean checkStatic)

Deprecated.

Returns true if there is a default value associated with the key. The ordered list of default styles is searched for the existence of the given key.

Parameters:

key - Key for the value to check.

Returns:

Boolean indicating if the style has a default value for the given key. Must be called from a synchronized block.

Internal: do not use!

doMoveContents

public void doMoveContents(IlpStyle style)

Deprecated.

This method is internally used to move the contents of this style to the given style. It is internally used by IltLegend.AdaptStyle to move the contents of an IlpStyle to JTGO legends. Synchronization is done in IlpStyle. Must be called from a synchronized block.

Overrides:

doMoveContents in class IlpAbstractStyle

Parameters:

style - Target style

Internal: do not use!

doCopyAllContext

protected void doCopyAllContext(IlpAbstractStyle source)

Deprecated.

Copies all values from a given style.

Overrides:

doCopyAllContext in class IlpAbstractStyle

Internal: do not use!

doCopyAllValues

protected boolean doCopyAllValues(IlpAbstractStyle source)

Deprecated.

Perform copy. Must be called from a synchronized block. start/endChangingStyleValues should be called outside.

Overrides:

doCopyAllValues in class IlpAbstractStyle

Returns:

true if something has changed

Internal: do not use!

doGetStyleListeners

public StyleListener[] doGetStyleListeners()

Deprecated.

Optimized variant for use when _StyleLock is already taken.

Internal: do not use!

doGetComputedDefaultStyles

public IlpStyle[] doGetComputedDefaultStyles()

Deprecated.

Like getComputedDefaultStyles, only more efficient.

Returns:

List of computed default styles. You must not modify it. Must be called from a synchronized block.

Internal: do not use!

doGetDefaultStyles

public IlpStyle[] doGetDefaultStyles()

Deprecated.

Like getDefaultStyles, only more efficient.

Returns:

List of default styles. You must not modify it. Must be called from a synchronized block.

Internal: do not use!

doSetDefaultStyles

protected Collection<IlpKey> doSetDefaultStyles(IlpStyle[] defaultStyles)

Deprecated.

Sets the entire list of default styles.

Parameters:

defaultStyles - Complete list of default styles to use.

Returns:

Boolean indicating whether the operation succeeded and notification needs to be sent. Must be called from a synchronized block.

Internal: do not use!

doRemoveDefaultStyle

protected Collection<IlpKey> doRemoveDefaultStyle(IlpStyle defaultStyle)

Deprecated.

Removes a default style from the list of default styles.

Parameters:

defaultStyle - Default style to remove.

Returns:

Collection with all changed keys

Internal: do not use!

doRemoveComputedDefaultStyle

protected boolean doRemoveComputedDefaultStyle(IlpStyle style)

Deprecated.

Removes the given computed default style from the list.

Internal: do not use!

doCleanValueProviders

public void doCleanValueProviders()

Deprecated.

Internally used to clean value providers. This method does not send notifications !

Internal: do not use!

doResetValueProviders

protected Collection<IlpKey> doResetValueProviders()

Deprecated.

Reset all value providers and return the list of changed keys. Must be called from a synchronization block.

Internal: do not use!

doClone

protected void doClone(IlpAbstractStyle newStyle)

Deprecated.

Create internal structures to prepare clone operation.

Overrides:

doClone in class IlpAbstractStyle

Internal: do not use!

printDefaultStyle

protected void printDefaultStyle(IlpStyle style,
                                 String index)

Deprecated.

Print the style contents

Parameters:

style - Style

index - Index

Internal: do not use!

doGetStyleSearchOrder

protected IlpStyle[] doGetStyleSearchOrder()

Deprecated.

This method returns the style search order when retrieving a value in this style.

The first element in the list is the style itself.

Please note that the returned list must not be modified.

Returns:

The list of styles to be visited when searching for a value

Internal: do not use!

resetStyleSearchOrder

public final void resetStyleSearchOrder()

Deprecated.

Resets the style search order.

This method should be called when a change in the default styles list happens.

Internal: do not use!

GetStyleFromContext

public static IlpStyle GetStyleFromContext(IlpStyleManager manager,
                                           IlpStyleContext cxt)

Deprecated.

Retrieve the style that corresponds to the given style context This method is used to support deserialization See IlpRemoteStyleValueProvider.readObject, IlpStyle.readObject and IlpUnresolvedStyleValueProvider.resolveRemove and resolveModifier

Parameters:

manager -

cxt -

Returns:

The style that corresponds to the given style context

Internal: do not use!