InspectionToolsConfigurable (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.profile.codeInspection.ui.header.InspectionToolsConfigurable

All Implemented Interfaces:

Configurable, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable, ErrorsConfigurable

Direct Known Subclasses:

CodeInspectionAction.ExternalProfilesComboboxAwareInspectionToolsConfigurable, ProjectInspectionToolsConfigurable
```
public abstract class InspectionToolsConfigurable
extends java.lang.Object
implements ErrorsConfigurable, SearchableConfigurable, Configurable.NoScroll
```

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`	`ID`
`protected BaseInspectionProfileManager`	`myApplicationProfileManager`
`protected ProjectInspectionProfileManager`	`myProjectProfileManager`

Fields inherited from interface com.intellij.openapi.options.Configurable
APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors
Constructor and Description

InspectionToolsConfigurable(ProjectInspectionProfileManager projectProfileManager)

Constructors
Constructor and Description
`InspectionToolsConfigurable(ProjectInspectionProfileManager projectProfileManager)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`acceptTool(InspectionToolWrapper entry)`
`void`	`apply()` Stores the settings from the Swing form to the configurable component.
`protected abstract void`	`applyRootProfile(java.lang.String name, boolean isProjectLevel)`
`javax.swing.JComponent`	`createComponent()` Creates new Swing form that enables user to configure the settings.
`SingleInspectionProfilePanel`	`createPanel(InspectionProfileModifiableModel profile)`
`void`	`disposeUIResources()` Notifies the configurable component that the Swing form will be closed.
`java.lang.Runnable`	`enableSearch(java.lang.String option)`
`protected abstract InspectionProfileImpl`	`getCurrentProfile()`
`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.
`java.lang.String`	`getId()` Unique configurable id.
`static java.lang.String`	`getInspectionsDisplayName()`
`javax.swing.JComponent`	`getPreferredFocusedComponent()`
`InspectionProfileModifiableModel`	`getSelectedObject()`
`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`	`selectInspectionGroup(java.lang.String[] groupPath)`
`void`	`selectInspectionTool(java.lang.String selectedToolShortName)`
`void`	`selectProfile(InspectionProfileImpl profile)`

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
  - ID
```
public static final java.lang.String ID
```
    See Also:
    
    Constant Field Values
  - myApplicationProfileManager
```
protected final BaseInspectionProfileManager myApplicationProfileManager
```
  - myProjectProfileManager
```
protected final ProjectInspectionProfileManager myProjectProfileManager
```
- Constructor Detail
  - InspectionToolsConfigurable
```
public InspectionToolsConfigurable(ProjectInspectionProfileManager projectProfileManager)
```
- Method Detail
  - 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
  - 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
  - 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.
  - 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()
  - getCurrentProfile
```
protected abstract InspectionProfileImpl getCurrentProfile()
```
  - 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()
```
    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
  - applyRootProfile
```
protected abstract void applyRootProfile(java.lang.String name,
                                         boolean isProjectLevel)
```
  - acceptTool
```
protected boolean acceptTool(InspectionToolWrapper entry)
```
  - 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
  - createPanel
```
public SingleInspectionProfilePanel createPanel(InspectionProfileModifiableModel profile)
```
  - 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
  - selectProfile
```
public void selectProfile(InspectionProfileImpl profile)
```
    Specified by:
    
    selectProfile in interface ErrorsConfigurable
  - selectInspectionTool
```
public void selectInspectionTool(java.lang.String selectedToolShortName)
```
    Specified by:
    
    selectInspectionTool in interface ErrorsConfigurable
  - selectInspectionGroup
```
public void selectInspectionGroup(java.lang.String[] groupPath)
```
    Specified by:
    
    selectInspectionGroup in interface ErrorsConfigurable
  - getSelectedObject
```
public InspectionProfileModifiableModel getSelectedObject()
```
    Specified by:
    
    getSelectedObject in interface ErrorsConfigurable
  - 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.
  - getInspectionsDisplayName
```
public static java.lang.String getInspectionsDisplayName()
```

Class InspectionToolsConfigurable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.options.SearchableConfigurable

Nested classes/interfaces inherited from interface com.intellij.openapi.options.Configurable

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

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

Field Detail

ID

myApplicationProfileManager

myProjectProfileManager

Constructor Detail

InspectionToolsConfigurable

Method Detail

getDisplayName

getHelpTopic

getId

enableSearch

createComponent

getCurrentProfile

isModified

apply

applyRootProfile

acceptTool

reset

createPanel

disposeUIResources

selectProfile

selectInspectionTool

selectInspectionGroup

getSelectedObject

getPreferredFocusedComponent

getInspectionsDisplayName