Package com.intellij.application.options

Class CodeStyleAbstractConfigurable

java.lang.Object

com.intellij.application.options.CodeStyleAbstractConfigurable

All Implemented Interfaces:

OptionsContainingConfigurable, Configurable, UnnamedConfigurable, CodeStyleConfigurable

Direct Known Subclasses:

OtherFileTypesCodeStyleConfigurable

public abstract class CodeStyleAbstractConfigurable
extends java.lang.Object
implements CodeStyleConfigurable, OptionsContainingConfigurable

Nested Class Summary

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 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
CodeStyleAbstractConfigurable(CodeStyleSettings settings, CodeStyleSettings cloneSettings, java.lang.String displayName)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
void	apply(CodeStyleSettings settings) Apply the current UI changes to the given settings.
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected abstract CodeStyleAbstractPanel	createPanel(CodeStyleSettings settings)
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
protected CodeStyleSettings	getCurrentSettings()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
CodeStyleAbstractPanel	getPanel()
void	highlightOptions(java.lang.String searchString)
boolean	isModified() Indicates whether the Swing form was modified or not.
void	onSomethingChanged()
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	reset(CodeStyleSettings settings) Reset the UI to the given code style settings.
void	setModel(CodeStyleSchemesModel model)

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

getHelpTopic, getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel

Constructor Detail

CodeStyleAbstractConfigurable

public CodeStyleAbstractConfigurable(CodeStyleSettings settings,
                                     CodeStyleSettings cloneSettings,
                                     java.lang.String displayName)

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

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()

createPanel

protected abstract CodeStyleAbstractPanel createPanel(CodeStyleSettings settings)

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

apply

public void apply(CodeStyleSettings settings)
           throws ConfigurationException

Description copied from interface: CodeStyleConfigurable

Apply the current UI changes to the given settings.

Specified by:

apply in interface CodeStyleConfigurable

Parameters:

settings - The settings to apply the UI changes to.

Throws:

ConfigurationException - If the UI contains incorrect values.

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

reset

public void reset(CodeStyleSettings settings)

Description copied from interface: CodeStyleConfigurable

Reset the UI to the given code style settings.

Specified by:

reset in interface CodeStyleConfigurable

Parameters:

settings - The settings to update the UI from.

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

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

getPanel

public CodeStyleAbstractPanel getPanel()

setModel

public void setModel(CodeStyleSchemesModel model)

onSomethingChanged

public void onSomethingChanged()

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.

getCurrentSettings

protected CodeStyleSettings getCurrentSettings()

highlightOptions

public void highlightOptions(java.lang.String searchString)