Package com.intellij.application.options.schemes

Class AbstractSchemeActions<T extends Scheme>

java.lang.Object

com.intellij.application.options.schemes.AbstractSchemeActions<T>

Type Parameters:

T - The actual scheme type.

Direct Known Subclasses:

ColorSchemeActions, DescriptionAwareSchemeActions, KeymapSchemeManager

public abstract class AbstractSchemeActions<T extends Scheme>
extends java.lang.Object

A standard set of scheme actions: copy, reset, rename, etc. used in SimpleSchemesPanel. More actions can be added via addAdditionalActions(List) method. Available actions depend on SchemesModel. If schemes model supports both IDE and project schemes, copyToIDE(Scheme) and copyToProject(Scheme) must be overridden to do the actual job, default implementation for the methods does nothing.

Import and export actions are available only if there are importer/exporter implementations for the actual scheme type.

See Also:

SimpleSchemesPanel, SchemesModel, SchemeImporter, SchemeExporter

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractSchemesPanel<T,?>	mySchemesPanel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSchemeActions(AbstractSchemesPanel<T,?> schemesPanel)

Method Summary

Modifier and Type	Method and Description
protected void	addAdditionalActions(java.util.List<? super AnAction> defaultActions)
protected void	copyToIDE(T scheme) Copy the scheme to IDE (application).
protected void	copyToProject(T scheme) Copy the scheme to project.
protected abstract void	duplicateScheme(T scheme, java.lang.String newName) Creates a copy of the scheme with a different name.
protected void	exportScheme(Project project, T scheme, java.lang.String exporterName) Export the scheme using the given exporter name.
protected void	exportScheme(T scheme, java.lang.String exporterName) Deprecated. Use exportScheme(Project, Scheme, String) instead.
java.util.Collection<AnAction>	getActions()
protected T	getCurrentScheme()
protected SchemesModel<T>	getModel()
protected java.util.Collection<java.lang.String>	getSchemeImportersNames()
AbstractSchemesPanel<T,?>	getSchemesPanel()
protected abstract java.lang.Class<T>	getSchemeType()
protected void	importScheme(java.lang.String importerName) Import a scheme using the given importer name.
protected abstract void	onSchemeChanged(T scheme) Make necessary configurable updates when another scheme has been selected.
protected abstract void	renameScheme(T scheme, java.lang.String newName) Change scheme's name to the new one.
protected abstract void	resetScheme(T scheme) Reset scheme's settings to their default values (presets).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mySchemesPanel

protected final AbstractSchemesPanel<T extends Scheme,?> mySchemesPanel

Constructor Detail

AbstractSchemeActions

protected AbstractSchemeActions(AbstractSchemesPanel<T,?> schemesPanel)

Method Detail

getSchemeImportersNames

protected java.util.Collection<java.lang.String> getSchemeImportersNames()

getActions

public final java.util.Collection<AnAction> getActions()

addAdditionalActions

protected void addAdditionalActions(java.util.List<? super AnAction> defaultActions)

importScheme

protected void importScheme(java.lang.String importerName)

Import a scheme using the given importer name.

Parameters:

importerName - The importer name.

See Also:

SchemeImporter, SchemeImporterEP

resetScheme

protected abstract void resetScheme(T scheme)

Reset scheme's settings to their default values (presets).

Parameters:

scheme - The scheme to reset.

duplicateScheme

protected abstract void duplicateScheme(T scheme,
                                        java.lang.String newName)

Creates a copy of the scheme with a different name.

Parameters:

scheme - The scheme to copy.

newName - New name.

exportScheme

@Deprecated
protected void exportScheme(T scheme,
                            java.lang.String exporterName)

Deprecated. Use exportScheme(Project, Scheme, String) instead.

exportScheme

protected void exportScheme(Project project,
                            T scheme,
                            java.lang.String exporterName)

Export the scheme using the given exporter name.

Parameters:

scheme - The scheme to export.

exporterName - The exporter name.

See Also:

SchemeExporter, SchemeExporterEP

onSchemeChanged

protected abstract void onSchemeChanged(T scheme)

Make necessary configurable updates when another scheme has been selected.

Parameters:

scheme - The new current scheme.

renameScheme

protected abstract void renameScheme(T scheme,
                                     java.lang.String newName)

Change scheme's name to the new one. Called when a user stops editing by pressing Enter.

Parameters:

scheme - The scheme to rename.

newName - New scheme name.

copyToProject

protected void copyToProject(T scheme)

Copy the scheme to project. The implementation may decide what name to use.

Parameters:

scheme - The scheme to copy.

copyToIDE

protected void copyToIDE(T scheme)

Copy the scheme to IDE (application). The implementation may decide what name to use.

Parameters:

scheme - The scheme to copy.

getModel

protected SchemesModel<T> getModel()

getCurrentScheme

protected final T getCurrentScheme()

getSchemeType

protected abstract java.lang.Class<T> getSchemeType()

Returns:

The actual scheme type.

getSchemesPanel

public final AbstractSchemesPanel<T,?> getSchemesPanel()