Package com.intellij.application.options.colors

Class ColorAndFontOptions

java.lang.Object

com.intellij.openapi.options.SearchableConfigurable.Parent.Abstract

com.intellij.application.options.colors.ColorAndFontOptions

All Implemented Interfaces:

EditorOptionsProvider, SchemesModel<EditorColorsScheme>, Configurable, Configurable.Composite, Configurable.WithEpDependencies, SearchableConfigurable, SearchableConfigurable.Parent, UnnamedConfigurable

public class ColorAndFontOptions
extends SearchableConfigurable.Parent.Abstract
implements EditorOptionsProvider, SchemesModel<EditorColorsScheme>, Configurable.WithEpDependencies

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.options.SearchableConfigurable

SearchableConfigurable.Delegate, SearchableConfigurable.Merged, SearchableConfigurable.Parent

Nested classes/interfaces inherited from interface com.intellij.openapi.options.Configurable

Configurable.Composite, Configurable.NoMargin, Configurable.NoScroll, Configurable.TopComponentController, Configurable.TopComponentProvider, Configurable.VariableProjectAppLevel, Configurable.WithEpDependencies

Nested classes/interfaces inherited from interface com.intellij.openapi.options.SearchableConfigurable.Parent

SearchableConfigurable.Parent.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID
static java.lang.String	SCOPES_GROUP Deprecated. Use getScopesGroup() instead

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Constructor and Description
ColorAndFontOptions()

Method Summary

Modifier and Type	Method and Description
void	addImportedScheme(EditorColorsScheme imported)
void	addListener(ColorAndFontSettingsListener listener)
void	apply() Stores the settings from the Swing form to the configurable component.
Configurable []	buildConfigurables()
static boolean	canBeDeleted(EditorColorsScheme scheme)
boolean	canDeleteScheme(EditorColorsScheme scheme)
boolean	canDuplicateScheme(EditorColorsScheme scheme)
boolean	canRenameScheme(EditorColorsScheme scheme)
boolean	canResetScheme(EditorColorsScheme scheme)
boolean	containsScheme(java.lang.String name, boolean projectScheme)
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected java.util.List<ColorAndFontPanelFactory>	createPanelFactories()
boolean	differsFromDefault(EditorColorsScheme scheme)
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
NewColorAndFontPanel	findPage(java.lang.String pageName)
SearchableConfigurable	findSubConfigurable(java.lang.Class pageClass)
SearchableConfigurable	findSubConfigurable(java.lang.String pageName)
EditorSchemeAttributeDescriptor[]	getCurrentDescriptions()
java.util.Collection<BaseExtensionPointName<?>>	getDependencies()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
static java.lang.String	getFontConfigurableName()
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
java.lang.String	getId() Unique configurable id.
java.util.Collection<EditorColorsScheme>	getOrderedSchemes()
java.util.Collection<EditorColorsScheme>	getSchemes()
static java.lang.String	getScopesGroup()
EditorColorsScheme	getSelectedScheme()
boolean	hasOwnContent()
boolean	isModified() Indicates whether the Swing form was modified or not.
boolean	isProjectScheme(EditorColorsScheme scheme)
static boolean	isReadOnly(EditorColorsScheme scheme)
void	removeScheme(EditorColorsScheme scheme)
void	reset() Loads the settings from the configurable component to the Swing form.
void	resetFromChild()
boolean	saveSchemeAs(EditorColorsScheme editorScheme, java.lang.String name)
static boolean	selectOrEditColor(DataContext context, java.lang.String search, java.lang.Class<?> type) Shows a requested page to edit a color settings.
static boolean	selectOrEditColor(DataContext context, java.lang.String search, java.lang.String name) Shows a requested page to edit a color settings.
EditorColorsScheme	selectScheme(java.lang.String name)
void	stateChanged()
static void	writeTempScheme(EditorColorsScheme colorsScheme)
static void	writeTempScheme(Element scheme, EditorColorsScheme parentScheme)

Methods inherited from class com.intellij.openapi.options.SearchableConfigurable.Parent.Abstract

getConfigurables

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.SearchableConfigurable

enableSearch, getOriginalClass

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

getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel

Methods inherited from interface com.intellij.openapi.options.SearchableConfigurable.Parent

isVisible

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

SCOPES_GROUP

@Deprecated
public static final java.lang.String SCOPES_GROUP

Deprecated. Use getScopesGroup() instead

See Also:

Constant Field Values

Constructor Detail

ColorAndFontOptions

public ColorAndFontOptions()

Method Detail

addListener

public void addListener(ColorAndFontSettingsListener listener)

stateChanged

public void stateChanged()

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: Configurable

Returns the visible name of the configurable component. Note, that this method must return the display name that is equal to the display name declared in XML to avoid unexpected errors.

Specified by:

getDisplayName in interface Configurable

Returns:

the visible name of the configurable component

isModified

public boolean isModified()

Description copied from interface: UnnamedConfigurable

Indicates whether the Swing form was modified or not. This method is called very often, so it should not take a long time.

Specified by:

isModified in interface UnnamedConfigurable

Overrides:

isModified in class SearchableConfigurable.Parent.Abstract

Returns:

true if the settings were modified, false otherwise

selectScheme

public EditorColorsScheme selectScheme(java.lang.String name)

getSelectedScheme

public EditorColorsScheme getSelectedScheme()

getCurrentDescriptions

public EditorSchemeAttributeDescriptor[] getCurrentDescriptions()

canDuplicateScheme

public boolean canDuplicateScheme(EditorColorsScheme scheme)

Specified by:

canDuplicateScheme in interface SchemesModel<EditorColorsScheme>

Parameters:

scheme - The scheme to check.

Returns:

True if the scheme can be duplicated with a different name.

canResetScheme

public boolean canResetScheme(EditorColorsScheme scheme)

Specified by:

canResetScheme in interface SchemesModel<EditorColorsScheme>

Parameters:

scheme - The scheme to check.

Returns:

True if the scheme can be reset from default values (presets) in principle regardless of whether scheme settings actually differ from presets or not.

See Also:

SchemesModel.differsFromDefault(Scheme)

canDeleteScheme

public boolean canDeleteScheme(EditorColorsScheme scheme)

Specified by:

canDeleteScheme in interface SchemesModel<EditorColorsScheme>

Parameters:

scheme - The scheme to check.

Returns:

True if the scheme can be deleted, normally applies to custom schemes created by a user.

isProjectScheme

public boolean isProjectScheme(EditorColorsScheme scheme)

Specified by:

isProjectScheme in interface SchemesModel<EditorColorsScheme>

Parameters:

scheme - The scheme to check.

Returns:

True if the given scheme is a project one. Always false if project schemes are not supported.

canRenameScheme

public boolean canRenameScheme(EditorColorsScheme scheme)

Specified by:

canRenameScheme in interface SchemesModel<EditorColorsScheme>

Parameters:

scheme - The scheme to check.

Returns:

True if scheme's name can be edited.

containsScheme

public boolean containsScheme(java.lang.String name,
                              boolean projectScheme)

Specified by:

containsScheme in interface SchemesModel<EditorColorsScheme>

Parameters:

name - The scheme to check.

projectScheme - Level of the scheme to check. If schemes model does not support project level schemes then the parameter is always equal to false.

Returns:

True if a scheme by the given name already exists.

differsFromDefault

public boolean differsFromDefault(EditorColorsScheme scheme)

Specified by:

differsFromDefault in interface SchemesModel<EditorColorsScheme>

Parameters:

scheme - The scheme to check.

Returns:

True if scheme's settings differ from default values (presets). The method is called only if SchemesModel.canResetScheme(Scheme) returns true.

getDependencies

public java.util.Collection<BaseExtensionPointName<?>> getDependencies()

Specified by:

getDependencies in interface Configurable.WithEpDependencies

Returns:

EPName-s that affect the configurable

isReadOnly

public static boolean isReadOnly(EditorColorsScheme scheme)

canBeDeleted

public static boolean canBeDeleted(EditorColorsScheme scheme)

getOrderedSchemes

public java.util.Collection<EditorColorsScheme> getOrderedSchemes()

getSchemes

public java.util.Collection<EditorColorsScheme> getSchemes()

saveSchemeAs

public boolean saveSchemeAs(EditorColorsScheme editorScheme,
                            java.lang.String name)

addImportedScheme

public void addImportedScheme(EditorColorsScheme imported)

removeScheme

public void removeScheme(EditorColorsScheme scheme)

Specified by:

removeScheme in interface SchemesModel<EditorColorsScheme>

apply

public void apply()
           throws ConfigurationException

Description copied from interface: UnnamedConfigurable

Stores the settings from the Swing form to the configurable component. This method is called on EDT upon user's request.

Specified by:

apply in interface UnnamedConfigurable

Overrides:

apply in class SearchableConfigurable.Parent.Abstract

Throws:

ConfigurationException - if values cannot be applied

createComponent

public javax.swing.JComponent createComponent()

Description copied from interface: UnnamedConfigurable

Creates new Swing form that enables user to configure the settings. Usually this method is called on the EDT, so it should not take a long time.

Also this place is designed to allocate resources (subscriptions/listeners etc.)

Specified by:

createComponent in interface UnnamedConfigurable

Overrides:

createComponent in class SearchableConfigurable.Parent.Abstract

Returns:

new Swing form to show, or null if it cannot be created

See Also:

UnnamedConfigurable.disposeUIResources()

hasOwnContent

public boolean hasOwnContent()

Specified by:

hasOwnContent in interface SearchableConfigurable.Parent

buildConfigurables

public Configurable [] buildConfigurables()

Specified by:

buildConfigurables in class SearchableConfigurable.Parent.Abstract

createPanelFactories

protected java.util.List<ColorAndFontPanelFactory> createPanelFactories()

getFontConfigurableName

public static java.lang.String getFontConfigurableName()

reset

public void reset()

Description copied from interface: UnnamedConfigurable

Loads the settings from the configurable component to the Swing form. This method is called on EDT immediately after the form creation or later upon user's request.

Specified by:

reset in interface UnnamedConfigurable

resetFromChild

public void resetFromChild()

disposeUIResources

public void disposeUIResources()

Description copied from interface: UnnamedConfigurable

Notifies the configurable component that the Swing form will be closed. This method should dispose all resources associated with the component.

Specified by:

disposeUIResources in interface UnnamedConfigurable

Overrides:

disposeUIResources in class SearchableConfigurable.Parent.Abstract

getHelpTopic

public java.lang.String getHelpTopic()

Description copied from interface: Configurable

Returns the topic in the help file which is shown when help for the configurable is requested.

Specified by:

getHelpTopic in interface Configurable

Returns:

the help topic, or null if no help is available

writeTempScheme

public static void writeTempScheme(EditorColorsScheme colorsScheme)

writeTempScheme

public static void writeTempScheme(Element scheme,
                                   EditorColorsScheme parentScheme)

getId

public java.lang.String getId()

Description copied from interface: SearchableConfigurable

Unique configurable id. Note this id should be THE SAME as the one specified in XML.

Specified by:

getId in interface SearchableConfigurable

See Also:

ConfigurableEP.id

findSubConfigurable

public SearchableConfigurable findSubConfigurable(java.lang.Class pageClass)

findSubConfigurable

public SearchableConfigurable findSubConfigurable(java.lang.String pageName)

findPage

public NewColorAndFontPanel findPage(java.lang.String pageName)

selectOrEditColor

public static boolean selectOrEditColor(DataContext context,
                                        java.lang.String search,
                                        java.lang.String name)

Shows a requested page to edit a color settings. If current data context represents a setting dialog that can open a requested page, it will be opened. Otherwise, the new dialog will be opened. The simplest way to get a data context is

DataManager.getInstance().getDataContext(myComponent)

where is myComponent is a JComponent in a Swing hierarchy. A specific color can be requested by the search text.

Parameters:

context - a data context to find Settings or a parent for dialog

search - a text to find on the found page

name - a name of a page to find via findSubConfigurable(String)

Returns:

true if a color was shown to edit, false if a requested page does not exist

selectOrEditColor

public static boolean selectOrEditColor(DataContext context,
                                        java.lang.String search,
                                        java.lang.Class<?> type)

Shows a requested page to edit a color settings. If current data context represents a setting dialog that can open a requested page, it will be opened. Otherwise, the new dialog will be opened. The simplest way to get a data context is

DataManager.getInstance().getDataContext(myComponent)

where is myComponent is a JComponent in a Swing hierarchy. A specific color can be requested by the search text.

Parameters:

context - a data context to find Settings or a parent for dialog

search - a text to find on the found page

type - a type of a page to find via findSubConfigurable(Class)

Returns:

true if a color was shown to edit, false if a requested page does not exist

getScopesGroup

public static java.lang.String getScopesGroup()