Package com.intellij.ide.plugins

Class PluginManagerConfigurable

java.lang.Object

com.intellij.ide.plugins.PluginManagerConfigurable

All Implemented Interfaces:

Configurable, Configurable.NoMargin, Configurable.NoScroll, Configurable.TopComponentProvider, SearchableConfigurable, UnnamedConfigurable

Direct Known Subclasses:

PluginManagerConfigurableProxy

public class PluginManagerConfigurable
extends java.lang.Object
implements SearchableConfigurable, Configurable.NoScroll, Configurable.NoMargin, Configurable.TopComponentProvider

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.text.SimpleDateFormat	DATE_FORMAT
static java.lang.String	ID
static int	ITEMS_PER_GROUP
static java.awt.Color	MAIN_BG_COLOR
static java.awt.Color	SEARCH_BG_COLOR
static java.awt.Color	SEARCH_FIELD_BORDER_COLOR
static java.lang.String	SELECTION_TAB_KEY

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Constructor and Description
PluginManagerConfigurable()
PluginManagerConfigurable(PluginManagerUISettings uiSettings) Deprecated. use PluginManagerConfigurable

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
void	cancel() Called when 'Cancel' is pressed in the Settings dialog.
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
static javax.swing.JComponent	createScrollPane(PluginsGroupComponent panel, boolean initSelection)
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
java.lang.Runnable	enableSearch(java.lang.String option)
java.awt.Component	getCenterComponent(Configurable.TopComponentController controller)
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
static java.lang.String	getDownloads(IdeaPluginDescriptor plugin)
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.
static java.lang.String	getLastUpdatedDate(IdeaPluginDescriptor plugin)
MyPluginModel	getPluginModel()
static java.lang.String	getRating(IdeaPluginDescriptor plugin)
static java.lang.String	getSize(IdeaPluginDescriptor plugin)
static java.util.List<java.lang.String>	getTags(IdeaPluginDescriptor plugin)
static java.lang.String	getVersion(IdeaPluginDescriptor oldPlugin, IdeaPluginDescriptor newPlugin)
boolean	isModified() Indicates whether the Swing form was modified or not.
static int	offset5()
static void	registerCopyProvider(PluginsGroupComponent component)
void	reset() Loads the settings from the configurable component to the Swing form.
void	select(IdeaPluginDescriptor... descriptors)
void	setInitUpdates(java.util.Collection<PluginDownloader> initUpdates)
static <T extends java.awt.Component> T	setTinyFont(T component)
static void	showPluginConfigurable(Project project, java.util.Collection<PluginDownloader> updates)
static void	showPluginConfigurable(Project project, IdeaPluginDescriptor... descriptors)
static void	showPluginConfigurableAndEnable(Project project, IdeaPluginDescriptor... descriptors)
static int	showRestartDialog()
static int	showRestartDialog(java.lang.String title)
static int	showRestartDialog(java.lang.String title, java.util.function.Function<java.lang.String,java.lang.String> message)
static void	shutdownOrRestartApp()
static void	shutdownOrRestartApp(java.lang.String title)
static void	shutdownOrRestartAppAfterInstall(java.lang.String plugin)

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

getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

isAvailable

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

SELECTION_TAB_KEY

public static final java.lang.String SELECTION_TAB_KEY

See Also:

Constant Field Values

MAIN_BG_COLOR

public static final java.awt.Color MAIN_BG_COLOR

SEARCH_BG_COLOR

public static final java.awt.Color SEARCH_BG_COLOR

SEARCH_FIELD_BORDER_COLOR

public static final java.awt.Color SEARCH_FIELD_BORDER_COLOR

ITEMS_PER_GROUP

public static final int ITEMS_PER_GROUP

See Also:

Constant Field Values

DATE_FORMAT

public static final java.text.SimpleDateFormat DATE_FORMAT

Constructor Detail

PluginManagerConfigurable

public PluginManagerConfigurable()

PluginManagerConfigurable

@Deprecated
public PluginManagerConfigurable(PluginManagerUISettings uiSettings)

Deprecated. use PluginManagerConfigurable

Method Detail

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

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

getCenterComponent

public java.awt.Component getCenterComponent(Configurable.TopComponentController controller)

Specified by:

getCenterComponent in interface Configurable.TopComponentProvider

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

registerCopyProvider

public static void registerCopyProvider(PluginsGroupComponent component)

getTags

public static java.util.List<java.lang.String> getTags(IdeaPluginDescriptor plugin)

setTinyFont

public static <T extends java.awt.Component> T setTinyFont(T component)

offset5

public static int offset5()

getDownloads

public static java.lang.String getDownloads(IdeaPluginDescriptor plugin)

getLastUpdatedDate

public static java.lang.String getLastUpdatedDate(IdeaPluginDescriptor plugin)

getRating

public static java.lang.String getRating(IdeaPluginDescriptor plugin)

getSize

public static java.lang.String getSize(IdeaPluginDescriptor plugin)

getVersion

public static java.lang.String getVersion(IdeaPluginDescriptor oldPlugin,
                                          IdeaPluginDescriptor newPlugin)

showRestartDialog

public static int showRestartDialog()

showRestartDialog

public static int showRestartDialog(java.lang.String title)

showRestartDialog

public static int showRestartDialog(java.lang.String title,
                                    java.util.function.Function<java.lang.String,java.lang.String> message)

shutdownOrRestartApp

public static void shutdownOrRestartApp()

shutdownOrRestartApp

public static void shutdownOrRestartApp(java.lang.String title)

shutdownOrRestartAppAfterInstall

public static void shutdownOrRestartAppAfterInstall(java.lang.String plugin)

showPluginConfigurableAndEnable

public static void showPluginConfigurableAndEnable(Project project,
                                                   IdeaPluginDescriptor... descriptors)

showPluginConfigurable

public static void showPluginConfigurable(Project project,
                                          IdeaPluginDescriptor... descriptors)

showPluginConfigurable

public static void showPluginConfigurable(Project project,
                                          java.util.Collection<PluginDownloader> updates)

createScrollPane

public static javax.swing.JComponent createScrollPane(PluginsGroupComponent panel,
                                                      boolean initSelection)

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

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

cancel

public void cancel()

Description copied from interface: UnnamedConfigurable

Called when 'Cancel' is pressed in the Settings dialog.

Specified by:

cancel in interface UnnamedConfigurable

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

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

getPluginModel

public MyPluginModel getPluginModel()

setInitUpdates

public void setInitUpdates(java.util.Collection<PluginDownloader> initUpdates)

select

public void select(IdeaPluginDescriptor... descriptors)

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.