Package com.intellij.openapi.editor.markup

Class TextAttributesEffectsBuilder

java.lang.Object

com.intellij.openapi.editor.markup.TextAttributesEffectsBuilder

public class TextAttributesEffectsBuilder
extends java.lang.Object

Allows to build effects for the TextAttributes. Allows to cover effects on the current state and slip effects under it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextAttributesEffectsBuilder.EffectDescriptor
static class	TextAttributesEffectsBuilder.EffectSlot

Method Summary

Modifier and Type	Method and Description
TextAttributes	applyTo(TextAttributes targetAttributes) Applies effects from the current state to the target attributes
TextAttributesEffectsBuilder	coverWith(EffectType effectType, java.awt.Color effectColor) Applies effect with effectType and effectColor to the current state.
TextAttributesEffectsBuilder	coverWith(TextAttributes attributes) Applies effects from attributes above current state of the merger.
static TextAttributesEffectsBuilder	create() Creates a builder without any effects
static TextAttributesEffectsBuilder	create(TextAttributes deepestAttributes) Creates a builder with effects from deepestAttributes
TextAttributesEffectsBuilder.EffectDescriptor	getEffectDescriptor(TextAttributesEffectsBuilder.EffectSlot effectSlot)
TextAttributesEffectsBuilder	slipUnder(EffectType effectType, java.awt.Color effectColor) Applies effect with effectType and effectColor to the current state if effect slot is not used.
TextAttributesEffectsBuilder	slipUnder(TextAttributes attributes) Applies effects from attributes if effect slots are not used.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TextAttributesEffectsBuilder create()

Creates a builder without any effects

create

public static TextAttributesEffectsBuilder create(TextAttributes deepestAttributes)

Creates a builder with effects from deepestAttributes

coverWith

public final TextAttributesEffectsBuilder coverWith(TextAttributes attributes)

Applies effects from attributes above current state of the merger. Effects may override mutually exclusive ones. E.g If current state has underline and we applying attributes with wave underline, underline effect will be removed.

slipUnder

public final TextAttributesEffectsBuilder slipUnder(TextAttributes attributes)

Applies effects from attributes if effect slots are not used.

coverWith

public TextAttributesEffectsBuilder coverWith(EffectType effectType,
                                              java.awt.Color effectColor)

Applies effect with effectType and effectColor to the current state. Effects may override mutually exclusive ones. E.g If current state has underline and we applying attributes with wave underline, underline effect will be removed.

slipUnder

public TextAttributesEffectsBuilder slipUnder(EffectType effectType,
                                              java.awt.Color effectColor)

Applies effect with effectType and effectColor to the current state if effect slot is not used.

applyTo

public TextAttributes applyTo(TextAttributes targetAttributes)

Applies effects from the current state to the target attributes

Parameters:

targetAttributes - passed targetAttributes

getEffectDescriptor

public TextAttributesEffectsBuilder.EffectDescriptor getEffectDescriptor(TextAttributesEffectsBuilder.EffectSlot effectSlot)