Package com.intellij.util.ui.tree

Class PerFileConfigurableBase<T>

java.lang.Object

com.intellij.util.ui.tree.PerFileConfigurableBase<T>

All Implemented Interfaces:

Configurable, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable

Direct Known Subclasses:

TemplateDataLanguageConfigurable

public abstract class PerFileConfigurableBase<T>
extends java.lang.Object
implements SearchableConfigurable, Configurable.NoScroll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	PerFileConfigurableBase.Value<T>

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
protected static Key<java.lang.Boolean>	ADD_PROJECT_MAPPING
protected static Key<java.lang.String>	DESCRIPTION
protected static Key<java.lang.String>	EMPTY_TEXT
protected static Key<java.lang.String>	MAPPING_TITLE
protected PerFileMappings<T>	myMappings
protected Project	myProject
protected static Key<java.lang.String>	NULL_TEXT
protected static Key<java.lang.Boolean>	ONLY_DIRECTORIES
protected static Key<java.lang.String>	OVERRIDE_QUESTION
protected static Key<java.lang.String>	OVERRIDE_TITLE
protected static Key<java.lang.Boolean>	SORT_VALUES
protected static Key<java.lang.String>	TARGET_TITLE

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PerFileConfigurableBase(Project project, PerFileMappings<T> mappings)

Method Summary

Modifier and Type	Method and Description
protected T	adjustChosenValue(java.lang.Object target, T chosen)
void	apply() Stores the settings from the Swing form to the configurable component.
protected boolean	canEditTarget(java.lang.Object target, T value)
protected boolean	canRemoveTarget(java.lang.Object target)
protected ActionGroup	createActionListGroup(java.lang.Object target, Consumer<? super T> onChosen)
protected javax.swing.JPanel	createActionPanel(java.lang.Object target, PerFileConfigurableBase.Value<T> value)
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected javax.swing.JComponent	createDefaultMappingComponent()
protected AnAction	createValueAction(java.lang.Object target, PerFileConfigurableBase.Value<T> value)
protected JBPopup	createValueEditorActionListPopup(java.lang.Object target, java.lang.Runnable onDispose, DataContext dataContext, Consumer<? super T> onChosen)
protected JBPopup	createValueEditorPopup(java.lang.Object target, T value, java.lang.Runnable onDispose, DataContext dataContext, Consumer<? super T> onChosen, java.lang.Runnable onCommit)
protected int[]	findRow(VirtualFile file, boolean strict, boolean all)
protected javax.swing.Icon	getActionListIcon(java.lang.Object target, T t)
protected java.lang.String	getClearValueText(java.lang.Object target)
protected java.util.List<Trinity<java.lang.String,java.util.function.Supplier<T>,Consumer<T>>>	getDefaultMappings()
java.lang.String	getId() Unique configurable id.
T	getNewMapping(VirtualFile file)
protected java.util.Map<VirtualFile,T>	getNewMappings()
protected java.lang.String	getNullValueText(java.lang.Object target)
protected abstract <S> java.lang.Object	getParameter(Key<S> key)
protected java.lang.String	getToolTipFor(T value)
protected java.util.Collection<T>	getValueVariants(java.lang.Object target)
boolean	isModified() Indicates whether the Swing form was modified or not.
protected void	renderDefaultValue(java.lang.Object target, ColoredTextContainer renderer)
protected void	renderTarget(java.lang.Object target, ColoredTextContainer renderer)
protected abstract void	renderValue(java.lang.Object target, T t, ColoredTextContainer renderer)
void	reset() Loads the settings from the configurable component to the Swing form.
void	selectFile(VirtualFile virtualFile)
void	selectFile(VirtualFile virtualFile, boolean addIfMissing)
protected void	selectRows(int[] rows, boolean convertModelRowsToView)

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

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

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

cancel, disposeUIResources

Field Detail

DESCRIPTION

protected static final Key<java.lang.String> DESCRIPTION

TARGET_TITLE

protected static final Key<java.lang.String> TARGET_TITLE

MAPPING_TITLE

protected static final Key<java.lang.String> MAPPING_TITLE

EMPTY_TEXT

protected static final Key<java.lang.String> EMPTY_TEXT

OVERRIDE_QUESTION

protected static final Key<java.lang.String> OVERRIDE_QUESTION

OVERRIDE_TITLE

protected static final Key<java.lang.String> OVERRIDE_TITLE

NULL_TEXT

protected static final Key<java.lang.String> NULL_TEXT

ADD_PROJECT_MAPPING

protected static final Key<java.lang.Boolean> ADD_PROJECT_MAPPING

ONLY_DIRECTORIES

protected static final Key<java.lang.Boolean> ONLY_DIRECTORIES

SORT_VALUES

protected static final Key<java.lang.Boolean> SORT_VALUES

myProject

protected final Project myProject

myMappings

protected final PerFileMappings<T> myMappings

Constructor Detail

PerFileConfigurableBase

protected PerFileConfigurableBase(Project project,
                                  PerFileMappings<T> mappings)

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

getParameter

protected abstract <S> java.lang.Object getParameter(Key<S> key)

getDefaultMappings

protected java.util.List<Trinity<java.lang.String,java.util.function.Supplier<T>,Consumer<T>>> getDefaultMappings()

canRemoveTarget

protected boolean canRemoveTarget(java.lang.Object target)

canEditTarget

protected boolean canEditTarget(java.lang.Object target,
                                T value)

adjustChosenValue

protected T adjustChosenValue(java.lang.Object target,
                              T chosen)

renderValue

protected abstract void renderValue(java.lang.Object target,
                                    T t,
                                    ColoredTextContainer renderer)

renderDefaultValue

protected void renderDefaultValue(java.lang.Object target,
                                  ColoredTextContainer renderer)

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

getToolTipFor

protected java.lang.String getToolTipFor(T value)

createDefaultMappingComponent

protected javax.swing.JComponent createDefaultMappingComponent()

getNewMapping

public T getNewMapping(VirtualFile file)

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

selectRows

protected void selectRows(int[] rows,
                          boolean convertModelRowsToView)

getNewMappings

protected java.util.Map<VirtualFile,T> getNewMappings()

selectFile

public void selectFile(VirtualFile virtualFile)

selectFile

public void selectFile(VirtualFile virtualFile,
                       boolean addIfMissing)

findRow

protected int[] findRow(VirtualFile file,
                        boolean strict,
                        boolean all)

createActionPanel

protected javax.swing.JPanel createActionPanel(java.lang.Object target,
                                               PerFileConfigurableBase.Value<T> value)

renderTarget

protected void renderTarget(java.lang.Object target,
                            ColoredTextContainer renderer)

createValueAction

protected final AnAction createValueAction(java.lang.Object target,
                                           PerFileConfigurableBase.Value<T> value)

createValueEditorPopup

protected JBPopup createValueEditorPopup(java.lang.Object target,
                                         T value,
                                         java.lang.Runnable onDispose,
                                         DataContext dataContext,
                                         Consumer<? super T> onChosen,
                                         java.lang.Runnable onCommit)

createValueEditorActionListPopup

protected final JBPopup createValueEditorActionListPopup(java.lang.Object target,
                                                         java.lang.Runnable onDispose,
                                                         DataContext dataContext,
                                                         Consumer<? super T> onChosen)

getActionListIcon

protected javax.swing.Icon getActionListIcon(java.lang.Object target,
                                             T t)

getClearValueText

protected java.lang.String getClearValueText(java.lang.Object target)

getNullValueText

protected java.lang.String getNullValueText(java.lang.Object target)

getValueVariants

protected java.util.Collection<T> getValueVariants(java.lang.Object target)

createActionListGroup

protected ActionGroup createActionListGroup(java.lang.Object target,
                                            Consumer<? super T> onChosen)