Package com.intellij.execution.impl

Class SingleConfigurationConfigurable<Config extends RunConfiguration>

java.lang.Object

com.intellij.openapi.options.BaseConfigurable

com.intellij.openapi.options.SettingsEditorConfigurable<RunnerAndConfigurationSettings>

com.intellij.execution.impl.SingleConfigurationConfigurable<Config>

All Implemented Interfaces:

Configurable, UnnamedConfigurable

public final class SingleConfigurationConfigurable<Config extends RunConfiguration>
extends SettingsEditorConfigurable<RunnerAndConfigurationSettings>

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

Modifier and Type	Field and Description
static DataKey<java.lang.String>	RUN_ON_TARGET_NAME_KEY

Fields inherited from class com.intellij.openapi.options.BaseConfigurable

myModified

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Method Summary

Modifier and Type	Method and Description
void	addNameListener(javax.swing.event.DocumentListener listener)
void	addSharedListener(java.awt.event.ActionListener listener)
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.
RunnerAndConfigurationSettings	createSnapshot(boolean cloneBeforeRunTasks)
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
static <Config extends RunConfiguration> SingleConfigurationConfigurable<Config>	editSettings(RunnerAndConfigurationSettings settings, Executor executor)
Config	getConfiguration()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
java.lang.String	getFolderName()
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
java.lang.String	getNameText()
javax.swing.JTextField	getNameTextField()
boolean	isModified() Indicates whether the Swing form was modified or not.
boolean	isStoredInFile()
boolean	isValid()
void	reset() Loads the settings from the configurable component to the Swing form.
void	setFolderName(java.lang.String folderName)
void	setNameText(java.lang.String name)
java.lang.String	toString()
protected static JBScrollPane	wrapWithScrollPane(javax.swing.JComponent component)

Methods inherited from class com.intellij.openapi.options.SettingsEditorConfigurable

getEditor, getSettings

Methods inherited from class com.intellij.openapi.options.BaseConfigurable

getPreferredFocusedComponent, setModified

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

isModified, isModified, isModified, isModified

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

cancel

Field Detail

RUN_ON_TARGET_NAME_KEY

public static final DataKey<java.lang.String> RUN_ON_TARGET_NAME_KEY

Method Detail

editSettings

public static <Config extends RunConfiguration> SingleConfigurationConfigurable<Config> editSettings(RunnerAndConfigurationSettings settings,
                                                                                                     Executor executor)

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 SettingsEditorConfigurable<RunnerAndConfigurationSettings>

Throws:

ConfigurationException - if values cannot be applied

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

Overrides:

reset in class SettingsEditorConfigurable<RunnerAndConfigurationSettings>

createComponent

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

isStoredInFile

public boolean isStoredInFile()

disposeUIResources

public final 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 SettingsEditorConfigurable<RunnerAndConfigurationSettings>

getNameText

public final java.lang.String getNameText()

addNameListener

public final void addNameListener(javax.swing.event.DocumentListener listener)

addSharedListener

public final void addSharedListener(java.awt.event.ActionListener listener)

setNameText

public final void setNameText(java.lang.String name)

isValid

public final boolean isValid()

getNameTextField

public final javax.swing.JTextField getNameTextField()

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.

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.

Returns:

the help topic, or null if no help is available

getConfiguration

public Config getConfiguration()

createSnapshot

public RunnerAndConfigurationSettings createSnapshot(boolean cloneBeforeRunTasks)
                                              throws ConfigurationException

Throws:

ConfigurationException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setFolderName

public void setFolderName(java.lang.String folderName)

getFolderName

public java.lang.String getFolderName()

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 BaseConfigurable

Returns:

true if the settings were modified, false otherwise

wrapWithScrollPane

protected static JBScrollPane wrapWithScrollPane(javax.swing.JComponent component)