Package com.intellij.codeInsight.intention.impl.config

Class IntentionSettingsConfigurable

java.lang.Object

com.intellij.codeInsight.intention.impl.config.IntentionSettingsConfigurable

All Implemented Interfaces:

IntentionsConfigurable, Configurable, MasterDetails, SearchableConfigurable, UnnamedConfigurable

public class IntentionSettingsConfigurable
extends java.lang.Object
implements SearchableConfigurable, MasterDetails, IntentionsConfigurable

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
static java.lang.String	HELP_ID

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Constructor and Description
IntentionSettingsConfigurable()

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
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)
DetailsComponent	getDetails()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
static java.lang.String	getDisplayNameText()
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.
javax.swing.JComponent	getMaster()
javax.swing.JComponent	getPreferredFocusedComponent()
javax.swing.JComponent	getToolbar()
void	initUi()
boolean	isModified() Indicates whether the Swing form was modified or not.
void	reset() Loads the settings from the configurable component to the Swing form.
void	selectIntention(java.lang.String familyName)

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

getOriginalClass

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

isModified, isModified, isModified, isModified

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

cancel

Field Detail

HELP_ID

public static final java.lang.String HELP_ID

See Also:

Constant Field Values

Constructor Detail

IntentionSettingsConfigurable

public IntentionSettingsConfigurable()

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

initUi

public void initUi()

Specified by:

initUi in interface MasterDetails

getToolbar

public javax.swing.JComponent getToolbar()

Specified by:

getToolbar in interface MasterDetails

getMaster

public javax.swing.JComponent getMaster()

Specified by:

getMaster in interface MasterDetails

getDetails

public DetailsComponent getDetails()

Specified by:

getDetails in interface MasterDetails

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Specified by:

getPreferredFocusedComponent in interface Configurable

Returns:

component which should be focused when the dialog appears on the screen.

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

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

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

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

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

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

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.

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

selectIntention

public void selectIntention(java.lang.String familyName)

Specified by:

selectIntention in interface IntentionsConfigurable

getDisplayNameText

public static java.lang.String getDisplayNameText()