ilog.tgo.graphic

Class IltLegend

java.lang.Object

ilog.cpl.style.IlpAbstractStyle

ilog.cpl.style.IlpStyle

ilog.tgo.graphic.IltAbstractLegend

ilog.tgo.graphic.IltLegend

All Implemented Interfaces:

StyleChangeListener, StyleListener, Serializable, Cloneable, EventListener

Deprecated.

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

@Deprecated
public class IltLegend
extends IltAbstractLegend
implements Cloneable, StyleListener

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

Since:

JTGO 2.0

See Also:

IlpStyle, Serialized Form

Deprecated Since:

JTGO 3.0

Field Summary

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
IltLegend() Deprecated. Please use IlpStyle instead.
IltLegend(IlpStyleContext styleContext) Deprecated. Creates a legend with the given context
IltLegend(IltLegend defaultLegend) Deprecated. Please use IlpStyle instead.

Method Summary

Modifier and Type	Method and Description
static IlpStyle	AdaptStyle(IlpStyleManager styleMgr, IlpStyleContext styleContext, IlpStyle style) Deprecated. This method is just for compatibility with old JTGO.
Object	clone() Deprecated. Please use IlpStyle instead.
void	endChangingLegendValues() Deprecated. Please use endChangingStyleValues instead.
IltLegend	getDefaultLegend() Deprecated. Please use getAllDefaultStyles instead.
Vector<IlpKey>	getKnownValues() Deprecated. Please use getKnownKeys instead.
Object	getLocalValue(IlpKey key) Deprecated. Please use getLiteral instead.
Object	getLocalValue(IltKey k) Deprecated. Please use getLiteral instead.
Object	getValue(IltKey k) Deprecated. Please use the IlpKey version instead.
boolean	hasDefaultValue(IltKey k) Deprecated. Please use IlpKey version instead.
boolean	hasLocalValue(IlpKey key) Deprecated. Please use hasLiteral version instead.
boolean	hasLocalValue(IltKey k) Deprecated. Please use hasLiteral version instead.
boolean	hasRemoteValue(IlpKey key) Deprecated. Please use hasValueProvider instead.
boolean	hasRemoteValue(IltKey k) Deprecated. Please use hasValueProvider instead.
boolean	hasValue(IltKey k) Deprecated. Please use IlpKey version instead.
IltLegend	popDefaultLegend() Deprecated. Please use removeDefaultStyle instead.
boolean	pushDefaultLegend(IltLegend newDefaultLegend) Deprecated. Please use appendDefaultStyle or prependDefaultStyle instead.
boolean	resetToDefaultValue(IltKey k) Deprecated. Please use the IlpKey version instead.
boolean	resetValue(IlpKey key) Deprecated. Please use resetLiteral version instead.
boolean	resetValue(IltKey k) Deprecated. Please use IlpKey version instead.
boolean	setDefaultLegend(IltLegend defaultLegend) Deprecated. Please use setDefaultStyles instead.
boolean	setRemoteValue(IlpKey lKey, IltLegend legend, IlpKey rKey) Deprecated. Please use setValueProvider version instead.
boolean	setRemoteValue(IlpKey lKey, IltLegend legend, IltKey remoteKey) Deprecated.
boolean	setRemoteValue(IltKey key, IltLegend legend, IlpKey rKey) Deprecated.
boolean	setRemoteValue(IltKey key, IltLegend legend, IltKey remoteKey) Deprecated. Please use setValueProvider version instead.
void	setValue(IltKey k, Object value) Deprecated. Please use the IlpKey version instead.
void	startChangingLegendValues() Deprecated. Please use startChangingStyleValues instead.
boolean	unUseAllValues(IltLegend legend) Deprecated. Please use resetAllValues 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, debug, 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, resetToDefaultValue, 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

Methods inherited from interface ilog.cpl.style.StyleListener

endChangingStyleValues, startChangingStyleValues, styleValueChanged

Constructor Detail

IltLegend

@Deprecated
public IltLegend()

Deprecated. Please use IlpStyle instead.

Creates a new legend object.

Deprecated Since:

JTGO 3.0

IltLegend

@Deprecated
public IltLegend(IltLegend defaultLegend)

Deprecated. Please use IlpStyle instead.

Creates a new legend object, and sets defaultLegend as its default legend.

Parameters:

defaultLegend - The legend defined as the default legend.

Deprecated Since:

JTGO 3.0

IltLegend

public IltLegend(IlpStyleContext styleContext)

Deprecated.

Creates a legend with the given context

Parameters:

styleContext - Style context describing the style

Internal: do not use!

Method Detail

clone

@Deprecated
public Object clone()

Deprecated. Please use IlpStyle instead.

Returns a copy of this legend object.

Overrides:

clone in class IltAbstractLegend

Returns:

Returns a copy of this style object.

Deprecated Since:

JTGO 3.0

pushDefaultLegend

@Deprecated
public boolean pushDefaultLegend(IltLegend newDefaultLegend)

Deprecated. Please use appendDefaultStyle or prependDefaultStyle instead.

Places newDefaultLegend between this legend and its default legend.

The object "this" then has newDefaultLegend as the first priority default legend. If the operation fails, the method returns false.

See Also:

popDefaultLegend()

Deprecated Since:

JTGO 3.0

popDefaultLegend

@Deprecated
public IltLegend popDefaultLegend()

Deprecated. Please use removeDefaultStyle instead.

This method is usually called in combination with pushDefaultLegend.

It removes the current first priority default legend from the default list. If the operation succeeds, the method returns the popped legend, otherwise it returns null.

See Also:

pushDefaultLegend(ilog.tgo.graphic.IltLegend)

Deprecated Since:

JTGO 3.0

unUseAllValues

@Deprecated
public boolean unUseAllValues(IltLegend legend)

Deprecated. Please use resetAllValues instead.

This method is usually used in combination with useAllValues; it cancels the remote values previously set by the call useAllValues.

See Also:

IlpRemoteStyleValueProvider

Deprecated Since:

JTGO 3.0

getDefaultLegend

@Deprecated
public IltLegend getDefaultLegend()

Deprecated. Please use getAllDefaultStyles instead.

Returns the default legend.

See Also:

setDefaultLegend(ilog.tgo.graphic.IltLegend)

Deprecated Since:

JTGO 3.0

setDefaultLegend

@Deprecated
public boolean setDefaultLegend(IltLegend defaultLegend)

Deprecated. Please use setDefaultStyles instead.

Sets the default legend to defaultLegend. The default legend is used when the current legend has no local or remote value for a given key. This method returns false if the operation cannot be performed (for example, if some required keys are lost after the operation).

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

hasLocalValue

@Deprecated
public boolean hasLocalValue(IltKey k)

Deprecated. Please use hasLiteral version instead.

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

Deprecated Since:

JTGO 3.0

getLocalValue

@Deprecated
public Object getLocalValue(IltKey k)

Deprecated. Please use getLiteral instead.

Retrieves the local value associated with the key.

Deprecated Since:

JTGO 3.0

hasRemoteValue

@Deprecated
public boolean hasRemoteValue(IltKey k)

Deprecated. Please use hasValueProvider instead.

Returns true if a remote value is associated with the key.

Deprecated Since:

JTGO 3.0

hasDefaultValue

@Deprecated
public boolean hasDefaultValue(IltKey k)

Deprecated. Please use IlpKey version instead.

Returns true if a default value is associated with the key.

Deprecated Since:

JTGO 3.0

getValue

@Deprecated
public Object getValue(IltKey k)

Deprecated. Please use the IlpKey version instead.

Returns the value of a given IltKey in this legend.

Deprecated Since:

JTGO 3.0

setValue

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

Deprecated. Please use the IlpKey version instead.

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

Deprecated Since:

JTGO 3.0

setRemoteValue

@Deprecated
public boolean setRemoteValue(IltKey key,
                                          IltLegend legend,
                                          IltKey remoteKey)

Deprecated. Please use setValueProvider version instead.

Changes the remote value of a given key in this legend. If the operation succeeds, the method returns true, otherwise it returns false. If a local value is present, it is erased; thus, the remote value will not be hidden.

Parameters:

key - The local key.

legend - The remote legend.

remoteKey - The key in the remote legend.

Deprecated Since:

JTGO 3.0

resetToDefaultValue

@Deprecated
public boolean resetToDefaultValue(IltKey k)

Deprecated. Please use the IlpKey version instead.

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 legend. To do this, this method resets the local and remote values if they are present.

Deprecated Since:

JTGO 3.0

resetValue

@Deprecated
public boolean resetValue(IltKey k)

Deprecated. Please use IlpKey version 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. Otherwise, the inherited value will be used. If there is no inherited value and the value is still required, nothing happens. Otherwise, the key is removed from the legend.

Returns:

true if the operation succeeds, false otherwise.

Deprecated Since:

JTGO 3.0

startChangingLegendValues

@Deprecated
public void startChangingLegendValues()

Deprecated. Please use startChangingStyleValues instead.

Allows the user to buffer and delay the notifications to the dependent telecom objects or legends when some legend values have changed. The redraws are also delayed. This method can be used as soon as several calls have been performed on the same legend. Calls must come in pairs with endChangingLegendValues, and can be nested.

See Also:

endChangingLegendValues()

Deprecated Since:

JTGO 3.0

endChangingLegendValues

@Deprecated
public void endChangingLegendValues()

Deprecated. Please use endChangingStyleValues instead.

Allows the user to buffer and delay the notifications to the dependent telecom objects or legends when some legend values have changed. The redraws are also delayed. This method can be used as soon as several calls have been performed on the same legend. Calls must come in pairs with startChangingLegendValues, and can be nested.

See Also:

startChangingLegendValues()

Deprecated Since:

JTGO 3.0

getKnownValues

@Deprecated
public Vector<IlpKey> getKnownValues()

Deprecated. Please use getKnownKeys instead.

Returns a Vector of all the known (seen) keys of this legend.

Deprecated Since:

JTGO 3.0

hasLocalValue

@Deprecated
public boolean hasLocalValue(IlpKey key)

Deprecated. Please use hasLiteral version instead.

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

Deprecated Since:

JTGO 3.0

getLocalValue

@Deprecated
public Object getLocalValue(IlpKey key)

Deprecated. Please use getLiteral instead.

Retrieves the local value associated with the key.

Deprecated Since:

JTGO 3.0

hasRemoteValue

@Deprecated
public boolean hasRemoteValue(IlpKey key)

Deprecated. Please use hasValueProvider instead.

Returns true if a remote value is associated with the key.

Deprecated Since:

JTGO 3.0

setRemoteValue

@Deprecated
public boolean setRemoteValue(IlpKey lKey,
                                          IltLegend legend,
                                          IlpKey rKey)

Deprecated. Please use setValueProvider version instead.

Changes the remote value of a given key in this legend. If the operation succeeds, the method returns true, otherwise it returns false. If a local value is present, it is erased; thus, the remote value will not be hidden.

Parameters:

lKey - The local key.

legend - The remote legend.

rKey - The key in the remote legend.

Deprecated Since:

JTGO 3.0

setRemoteValue

public boolean setRemoteValue(IltKey key,
                              IltLegend legend,
                              IlpKey rKey)

Deprecated.

Internal: do not use!

setRemoteValue

public boolean setRemoteValue(IlpKey lKey,
                              IltLegend legend,
                              IltKey remoteKey)

Deprecated.

Internal: do not use!

resetValue

@Deprecated
public boolean resetValue(IlpKey key)

Deprecated. Please use resetLiteral version 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. Otherwise, the inherited value will be used. If there is no inherited value and the value is still required, nothing happens. Otherwise, the key is removed from the legend.

Returns:

true if the operation succeeds, false otherwise.

Deprecated Since:

JTGO 3.0

AdaptStyle

public static IlpStyle AdaptStyle(IlpStyleManager styleMgr,
                                  IlpStyleContext styleContext,
                                  IlpStyle style)

Deprecated.

This method is just for compatibility with old JTGO. In JTGO we need to have IltClassLegend, IltObjectLegend and IltLegend. So when we retrieve a style from the style, we call this method and convert from IlpStyle to the needed style type. We copy the values to the legend. NOTE: For compatibility with previous versions

Since:

JTGO 3.0

Internal: do not use!