ilog.tgo.graphic

Class IltLegendModifier

java.lang.Object

ilog.cpl.style.IlpAbstractStyle

ilog.cpl.style.IlpStyle

ilog.tgo.graphic.IltAbstractLegend

ilog.tgo.graphic.IltLegendModifier

All Implemented Interfaces:

StyleChangeListener, StyleListener, ilog.tgo.graphic.internal.IltGraphicUpdate, Serializable, Cloneable, EventListener

Direct Known Subclasses:

IltBaseStyleMapping

Deprecated.

Please use cascading style sheets instead.

@Deprecated
public class IltLegendModifier
extends IltAbstractLegend
implements ilog.tgo.graphic.internal.IltGraphicUpdate, Cloneable

A legend modifier is a legend-like object, whose values can be copied to another legend.

All the values present in this legend modifier are considered as mapped values in the object. This legend can contain only literals, which are set using setValue or setLiteral, or remote values, which are set using setRemoteValue(IlpKey, IlpKey)

Since:

JTGO 2.0

See Also:

Serialized Form

Deprecated Since:

JTGO 3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected static IlpStyleContext	DEFAULT_STYLE_CONTEXT Deprecated. All legend modifiers use the same style context.
protected ilog.util.internal.IlFastMap<IlpKey,IlpKey>	remoteKeys Deprecated. A table IlpKey -> IlpKey.

Fields inherited from class ilog.cpl.style.IlpStyle

computedDefaultStyles, computedDefaultStylesUnmodifiable, defaultStylesCache, definedDefaultStyles, definedDefaultStylesUnmodifiable, IN_COMPUTE_GRAPHIC, owner, styleContext, styleKeyListeners, styleListeners, styleSearchOrderCache, valueProviders

Fields inherited from class ilog.cpl.style.IlpAbstractStyle

_StyleLock, appContext, literals, NotFound, searchStrategy

Constructor Summary

Constructors

Constructor and Description
IltLegendModifier() Deprecated. Default constructor.
IltLegendModifier(Object[] keysAndValues) Deprecated. For internal use only.

Method Summary

Modifier and Type	Method and Description
void	apply(IltGraphic graphic) Deprecated. Applies the graphic update to a graphic object.
protected void	apply(IltObject object, ilog.tgo.graphic.internal.IltObjectLegend targetLegend) Deprecated. Graphic update implementation.
Object	clone() Deprecated. Returns a clone of this object.
void	debug() Deprecated. Prints a dump of the style, including: - Default styles - Local keys - Style value provider keys - Lazy keys
IlpKey	getRemoteValue(IlpKey key) Deprecated. Retrieves the remote value associated with the key.
IltKey	getRemoteValue(IltKey k) Deprecated. Please use getRemoteValue(IlpKey k) instead.
Object	getValue(IltKey k) Deprecated. Please use IlpKey version instead.
boolean	hasValue(IltKey k) Deprecated. Please use IlpKey version instead.
boolean	resetToDefaultValue(IlpKey key) Deprecated. Resets the key value in the style.
void	resetToDefaultValue(IltKey k) Deprecated. Please use IlpKey version instead.
void	resetValue(IltKey k) Deprecated. Please use resetLiteral instead.
void	setRemoteValue(IlpKey key, IlpKey destKey) Deprecated. Changes the remote value of a given key in this legend.
void	setRemoteValue(IlpKey lkey, IltKey destKey) Deprecated. Please use setRemoteValue(IlpKey key, IlpKey destKey) instead.
void	setRemoteValue(IltKey key, IlpKey rkey) Deprecated. Please use setRemoteValue(IlpKey key, IlpKey destKey) instead.
void	setRemoteValue(IltKey key, IltKey destKey) Deprecated. Please use setRemoteValue(IlpKey key, IlpKey destKey) instead.
void	setValue(IltKey k, Object value) Deprecated. Please use IlpKey version instead.

Methods inherited from class ilog.tgo.graphic.IltAbstractLegend

coerceFastHashtable, convertTable, getBoolean, getBoolean, getColor, getColor, getEnum, getEnum, getEnumArray, getEnumArray, getFloat, getFloat, getFont, getFont, getImage, getImage, getInteger, getInteger, getLineStyle, getLineStyle, getLineStyle, getLineStyle, getPattern, getPattern, getPattern, getPattern, getPoint, getPoint, getString, getString, getStringArray, getStringArray, setBoolean, setColor, setEnum, setFloat, setFont, setImage, setInteger, setLineStyle, setLineStyle, setPattern, setPattern, setPoint, setPoint, setString, setValue

Methods inherited from class ilog.cpl.style.IlpStyle

addStyleChangeListener, addStyleListener, addStyleListener, appendComputedDefaultStyle, appendDefaultStyle, cleanValueProviders, doCleanValueProviders, doClone, doCopyAllContext, doCopyAllValues, doDispose, doEndChangingStyleValues, doFireStyleSearchOrderNotification, doGetComputedDefaultStyles, doGetDefaultStyles, doGetStyleListeners, doGetStyleSearchOrder, doHasDefaultValue, doHasStaticValue, doHasValue, doHasValueProvider, doMoveContents, doRemoveComputedDefaultStyle, doRemoveDefaultStyle, doResetValueProviders, doSetDefaultStyles, doSetValueProvider, doStartChangingStyleValues, doStyleValueChanged, endChangingStyleValues, fireStyleChangeEvent, fireStyleNotification, getAllDefaultStyles, getComputedDefaultStyles, getContext, getDefaultStyle, getDefaultStyles, getFlags, getKeys, getKnownKeys, getLocalValueOrNotFound, getOwner, getOwnKnownKeys, GetStyleFromContext, getStyleKeyListeners, getStyleListeners, getValue, getValue, getValueOrigin, getValueOrNotFound, getValueOrNotFound, getValueProvider, getValueProvider, getValueProviderOrNotFound, getValueProviders, hasDefaultValue, hasDependencies, hasDependentValue, hasValue, hasValue, hasValueProvider, hasValueProvider, isValueProviderValid, needStyleValue, prependComputedDefaultStyle, prependDefaultStyle, printDefaultStyle, registerStyleListener, registerStyleListener, removeComputedDefaultStyle, removeDefaultStyle, removeStyleChangeListener, removeStyleListener, resetAllValues, resetFlags, resetStyleSearchOrder, resetValueProvider, resetValues, setContext, setDefaultStyles, setFlags, setLiteral, setOwner, setValue, setValueProvider, startChangingStyleValues, styleChanged, styleValueChanged, useAllValues

Methods inherited from class ilog.cpl.style.IlpAbstractStyle

addLiterals, cleanLiterals, 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

DEFAULT_STYLE_CONTEXT

protected static final IlpStyleContext DEFAULT_STYLE_CONTEXT

Deprecated.

All legend modifiers use the same style context. In this case, the style context is never used and these style instances are never added to a style manager. So let's share the same instance to reduce memallocation.

Internal: do not use!

remoteKeys

protected ilog.util.internal.IlFastMap<IlpKey,IlpKey> remoteKeys

Deprecated.

A table IlpKey -> IlpKey. null values are allowed. Here are the remote values

Internal: do not use!

Constructor Detail

IltLegendModifier

public IltLegendModifier()

Deprecated.

Default constructor.

IltLegendModifier

public IltLegendModifier(Object[] keysAndValues)

Deprecated.

For internal use only.
This metod is a shortcut to create a new instance and initialize it with key/value couples.

Method Detail

debug

public void debug()

Deprecated.

Description copied from class: IlpStyle

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

Overrides:

debug in class IlpStyle

Internal: do not use!

clone

public Object clone()

Deprecated.

Returns a clone of this object.

Overrides:

clone in class IltAbstractLegend

Returns:

Returns a copy of this style object.

resetToDefaultValue

public boolean resetToDefaultValue(IlpKey key)

Deprecated.

Resets the key value in the style.

Overrides:

resetToDefaultValue in class IlpStyle

Since:

JTGO 3.0

getRemoteValue

public IlpKey getRemoteValue(IlpKey key)

Deprecated.

Retrieves the remote value associated with the key.

Since:

JTGO 3.0

setRemoteValue

public void setRemoteValue(IlpKey key,
                           IlpKey destKey)

Deprecated.

Changes the remote value of a given key in this legend.

Since:

JTGO 3.0

setValue

@Deprecated
public void setValue(IltKey k,
                                 Object value)

Deprecated. Please use IlpKey version instead.

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

Deprecated Since:

JTGO 3.0

resetValue

@Deprecated
public void resetValue(IltKey k)

Deprecated. Please use resetLiteral instead.

Resets the local value associated with this key. This is useful when a local value has been set by one of the set... functions on this legend. If a remote value exists for this key, it will be the new value.

Deprecated Since:

JTGO 3.0

resetToDefaultValue

@Deprecated
public void resetToDefaultValue(IltKey k)

Deprecated. Please use IlpKey version instead.

Removes the value from the legend.

Deprecated Since:

JTGO 3.0

getValue

@Deprecated
public Object getValue(IltKey k)

Deprecated. Please use IlpKey version instead.

Returns the value of a given IltKey in this legend.

Deprecated Since:

JTGO 3.0

hasValue

@Deprecated
public boolean hasValue(IltKey k)

Deprecated. Please use IlpKey version instead.

Tests whether a given IltKey has a value associated with this legend.

Deprecated Since:

JTGO 3.0

getRemoteValue

@Deprecated
public IltKey getRemoteValue(IltKey k)

Deprecated. Please use getRemoteValue(IlpKey k) instead.

Retrieves the remote value associated with the key.

Deprecated Since:

JTGO 3.0

setRemoteValue

@Deprecated
public void setRemoteValue(IltKey key,
                                       IltKey destKey)

Deprecated. Please use setRemoteValue(IlpKey key, IlpKey destKey) instead.

Changes the remote value of a given key in this legend.

Deprecated Since:

JTGO 3.0

setRemoteValue

@Deprecated
public void setRemoteValue(IlpKey lkey,
                                       IltKey destKey)

Deprecated. Please use setRemoteValue(IlpKey key, IlpKey destKey) instead.

Changes the remote value of a given key in this legend.

Deprecated Since:

JTGO 3.0

setRemoteValue

@Deprecated
public void setRemoteValue(IltKey key,
                                       IlpKey rkey)

Deprecated. Please use setRemoteValue(IlpKey key, IlpKey destKey) instead.

Changes the remote value of a given key in this legend.

Deprecated Since:

JTGO 3.0

apply

protected void apply(IltObject object,
                     ilog.tgo.graphic.internal.IltObjectLegend targetLegend)

Deprecated.

Graphic update implementation.

Internal: do not use!

apply

public void apply(IltGraphic graphic)

Deprecated.

Applies the graphic update to a graphic object.

Specified by:

apply in interface ilog.tgo.graphic.internal.IltGraphicUpdate

Internal: do not use!