Package com.intellij.application.options

Class CodeStyleGenerationConfigurable

java.lang.Object

com.intellij.application.options.CodeStyleGenerationConfigurable

All Implemented Interfaces:

Configurable, UnnamedConfigurable, CodeStyleConfigurable

public class CodeStyleGenerationConfigurable
extends java.lang.Object
implements CodeStyleConfigurable

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

Constructor Summary

Constructors

Constructor and Description
CodeStyleGenerationConfigurable(CodeStyleSettings settings)

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.
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.
boolean	isModified() Indicates whether the Swing form was modified or not.
boolean	isModified(CodeStyleSettings settings)
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.

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

getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel, disposeUIResources

Constructor Detail

CodeStyleGenerationConfigurable

public CodeStyleGenerationConfigurable(CodeStyleSettings settings)

Method Detail

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

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

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.

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

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.

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

isModified

public boolean isModified(CodeStyleSettings settings)

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