ilog.cpl.style.key

Class IlpKey

java.lang.Object

ilog.util.IlEnum

ilog.cpl.style.key.IlpKey

Direct Known Subclasses:

IlpBooleanKey, IlpColorKey, IlpDomainKey, IlpEnumArrayKey, IlpEnumKey, IlpFloatArrayKey, IlpFloatKey, IlpFontKey, IlpFormatKey, IlpImageKey, IlpIntegerArrayKey, IlpIntegerKey, IlpInteractorKey, IlpLineStyleKey, IlpPatternKey, IlpPointKey, IlpRectKey, IlpRendererKey, IlpStringArrayKey, IlpStringKey, IlpSwingConstantKey, IlpValueMapKey

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 IlpKey
extends IlEnum

This enumeration contains the keys for IlpStyle properties.

An IlpKey is an entry point in an IlpStyle. The key lets you store and retrieve values in a style. To draw objects, values containing graphical properties are retrieved from styles using specific keys. For instance, a key named LABEL_BACKGROUND_COLOR may be used to access the background color for a label.

Since:

JTGO 3.0

See Also:

IlpStyle

Deprecated Since:

JTGO 3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	defaultValue Deprecated. Default value for the key
protected static Logger	logger Deprecated. Logger for local access
static IlEnumInfo	metainfo Deprecated. Contains metainformation about this IlEnum class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlpKey(String name, Object defaultValue) Deprecated. Creates a new property key.

Method Summary

Modifier and Type	Method and Description
Object	getDefaultInitValue() Deprecated. Gets the default value for the key.
static IlpKey	GetSharedInstance(String name) Deprecated. Retrieves an existing key instance.
static IlpKey	GetSharedInstance(String name, Class type) Deprecated. Returns an existing key instance or creates a new key of the given type.
Class	getValueType() Deprecated. Gets the value type of the key.
int	hashCode() Deprecated.
Object	internalGetDefaultValue() Deprecated. Internal accessor to default value.
static IlpKey	NewKey(String name) Deprecated. Creates a new key for untyped properties and sets the default value to null.
static IlpKey	NewKey(String name, Object defaultValue) Deprecated. Creates a new key for untyped properties.
protected void	setDefaultInitValue(Object defaultValue) Deprecated. Sets the default value for the key.

Methods inherited from class ilog.util.IlEnum

getName, intern, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

defaultValue

protected Object defaultValue

Deprecated.

Default value for the key

Internal: do not use!

logger

protected static final Logger logger

Deprecated.

Logger for local access

Internal: do not use!

metainfo

public static IlEnumInfo metainfo

Deprecated.

Contains metainformation about this IlEnum class.

Constructor Detail

IlpKey

protected IlpKey(String name,
                 Object defaultValue)

Deprecated.

Creates a new property key.

Parameters:

name - a unique name for the key, used for serialization.

defaultValue - Initialization default value used if no other value is available.

Method Detail

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

Internal: do not use!

NewKey

public static IlpKey NewKey(String name)

Deprecated.

Creates a new key for untyped properties and sets the default value to null.

Parameters:

name - A unique name for the key, used for serialization.

NewKey

public static IlpKey NewKey(String name,
                            Object defaultValue)

Deprecated.

Creates a new key for untyped properties.

Parameters:

name - A unique name for the key, used for serialization.

defaultValue - Initialization default value used if no other value is available.

getDefaultInitValue

public Object getDefaultInitValue()

Deprecated.

Gets the default value for the key.

Returns:

Default value of the key.

getValueType

public Class getValueType()

Deprecated.

Gets the value type of the key.

Returns:

Class of the value stored in the key.

setDefaultInitValue

protected void setDefaultInitValue(Object defaultValue)

Deprecated.

Sets the default value for the key.

Parameters:

defaultValue - Default value to set for the key.

Internal: do not use!

GetSharedInstance

public static IlpKey GetSharedInstance(String name)

Deprecated.

Retrieves an existing key instance.

Parameters:

name - The name of the key to retrieve.

GetSharedInstance

public static IlpKey GetSharedInstance(String name,
                                       Class type)

Deprecated.

Returns an existing key instance or creates a new key of the given type.

Parameters:

name - The name of the key to retrieve.

type - Key type

Since:

JTGO 3.5

internalGetDefaultValue

public Object internalGetDefaultValue()

Deprecated.

Internal accessor to default value.

Internal: do not use!