Package com.intellij.openapi.editor.colors

Interface EditorColorsScheme

All Superinterfaces:

java.lang.Cloneable, Scheme, SchemeMetaInfo, TextAttributesScheme

All Known Implementing Classes:

AbstractColorsScheme, DefaultColorsScheme, DelegateColorScheme, EditorColorsSchemeImpl, EmptyColorScheme

public interface EditorColorsScheme
extends java.lang.Cloneable, TextAttributesScheme, Scheme, SchemeMetaInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SCHEME_ALIAS
static java.lang.String	DEFAULT_SCHEME_NAME

Fields inherited from interface com.intellij.openapi.options.Scheme

EDITABLE_COPY_PREFIX

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.awt.Color	getColor(ColorKey key)
java.lang.String	getConsoleFontName()
FontPreferences	getConsoleFontPreferences()
int	getConsoleFontSize()
float	getConsoleLineSpacing()
java.awt.Color	getDefaultBackground()
java.awt.Color	getDefaultForeground()
java.lang.String	getEditorFontName()
int	getEditorFontSize()
java.awt.Font	getFont(EditorFontType key)
FontPreferences	getFontPreferences() The IDE has allowed to configure only a single font family for a while.
float	getLineSpacing()
default FontSize	getQuickDocFontSize() Deprecated. Quick documentation component's font size is stored in application level property, and can be obtained using DocumentationComponent.getQuickDocFontSize().
default boolean	isUseAppFontPreferencesInEditor()
default boolean	isUseEditorFontPreferencesInConsole()
void	readExternal(Element parentNode)
void	setAttributes(TextAttributesKey key, TextAttributes attributes)
void	setColor(ColorKey key, java.awt.Color color)
void	setConsoleFontName(java.lang.String fontName)
void	setConsoleFontPreferences(FontPreferences preferences)
void	setConsoleFontSize(int fontSize)
void	setConsoleLineSpacing(float lineSpacing)
void	setEditorFontName(java.lang.String fontName)
void	setEditorFontSize(int fontSize) Sets font size.
void	setFont(EditorFontType key, java.awt.Font font) Deprecated. Use getFontPreferences() and ModifiableFontPreferences to change fonts.
void	setFontPreferences(FontPreferences preferences)
void	setLineSpacing(float lineSpacing) Sets line spacing.
void	setName(java.lang.String name)
default void	setQuickDocFontSize(FontSize fontSize) Deprecated. Quick documentation component's font size is stored in application level property, and can be set using DocumentationComponent.setQuickDocFontSize(FontSize).
default void	setUseAppFontPreferencesInEditor()
default void	setUseEditorFontPreferencesInConsole()

Methods inherited from interface com.intellij.openapi.editor.colors.TextAttributesScheme

getAttributes

Methods inherited from interface com.intellij.openapi.options.Scheme

getDisplayName, getName

Methods inherited from interface com.intellij.openapi.options.SchemeMetaInfo

getMetaProperties

Field Detail

DEFAULT_SCHEME_NAME

static final java.lang.String DEFAULT_SCHEME_NAME

See Also:

Constant Field Values

DEFAULT_SCHEME_ALIAS

static final java.lang.String DEFAULT_SCHEME_ALIAS

See Also:

Constant Field Values

Method Detail

setName

void setName(java.lang.String name)

setAttributes

void setAttributes(TextAttributesKey key,
                   TextAttributes attributes)

getDefaultBackground

java.awt.Color getDefaultBackground()

getDefaultForeground

java.awt.Color getDefaultForeground()

getColor

java.awt.Color getColor(ColorKey key)

setColor

void setColor(ColorKey key,
              java.awt.Color color)

getFontPreferences

FontPreferences getFontPreferences()

The IDE has allowed to configure only a single font family for a while. However, that doesn't handle a situation when that font family is unable to display particular char - fallback font family was chosen randomly from the whole collection of all registered fonts.

Now it's possible to specify more than one font, i.e. directly indicated 'fallback fonts sequence' (see FontPreferences). However, old single font-based API is still here in order to preserve backward compatibility (getEditorFontName() and getEditorFontSize()). I.e. those methods are just re-written in order to use FontPreferences object exposed by this method.

Returns:

font preferences to use

setFontPreferences

void setFontPreferences(FontPreferences preferences)

getEditorFontName

java.lang.String getEditorFontName()

setEditorFontName

void setEditorFontName(java.lang.String fontName)

getEditorFontSize

int getEditorFontSize()

setEditorFontSize

void setEditorFontSize(int fontSize)

Sets font size. Note, that this method checks that fontSize is within bounds and could change it if it is more than EditorFontsConstants.getMaxEditorFontSize() or less than EditorFontsConstants.getMinEditorFontSize()

See Also:

EditorFontsConstants

getQuickDocFontSize

@Deprecated
default FontSize getQuickDocFontSize()

Deprecated. Quick documentation component's font size is stored in application level property, and can be obtained using DocumentationComponent.getQuickDocFontSize().

setQuickDocFontSize

@Deprecated
default void setQuickDocFontSize(FontSize fontSize)

Deprecated. Quick documentation component's font size is stored in application level property, and can be set using DocumentationComponent.setQuickDocFontSize(FontSize).

getFont

java.awt.Font getFont(EditorFontType key)

setFont

@Deprecated
void setFont(EditorFontType key,
             java.awt.Font font)

Deprecated. Use getFontPreferences() and ModifiableFontPreferences to change fonts.

getLineSpacing

float getLineSpacing()

setLineSpacing

void setLineSpacing(float lineSpacing)

Sets line spacing. Note, that this method checks that lineSpacing is within bounds and could change it if it is more than EditorFontsConstants.getMaxEditorLineSpacing() or less than EditorFontsConstants.getMinEditorLineSpacing()

See Also:

EditorFontsConstants

clone

java.lang.Object clone()

getConsoleFontPreferences

FontPreferences getConsoleFontPreferences()

Returns:

console font preferences to use

See Also:

getFontPreferences()

setConsoleFontPreferences

void setConsoleFontPreferences(FontPreferences preferences)

setUseEditorFontPreferencesInConsole

default void setUseEditorFontPreferencesInConsole()

isUseEditorFontPreferencesInConsole

default boolean isUseEditorFontPreferencesInConsole()

setUseAppFontPreferencesInEditor

default void setUseAppFontPreferencesInEditor()

isUseAppFontPreferencesInEditor

default boolean isUseAppFontPreferencesInEditor()

getConsoleFontName

java.lang.String getConsoleFontName()

setConsoleFontName

void setConsoleFontName(java.lang.String fontName)

getConsoleFontSize

int getConsoleFontSize()

setConsoleFontSize

void setConsoleFontSize(int fontSize)

getConsoleLineSpacing

float getConsoleLineSpacing()

setConsoleLineSpacing

void setConsoleLineSpacing(float lineSpacing)

readExternal

void readExternal(Element parentNode)