ProjectStructureConfigurable (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.openapi.roots.ui.configuration.ProjectStructureConfigurable

All Implemented Interfaces:: Configurable, Configurable.NoMargin, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable, Place.Navigator

public class ProjectStructureConfigurable
extends java.lang.Object
implements SearchableConfigurable, Place.Navigator, Configurable.NoMargin, Configurable.NoScroll

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProjectStructureConfigurable.UIState
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProjectStructureConfigurable.UIState`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CATEGORY`
`static DataKey<ProjectStructureConfigurable>`	`KEY`
`protected ProjectStructureConfigurable.UIState`	`myUiState`

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

Constructor Summary

Constructors
Constructor and Description

ProjectStructureConfigurable(Project project)

Constructors
Constructor and Description
`ProjectStructureConfigurable(Project project)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply()` Stores the settings from the Swing form to the configurable component.
`Place`	`createArtifactPlace(Artifact artifact)`
`javax.swing.JComponent`	`createComponent()` Creates new Swing form that enables user to configure the settings.
`Place`	`createModulePlace(Module module)`
`Place`	`createModulesPlace()`
`Place`	`createProjectConfigurablePlace()`
`Place`	`createProjectOrGlobalLibraryPlace(Library library)`
`void`	`disposeUIResources()` Notifies the configurable component that the Swing form will be closed.
`ArtifactsStructureConfigurable`	`getArtifactsStructureConfigurable()`
`BaseLibrariesConfigurable`	`getConfigurableFor(Library library)`
`StructureConfigurableContext`	`getContext()`
`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.
`History`	`getHistory()`
`java.lang.String`	`getId()` Unique configurable id.
`static ProjectStructureConfigurable`	`getInstance(Project project)`
`JdkListConfigurable`	`getJdkConfig()`
`ModuleStructureConfigurable`	`getModulesConfig()`
`javax.swing.JComponent`	`getPreferredFocusedComponent()`
`ProjectConfigurable`	`getProjectConfig()`
`ProjectSdksModel`	`getProjectJdksModel()`
`boolean`	`isModified()` Indicates whether the Swing form was modified or not.
`boolean`	`isUiInitialized()`
`ActionCallback`	`navigateTo(Place place, boolean requestFocus)`
`void`	`queryPlace(Place place)`
`void`	`registerObsoleteLibraryRoots(java.util.Collection<? extends VirtualFile> roots)`
`void`	`reset()` Loads the settings from the configurable component to the Swing form.
`ActionCallback`	`select(Artifact artifact, boolean requestFocus)`
`ActionCallback`	`select(Facet facetToSelect, boolean requestFocus)`
`ActionCallback`	`select(LibraryOrderEntry libraryOrderEntry, boolean requestFocus)`
`ActionCallback`	`select(Sdk sdk, boolean requestFocus)`
`ActionCallback`	`select(java.lang.String moduleToSelect, java.lang.String editorNameToSelect, boolean requestFocus)`
`ActionCallback`	`selectGlobalLibraries(boolean requestFocus)`
`ActionCallback`	`selectOrderEntry(Module module, OrderEntry orderEntry)`
`ActionCallback`	`selectProjectGeneralSettings(boolean requestFocus)`
`ActionCallback`	`selectProjectOrGlobalLibrary(Library library, boolean requestFocus)`
`void`	`setHistory(History history)`

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
enableSearch, 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
  - KEY
```
public static final DataKey<ProjectStructureConfigurable> KEY
```
  - myUiState
```
protected final ProjectStructureConfigurable.UIState myUiState
```
  - CATEGORY
```
public static final java.lang.String CATEGORY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProjectStructureConfigurable
```
public ProjectStructureConfigurable(Project project)
```
- 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
  - 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
  - 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()
  - getArtifactsStructureConfigurable
```
public ArtifactsStructureConfigurable getArtifactsStructureConfigurable()
```
  - 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
  - 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
  - isUiInitialized
```
public boolean isUiInitialized()
```
  - getHistory
```
public History getHistory()
```
  - setHistory
```
public void setHistory(History history)
```
    Specified by:
    
    setHistory in interface Place.Navigator
  - queryPlace
```
public void queryPlace(Place place)
```
    Specified by:
    
    queryPlace in interface Place.Navigator
  - selectProjectGeneralSettings
```
public ActionCallback selectProjectGeneralSettings(boolean requestFocus)
```
  - createProjectConfigurablePlace
```
public Place createProjectConfigurablePlace()
```
  - select
```
public ActionCallback select(java.lang.String moduleToSelect,
                             java.lang.String editorNameToSelect,
                             boolean requestFocus)
```
  - createModulesPlace
```
public Place createModulesPlace()
```
  - createModulePlace
```
public Place createModulePlace(Module module)
```
  - select
```
public ActionCallback select(Facet facetToSelect,
                             boolean requestFocus)
```
  - select
```
public ActionCallback select(Sdk sdk,
                             boolean requestFocus)
```
  - selectGlobalLibraries
```
public ActionCallback selectGlobalLibraries(boolean requestFocus)
```
  - selectProjectOrGlobalLibrary
```
public ActionCallback selectProjectOrGlobalLibrary(Library library,
                                                   boolean requestFocus)
```
  - createProjectOrGlobalLibraryPlace
```
public Place createProjectOrGlobalLibraryPlace(Library library)
```
  - select
```
public ActionCallback select(Artifact artifact,
                             boolean requestFocus)
```
  - createArtifactPlace
```
public Place createArtifactPlace(Artifact artifact)
```
  - select
```
public ActionCallback select(LibraryOrderEntry libraryOrderEntry,
                             boolean requestFocus)
```
  - selectOrderEntry
```
public ActionCallback selectOrderEntry(Module module,
                                       OrderEntry orderEntry)
```
  - navigateTo
```
public ActionCallback navigateTo(Place place,
                                 boolean requestFocus)
```
    Specified by:
    
    navigateTo in interface Place.Navigator
  - getInstance
```
public static ProjectStructureConfigurable getInstance(Project project)
```
  - getProjectJdksModel
```
public ProjectSdksModel getProjectJdksModel()
```
  - getJdkConfig
```
public JdkListConfigurable getJdkConfig()
```
  - getModulesConfig
```
public ModuleStructureConfigurable getModulesConfig()
```
  - getProjectConfig
```
public ProjectConfigurable getProjectConfig()
```
  - registerObsoleteLibraryRoots
```
public void registerObsoleteLibraryRoots(java.util.Collection<? extends VirtualFile> roots)
```
  - getContext
```
public StructureConfigurableContext getContext()
```
  - getConfigurableFor
```
public BaseLibrariesConfigurable getConfigurableFor(Library library)
```
  - 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.

Class ProjectStructureConfigurable

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

KEY

myUiState

CATEGORY

Constructor Detail

ProjectStructureConfigurable

Method Detail

getId

getDisplayName

getHelpTopic

createComponent

getArtifactsStructureConfigurable

isModified

apply

reset

disposeUIResources

isUiInitialized

getHistory

setHistory

queryPlace

selectProjectGeneralSettings

createProjectConfigurablePlace

select

createModulesPlace

createModulePlace

select

select

selectGlobalLibraries

selectProjectOrGlobalLibrary

createProjectOrGlobalLibraryPlace

select

createArtifactPlace

select

selectOrderEntry

navigateTo

getInstance

getProjectJdksModel

getJdkConfig

getModulesConfig

getProjectConfig

registerObsoleteLibraryRoots

getContext

getConfigurableFor

getPreferredFocusedComponent