Package com.intellij.openapi.options

Interface SearchableConfigurable

All Superinterfaces:

Configurable, UnnamedConfigurable

All Known Subinterfaces:

EditorOptionsProvider, SearchableConfigurable.Parent

All Known Implementing Classes:

AbstractExternalSystemConfigurable, AllFileTemplatesConfigurable, AnnotationProcessorsConfigurable, AppEditorFontConfigurable, ArtifactsStructureConfigurable, AutoImportOptionsConfigurable, BaseLibrariesConfigurable, BaseStructureConfigurable, BrowserSettings, BuildoutModulesConfigurable, CaptureConfigurable, CertificateConfigurable, ChangelistConflictConfigurable, CodeCompletionOptions, CodeFoldingConfigurable, CodeInspectionAction.ExternalProfilesComboboxAwareInspectionToolsConfigurable, CodeStyleConfigurableWrapper, CodeStyleGroupProvider.CodeStyleGroupConfigurable, CodeStyleSchemesConfigurable, ColorAndFontOptions, CommitDialogConfigurable, CompilerConfigurable, CompilerUIConfigurable, ConfigurableBase, ConfigurableWrapper, ConsentConfigurable, ConsoleConfigurable, CopyrightFormattingConfigurable, CopyrightProjectConfigurable, CoverageOptionsConfigurable, CustomizationConfigurable, DateTimeFormatConfigurable, DebuggerConfigurable, DebuggerDataViewsConfigurable, EmmetCompositeConfigurable, ExternalDependenciesConfigurable, ExternalDiffSettingsConfigurable, FacetStructureConfigurable, FileAssociationsConfigurable, FileColorsConfigurable, FileStatusColorsConfigurable, FileTypeConfigurable, GantConfigurable, GlobalLibrariesConfigurable, GradleConfigurable, GroovyCompilerConfigurable, GuiDesignerConfigurable, GutterIconsConfigurable, HgProjectConfigurable, HttpProxyConfigurable, ImagesConfigurable, InjectionsSettingsUI, InspectionToolsConfigurable, IntentionSettingsConfigurable, IssueNavigationConfigurationPanel, JavaCompilersTab, JavaFxSettingsConfigurable, JdkListConfigurable, JsonSchemaMappingsConfigurable, JsonSmartKeysConfigurable, KeymapPanel, LiveTemplatesConfigurable, MarkdownSettingsConfigurable, ModuleAwareProjectConfigurable, ModuleStructureConfigurable, NotificationsConfigurable, PathMacroConfigurable, PerFileConfigurableBase, PluginManagerConfigurable, PluginManagerConfigurableProxy, PostfixTemplatesConfigurable, ProjectInspectionToolsConfigurable, ProjectLibrariesConfigurable, ProjectStructureConfigurable, PyActiveSdkModuleConfigurable, PyConsoleOptionsConfigurable, PyContentEntriesModuleConfigurable, PyDebuggerConfigurable, PyDependenciesConfigurable, PyIntegratedToolsConfigurable, PyIntegratedToolsModulesConfigurable, PySmartKeysOptions, PythonContentEntriesConfigurable, PythonDocumentationConfigurable, QuickListsPanel, RemoteRepositoriesConfigurable, RemoteServerListConfigurable, RestConfigurable, RmicConfigurable, ScopeChooserConfigurable, SdkHomeConfigurable, SearchableConfigurable.Delegate, SearchableConfigurable.Parent.Abstract, ShelfProjectConfigurable, SimpleConfigurable, SortedConfigurableGroup, SpellCheckerSettingsManager, SvnConfigurable, SvnConfigurable.General, SvnConfigurable.Network, SvnConfigurable.Presentation, SvnConfigurable.Ssh, TaskConfigurable, TaskRepositoriesConfigurable, TemplateCommentPanel, TemplateDataLanguageConfigurable, TerminalOptionsConfigurable, TodoConfigurable, ToolConfigurable, UpdateSettingsConfigurable, ValidationConfigurable, VcsBackgroundOperationsConfigurable, VcsGeneralConfigurationConfigurable, VcsManagerConfigurable, XmlEmmetConfigurable, XPathConfigurable

public interface SearchableConfigurable
extends Configurable

SearchableConfigurable instances would be instantiated on buildSearchableOptions step during Installer's build to index of all available options. TraverseUIStarter

See Also:

SearchableOptionContributor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SearchableConfigurable.Delegate Intended to use some search utility methods with any configurable.
static interface	SearchableConfigurable.Merged
static interface	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 inherited from interface com.intellij.openapi.options.Configurable

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Method Summary

Modifier and Type	Method and Description
default java.lang.Runnable	enableSearch(java.lang.String option)
java.lang.String	getId() Unique configurable id.
default java.lang.Class<?>	getOriginalClass() When building an index of searchable options, it's important to know a class which caused the creation of a configurable.

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

getDisplayName, getHelpTopic, getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

apply, cancel, createComponent, disposeUIResources, isModified, reset

Method Detail

getId

java.lang.String getId()

Unique configurable id. Note this id should be THE SAME as the one specified in XML.

See Also:

ConfigurableEP.id

enableSearch

default java.lang.Runnable enableSearch(java.lang.String option)

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.

getOriginalClass

default java.lang.Class<?> getOriginalClass()

When building an index of searchable options, it's important to know a class which caused the creation of a configurable. It often happens that the configurable is created based on a provider from an arbitrary extension point. In such a case, the provider's class should be returned from this method.
When the configurable is based on several providers consider extending CompositeConfigurable.
Keep in mind that this method can be expensive as it can load previously unloaded class.

Returns:

a class which is a cause of the creation of this configurable