Package com.intellij.openapi.editor.markup

Class TextAttributes

java.lang.Object

com.intellij.openapi.editor.markup.TextAttributes

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

ColorAndFontDescription

public class TextAttributes
extends java.lang.Object
implements java.lang.Cloneable

Defines the visual representation (colors and effects) of text.

Field Summary

Fields

Modifier and Type	Field and Description
static TextAttributes	ERASE_MARKER

Constructor Summary

Constructors

Constructor and Description
TextAttributes()
TextAttributes(java.awt.Color foregroundColor, java.awt.Color backgroundColor, java.awt.Color effectColor, EffectType effectType, int fontType)
TextAttributes(Element element)

Method Summary

Modifier and Type	Method and Description
TextAttributes	clone()
void	copyFrom(TextAttributes other)
boolean	equals(java.lang.Object obj)
void	forEachAdditionalEffect(java.util.function.BiConsumer<? super EffectType,? super java.awt.Color> consumer)
void	forEachEffect(java.util.function.BiConsumer<? super EffectType,? super java.awt.Color> consumer)
static TextAttributes	fromFlyweight(AttributesFlyweight flyweight)
java.awt.Color	getBackgroundColor()
java.awt.Color	getEffectColor()
EffectType	getEffectType()
java.awt.Color	getErrorStripeColor()
AttributesFlyweight	getFlyweight()
int	getFontType()
java.awt.Color	getForegroundColor()
boolean	hasEffects()
int	hashCode()
boolean	isEmpty()
static TextAttributes	merge(TextAttributes under, TextAttributes above) Merges (layers) the two given text attributes.
void	readExternal(Element element)
void	setAdditionalEffects(java.util.Map<EffectType,java.awt.Color> effectsMap) Sets additional effects to paint
void	setAttributes(java.awt.Color foregroundColor, java.awt.Color backgroundColor, java.awt.Color effectColor, java.awt.Color errorStripeColor, EffectType effectType, int fontType)
void	setAttributes(java.awt.Color foregroundColor, java.awt.Color backgroundColor, java.awt.Color effectColor, java.awt.Color errorStripeColor, EffectType effectType, java.util.Map<EffectType,java.awt.Color> additionalEffects, int fontType)
void	setBackgroundColor(java.awt.Color color)
void	setEffectColor(java.awt.Color color)
void	setEffectType(EffectType effectType)
void	setErrorStripeColor(java.awt.Color color)
void	setFontType(int type)
void	setForegroundColor(java.awt.Color color)
java.lang.String	toString()
void	withAdditionalEffect(EffectType effectType, java.awt.Color color) Appends additional effect to paint with specific color
void	withAdditionalEffects(java.util.Map<EffectType,java.awt.Color> effectsMap) Appends additional effects to paint with specific colors.
void	writeExternal(Element element)

Methods inherited from class java.lang.Object

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

Field Detail

ERASE_MARKER

public static final TextAttributes ERASE_MARKER

Constructor Detail

TextAttributes

public TextAttributes()

TextAttributes

public TextAttributes(Element element)

TextAttributes

public TextAttributes(java.awt.Color foregroundColor,
                      java.awt.Color backgroundColor,
                      java.awt.Color effectColor,
                      EffectType effectType,
                      int fontType)

Method Detail

merge

public static TextAttributes merge(TextAttributes under,
                                   TextAttributes above)

Merges (layers) the two given text attributes.

Parameters:

under - Text attributes to merge "under".

above - Text attributes to merge "above", overriding settings from "under".

Returns:

Merged attributes instance.

copyFrom

public void copyFrom(TextAttributes other)

setAttributes

public void setAttributes(java.awt.Color foregroundColor,
                          java.awt.Color backgroundColor,
                          java.awt.Color effectColor,
                          java.awt.Color errorStripeColor,
                          EffectType effectType,
                          int fontType)

setAttributes

public void setAttributes(java.awt.Color foregroundColor,
                          java.awt.Color backgroundColor,
                          java.awt.Color effectColor,
                          java.awt.Color errorStripeColor,
                          EffectType effectType,
                          java.util.Map<EffectType,java.awt.Color> additionalEffects,
                          int fontType)

isEmpty

public boolean isEmpty()

getFlyweight

public AttributesFlyweight getFlyweight()

fromFlyweight

public static TextAttributes fromFlyweight(AttributesFlyweight flyweight)

getForegroundColor

public java.awt.Color getForegroundColor()

setForegroundColor

public void setForegroundColor(java.awt.Color color)

getBackgroundColor

public java.awt.Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

getEffectColor

public java.awt.Color getEffectColor()

setEffectColor

public void setEffectColor(java.awt.Color color)

getErrorStripeColor

public java.awt.Color getErrorStripeColor()

setErrorStripeColor

public void setErrorStripeColor(java.awt.Color color)

hasEffects

public boolean hasEffects()

Returns:

true iff there are effects to draw in this attributes

setAdditionalEffects

public void setAdditionalEffects(java.util.Map<EffectType,java.awt.Color> effectsMap)

Sets additional effects to paint

Parameters:

effectsMap - map of effect types and colors to use.

withAdditionalEffect

public void withAdditionalEffect(EffectType effectType,
                                 java.awt.Color color)

Appends additional effect to paint with specific color

See Also:

setAdditionalEffects(Map)

withAdditionalEffects

public void withAdditionalEffects(java.util.Map<EffectType,java.awt.Color> effectsMap)

Appends additional effects to paint with specific colors. New effects may supersede old ones

See Also:

setAdditionalEffects(Map), TextAttributesEffectsBuilder

getEffectType

public EffectType getEffectType()

forEachAdditionalEffect

public void forEachAdditionalEffect(java.util.function.BiConsumer<? super EffectType,? super java.awt.Color> consumer)

forEachEffect

public void forEachEffect(java.util.function.BiConsumer<? super EffectType,? super java.awt.Color> consumer)

setEffectType

public void setEffectType(EffectType effectType)

getFontType

public int getFontType()

setFontType

public void setFontType(int type)

clone

public TextAttributes clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

readExternal

public void readExternal(Element element)

writeExternal

public void writeExternal(Element element)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object