Package com.intellij.openapi.options.colors.pages

Class GeneralColorsPage

java.lang.Object

com.intellij.openapi.options.colors.pages.GeneralColorsPage

All Implemented Interfaces:

InspectionColorSettingsPage, ColorAndFontDescriptorsProvider, ColorSettingsPage, DisplayPrioritySortable, EditorCustomization

public class GeneralColorsPage
extends java.lang.Object
implements ColorSettingsPage, InspectionColorSettingsPage, DisplayPrioritySortable, EditorCustomization

Field Summary

Fields inherited from interface com.intellij.openapi.options.colors.ColorSettingsPage

EP_NAME

Constructor Summary

Constructors

Constructor and Description
GeneralColorsPage()

Method Summary

Modifier and Type	Method and Description
void	customize(EditorEx editor) Applies this customization to the given editor.
java.util.Map<java.lang.String,ColorKey>	getAdditionalHighlightingTagToColorKeyMap() Specifies tag-to-'color key' mapping for regions with presentation containing additional colors from color map.
java.util.Map<java.lang.String,TextAttributesKey>	getAdditionalHighlightingTagToDescriptorMap() Returns the mapping from special tag names surrounding the regions to be highlighted in the preview text (see ColorSettingsPage.getDemoText()) to text attribute keys used to highlight the regions.
AttributesDescriptor []	getAttributeDescriptors() Returns the list of descriptors specifying the TextAttributesKey instances for which colors are specified in the page.
ColorDescriptor []	getColorDescriptors() Returns the list of descriptors specifying the ColorKey instances for which colors are specified in the page.
java.lang.String	getDemoText() Returns the text shown in the preview pane.
java.lang.String	getDisplayName() Returns the title of the page, shown as text in the dialog tab.
static java.lang.String	getDisplayNameText()
SyntaxHighlighter	getHighlighter() Returns the syntax highlighter which is used to highlight the text shown in the preview pane of the page.
javax.swing.Icon	getIcon() Returns the icon for the page, shown in the dialog tab.
DisplayPriority	getPriority()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.options.colors.ColorSettingsPage

getAdditionalInlineElementToDescriptorMap

Constructor Detail

GeneralColorsPage

public GeneralColorsPage()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: ColorAndFontDescriptorsProvider

Returns the title of the page, shown as text in the dialog tab.

Specified by:

getDisplayName in interface ColorAndFontDescriptorsProvider

Returns:

the title of the custom page.

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: ColorSettingsPage

Returns the icon for the page, shown in the dialog tab.

Specified by:

getIcon in interface ColorSettingsPage

Returns:

the icon for the page, or null if the page does not have a custom icon.

getAttributeDescriptors

public AttributesDescriptor [] getAttributeDescriptors()

Description copied from interface: ColorAndFontDescriptorsProvider

Returns the list of descriptors specifying the TextAttributesKey instances for which colors are specified in the page. For such attribute keys, the user can choose all highlighting attributes (font type, background color, foreground color, error stripe color and effects).

Specified by:

getAttributeDescriptors in interface ColorAndFontDescriptorsProvider

Returns:

the list of attribute descriptors.

getColorDescriptors

public ColorDescriptor [] getColorDescriptors()

Description copied from interface: ColorAndFontDescriptorsProvider

Returns the list of descriptors specifying the ColorKey instances for which colors are specified in the page. For such color keys, the user can choose only the background or foreground color.

Specified by:

getColorDescriptors in interface ColorAndFontDescriptorsProvider

Returns:

the list of color descriptors.

getHighlighter

public SyntaxHighlighter getHighlighter()

Description copied from interface: ColorSettingsPage

Returns the syntax highlighter which is used to highlight the text shown in the preview pane of the page.

Specified by:

getHighlighter in interface ColorSettingsPage

Returns:

the syntax highlighter instance.

getDemoText

public java.lang.String getDemoText()

Description copied from interface: ColorSettingsPage

Returns the text shown in the preview pane. If some elements need to be highlighted in the preview text which are not highlighted by the syntax highlighter, they need to be surrounded by XML-like tags, for example: <class>MyClass</class>. The mapping between the names of the tags and the text attribute keys used for highlighting is defined by the ColorSettingsPage.getAdditionalHighlightingTagToDescriptorMap() method.

Specified by:

getDemoText in interface ColorSettingsPage

Returns:

the text to show in the preview pane.

getAdditionalHighlightingTagToDescriptorMap

public java.util.Map<java.lang.String,TextAttributesKey> getAdditionalHighlightingTagToDescriptorMap()

Description copied from interface: ColorSettingsPage

Returns the mapping from special tag names surrounding the regions to be highlighted in the preview text (see ColorSettingsPage.getDemoText()) to text attribute keys used to highlight the regions.

Specified by:

getAdditionalHighlightingTagToDescriptorMap in interface ColorSettingsPage

Returns:

the mapping from tag names to text attribute keys, or null if the demo text does not contain any additional highlighting tags.

getAdditionalHighlightingTagToColorKeyMap

public java.util.Map<java.lang.String,ColorKey> getAdditionalHighlightingTagToColorKeyMap()

Description copied from interface: ColorSettingsPage

Specifies tag-to-'color key' mapping for regions with presentation containing additional colors from color map. It's used to implement navigation between the list of keys and regions in sample editor.

Specified by:

getAdditionalHighlightingTagToColorKeyMap in interface ColorSettingsPage

getPriority

public DisplayPriority getPriority()

Specified by:

getPriority in interface DisplayPrioritySortable

customize

public void customize(EditorEx editor)

Description copied from interface: EditorCustomization

Applies this customization to the given editor. Subclasses should apply their customizations to the editor in this method.

Specified by:

customize in interface EditorCustomization

Parameters:

editor - The editor to customize

getDisplayNameText

public static java.lang.String getDisplayNameText()