Package com.intellij.application.options

Class CodeStyleConfigurableWrapper

java.lang.Object

com.intellij.application.options.CodeStyleConfigurableWrapper

All Implemented Interfaces:

OptionsContainingConfigurable, Configurable, Configurable.NoMargin, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable

public class CodeStyleConfigurableWrapper
extends java.lang.Object
implements SearchableConfigurable, Configurable.NoMargin, Configurable.NoScroll, OptionsContainingConfigurable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected CodeStyleMainPanel	myPanel

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Fields inherited from interface com.intellij.application.options.OptionsContainingConfigurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
CodeStyleConfigurableWrapper(CodeStyleSettingsProvider provider, CodeStyleSettingsPanelFactory factory, CodeStyleSchemesConfigurable owner)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
void	applyPanel()
protected boolean	canBeShared()
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
java.lang.Runnable	enableSearch(java.lang.String option)
static java.lang.String	getConfigurableId(java.lang.String configurableDisplayName)
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
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.lang.Class<?>	getOriginalClass() When building an index of searchable options, it's important to know a class which caused the creation of a configurable.
boolean	isModified() Indicates whether the Swing form was modified or not.
boolean	isPanelModified()
java.util.Set<java.lang.String>	processListOptions()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	processListOptionsWithPaths()
void	reset() Loads the settings from the configurable component to the Swing form.
void	resetPanel()
void	selectTab(java.lang.String tab)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel

Field Detail

myPanel

protected CodeStyleMainPanel myPanel

Constructor Detail

CodeStyleConfigurableWrapper

public CodeStyleConfigurableWrapper(CodeStyleSettingsProvider provider,
                                    CodeStyleSettingsPanelFactory factory,
                                    CodeStyleSchemesConfigurable owner)

Method Detail

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

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

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

Returns:

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

See Also:

UnnamedConfigurable.disposeUIResources()

canBeShared

protected boolean canBeShared()

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

Returns:

true if the settings were modified, false otherwise

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

Throws:

ConfigurationException - if values cannot be applied

resetPanel

public void resetPanel()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

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

getOriginalClass

public java.lang.Class<?> getOriginalClass()

Description copied from interface: SearchableConfigurable

When building an index of searchable options, it's important to know a class which caused the creation of a configurable. It often happens that the configurable is created based on a provider from an arbitrary extension point. In such a case, the provider's class should be returned from this method.
When the configurable is based on several providers consider extending CompositeConfigurable.
Keep in mind that this method can be expensive as it can load previously unloaded class.

Specified by:

getOriginalClass in interface SearchableConfigurable

Returns:

a class which is a cause of the creation of this configurable

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

isPanelModified

public boolean isPanelModified()

applyPanel

public void applyPanel()
                throws ConfigurationException

Throws:

ConfigurationException

processListOptions

public java.util.Set<java.lang.String> processListOptions()

Specified by:

processListOptions in interface OptionsContainingConfigurable

processListOptionsWithPaths

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> processListOptionsWithPaths()

Specified by:

processListOptionsWithPaths in interface OptionsContainingConfigurable

Returns:

A map of paths each having a set of options which belong to it, for e.g. a tab name and options under the tab.

selectTab

public void selectTab(java.lang.String tab)

getConfigurableId

public static java.lang.String getConfigurableId(java.lang.String configurableDisplayName)

enableSearch

public java.lang.Runnable enableSearch(java.lang.String option)

Specified by:

enableSearch in interface SearchableConfigurable

Parameters:

option - setting search query

Returns:

an action to perform when this configurable is opened when a search filter query is entered by the user in setting dialog. This action, for example, can select something in a tree or a list embedded in this setting page that matches the query.