Package com.intellij.openapi.editor.colors

Class TextAttributesKey

java.lang.Object

com.intellij.openapi.editor.colors.TextAttributesKey

All Implemented Interfaces:

java.lang.Comparable<TextAttributesKey>

public final class TextAttributesKey
extends java.lang.Object
implements java.lang.Comparable<TextAttributesKey>

A type of item with a distinct highlighting in an editor or in other views.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextAttributesKey.TextAttributeKeyDefaultsProvider

Field Summary

Fields

Modifier and Type	Field and Description
static TextAttributesKey[]	EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
TextAttributesKey(Element element)

Method Summary

Modifier and Type	Method and Description
int	compareTo(TextAttributesKey key)
static TextAttributesKey	createTempTextAttributesKey(java.lang.String externalName, TextAttributes defaultAttributes) Registers a temp text attribute key with the specified identifier and default attributes.
static TextAttributesKey	createTextAttributesKey(java.lang.String externalName) Registers a text attribute key with the specified identifier.
static TextAttributesKey	createTextAttributesKey(java.lang.String externalName, TextAttributes defaultAttributes) Deprecated. Use createTextAttributesKey(String, TextAttributesKey) to guarantee compatibility with generic color schemes.
static TextAttributesKey	createTextAttributesKey(java.lang.String externalName, TextAttributesKey fallbackAttributeKey) Registers a text attribute key with the specified identifier and a fallback key.
boolean	equals(java.lang.Object o)
static TextAttributesKey	find(java.lang.String externalName)
TextAttributes	getDefaultAttributes() Returns the default text attributes associated with the key.
java.lang.String	getExternalName()
TextAttributesKey	getFallbackAttributeKey()
int	hashCode()
static boolean	isTemp(TextAttributesKey key)
void	setFallbackAttributeKey(TextAttributesKey fallbackAttributeKey) Deprecated. Use createTextAttributesKey(String, TextAttributesKey) instead
java.lang.String	toString()
void	writeExternal(Element element)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final TextAttributesKey[] EMPTY_ARRAY

Constructor Detail

TextAttributesKey

public TextAttributesKey(Element element)

Method Detail

find

public static TextAttributesKey find(java.lang.String externalName)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getExternalName

public java.lang.String getExternalName()

compareTo

public int compareTo(TextAttributesKey key)

Specified by:

compareTo in interface java.lang.Comparable<TextAttributesKey>

createTextAttributesKey

public static TextAttributesKey createTextAttributesKey(java.lang.String externalName)

Registers a text attribute key with the specified identifier.

Parameters:

externalName - the unique identifier of the key.

Returns:

the new key instance, or an existing instance if the key with the same identifier was already registered.

writeExternal

public void writeExternal(Element element)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDefaultAttributes

public TextAttributes getDefaultAttributes()

Returns the default text attributes associated with the key.

Returns:

the text attributes.

createTextAttributesKey

@Deprecated
public static TextAttributesKey createTextAttributesKey(java.lang.String externalName,
                                                        TextAttributes defaultAttributes)

Deprecated. Use createTextAttributesKey(String, TextAttributesKey) to guarantee compatibility with generic color schemes.

Registers a text attribute key with the specified identifier and default attributes.

Parameters:

externalName - the unique identifier of the key.

defaultAttributes - the default text attributes associated with the key.

Returns:

the new key instance, or an existing instance if the key with the same identifier was already registered.

createTextAttributesKey

public static TextAttributesKey createTextAttributesKey(java.lang.String externalName,
                                                        TextAttributesKey fallbackAttributeKey)

Registers a text attribute key with the specified identifier and a fallback key. If text attributes for the key are not defined in a color scheme, they will be acquired by the fallback key if possible.

Fallback keys can be chained, for example, text attribute key A can depend on key B which in turn can depend on key C. So if text attributes neither for A nor for B are found, they will be acquired by the key C.

Fallback keys can be used from any place including language's own definitions. Note that there is a common set of keys called DefaultLanguageHighlighterColors which can be used as a base. Scheme designers are supposed to set colors for these keys primarily and using them guarantees that most (if not all) text attributes will be shown correctly for the language regardless of a color scheme.

Parameters:

externalName - the unique identifier of the key.

fallbackAttributeKey - the fallback key to use if text attributes for this key are not defined.

Returns:

the new key instance, or an existing instance if the key with the same identifier was already registered.

createTempTextAttributesKey

public static TextAttributesKey createTempTextAttributesKey(java.lang.String externalName,
                                                            TextAttributes defaultAttributes)

Registers a temp text attribute key with the specified identifier and default attributes. The attribute of the temp attribute key is not serialized and not copied while TextAttributesScheme manipulations.

Parameters:

externalName - the unique identifier of the key.

defaultAttributes - the default text attributes associated with the key.

Returns:

the new key instance, or an existing instance if the key with the same identifier was already registered.

getFallbackAttributeKey

public TextAttributesKey getFallbackAttributeKey()

setFallbackAttributeKey

@Deprecated
public void setFallbackAttributeKey(TextAttributesKey fallbackAttributeKey)

Deprecated. Use createTextAttributesKey(String, TextAttributesKey) instead

isTemp

public static boolean isTemp(TextAttributesKey key)