Package com.intellij.application.options

Class CodeStyleAbstractPanel

java.lang.Object

com.intellij.application.options.CodeStyleAbstractPanel

All Implemented Interfaces:

ComponentHighlightingListener, Disposable

Direct Known Subclasses:

ArrangementSettingsPanel, CodeStyleHtmlPanel, CodeStyleImportsPanelWrapper, CodeStyleXmlPanel, CustomizableLanguageCodeStylePanel, GeneralCodeStylePanel, GenerationCodeStylePanel, GrCodeStyleImportsPanelWrapper, OtherFileTypesCodeStyleOptionsForm, PyImportsCodeStylePanel, PyOtherCodeStylePanel, ShCodeStylePanel, TabbedLanguageCodeStylePanel, TabbedLanguageCodeStylePanel.MyIndentOptionsWrapper

public abstract class CodeStyleAbstractPanel
extends java.lang.Object
implements Disposable, ComponentHighlightingListener

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
protected static int[]	ourWrappings

Fields inherited from interface com.intellij.ide.ui.search.ComponentHighlightingListener

TOPIC

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CodeStyleAbstractPanel(CodeStyleSettings settings)
protected	CodeStyleAbstractPanel(Language defaultLanguage, CodeStyleSettings currentSettings, CodeStyleSettings settings)

Method Summary

Modifier and Type	Method and Description
protected void	addPanelToWatch(java.awt.Component component)
abstract void	apply(CodeStyleSettings settings)
void	applyPredefinedSettings(PredefinedCodeStyle codeStyle)
protected PsiFile	createFileFromText(Project project, java.lang.String text) Deprecated. Do not override this method. Use LanguageCodeStyleSettingsProvider.createFileFromText() instead.
protected abstract EditorHighlighter	createHighlighter(EditorColorsScheme scheme)
void	dispose() Usually not invoked directly, see class javadoc.
protected PsiFile	doReformat(Project project, PsiFile psiFile)
protected static void	fillWrappingCombo(javax.swing.JComboBox wrapCombo)
protected CodeStyleSettings	getCurrentSettings()
Language	getDefaultLanguage() Override this method if the panel is linked to a specific language.
protected Editor	getEditor()
protected java.lang.String	getFileExt()
protected abstract FileType	getFileType()
protected java.lang.String	getFileTypeExtension(FileType fileType)
protected static int	getIndexForWrapping(int value)
protected CodeStyleSettings	getModelSettings()
OptionsContainingConfigurable	getOptionIndexer()
abstract javax.swing.JComponent	getPanel()
protected abstract java.lang.String	getPreviewText()
protected abstract int	getRightMargin()
protected CodeStyleSettings	getSettings()
protected java.lang.String	getTabTitle()
void	highlight(javax.swing.JComponent component, java.lang.String searchString)
void	highlightOptions(java.lang.String searchString)
protected void	installPreviewPanel(javax.swing.JPanel previewPanel)
boolean	isCopyFromMenuAvailable() Deprecated.
abstract boolean	isModified(CodeStyleSettings settings)
void	onSomethingChanged() This method is called on any UI changes (controls altered or initialized, preview updated, etc.).
protected void	prepareForReformat(PsiFile psiFile)
java.util.Set<java.lang.String>	processListOptions()
static java.lang.String	readFromFile(java.lang.Class resourceContainerClass, java.lang.String fileName)
void	reset(CodeStyleSettings settings)
protected abstract void	resetImpl(CodeStyleSettings settings)
protected void	setEditorText(java.lang.String text, boolean updateHighlighter)
void	setModel(CodeStyleSchemesModel model)
protected void	setShouldUpdatePreview(boolean shouldUpdatePreview)
void	setupCopyFromMenu(javax.swing.JPopupMenu copyMenu)
protected void	somethingChanged()
protected void	updatePreview(boolean useDefaultSample)

Methods inherited from class java.lang.Object

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

Field Detail

ourWrappings

protected static final int[] ourWrappings

Constructor Detail

CodeStyleAbstractPanel

protected CodeStyleAbstractPanel(CodeStyleSettings settings)

CodeStyleAbstractPanel

protected CodeStyleAbstractPanel(Language defaultLanguage,
                                 CodeStyleSettings currentSettings,
                                 CodeStyleSettings settings)

Method Detail

setShouldUpdatePreview

protected void setShouldUpdatePreview(boolean shouldUpdatePreview)

setModel

public void setModel(CodeStyleSchemesModel model)

somethingChanged

protected void somethingChanged()

addPanelToWatch

protected void addPanelToWatch(java.awt.Component component)

updatePreview

protected void updatePreview(boolean useDefaultSample)

setEditorText

protected void setEditorText(java.lang.String text,
                             boolean updateHighlighter)

getRightMargin

protected abstract int getRightMargin()

prepareForReformat

protected void prepareForReformat(PsiFile psiFile)

getFileExt

protected java.lang.String getFileExt()

createFileFromText

@Deprecated
protected PsiFile createFileFromText(Project project,
                                     java.lang.String text)

Deprecated. Do not override this method. Use LanguageCodeStyleSettingsProvider.createFileFromText() instead.

See Also:

LanguageCodeStyleSettingsProvider.createFileFromText(Project, String)

doReformat

protected PsiFile doReformat(Project project,
                             PsiFile psiFile)

createHighlighter

protected abstract EditorHighlighter createHighlighter(EditorColorsScheme scheme)

getFileType

protected abstract FileType getFileType()

getPreviewText

protected abstract java.lang.String getPreviewText()

apply

public abstract void apply(CodeStyleSettings settings)
                    throws ConfigurationException

Throws:

ConfigurationException

reset

public final void reset(CodeStyleSettings settings)

getIndexForWrapping

protected static int getIndexForWrapping(int value)

isModified

public abstract boolean isModified(CodeStyleSettings settings)

getPanel

public abstract javax.swing.JComponent getPanel()

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

resetImpl

protected abstract void resetImpl(CodeStyleSettings settings)

fillWrappingCombo

protected static void fillWrappingCombo(javax.swing.JComboBox wrapCombo)

readFromFile

public static java.lang.String readFromFile(java.lang.Class resourceContainerClass,
                                            java.lang.String fileName)

installPreviewPanel

protected void installPreviewPanel(javax.swing.JPanel previewPanel)

getFileTypeExtension

protected java.lang.String getFileTypeExtension(FileType fileType)

onSomethingChanged

public void onSomethingChanged()

This method is called on any UI changes (controls altered or initialized, preview updated, etc.). Implementors are expected to update their UI state if needed, keeping models intact.

getEditor

protected Editor getEditor()

getSettings

protected CodeStyleSettings getSettings()

processListOptions

public java.util.Set<java.lang.String> processListOptions()

getOptionIndexer

public OptionsContainingConfigurable getOptionIndexer()

applyPredefinedSettings

public final void applyPredefinedSettings(PredefinedCodeStyle codeStyle)

getDefaultLanguage

public Language getDefaultLanguage()

Override this method if the panel is linked to a specific language.

Returns:

The language this panel is associated with.

getTabTitle

protected java.lang.String getTabTitle()

getCurrentSettings

protected CodeStyleSettings getCurrentSettings()

getModelSettings

protected CodeStyleSettings getModelSettings()

setupCopyFromMenu

public void setupCopyFromMenu(javax.swing.JPopupMenu copyMenu)

isCopyFromMenuAvailable

@Deprecated
public boolean isCopyFromMenuAvailable()

Deprecated.

highlight

public final void highlight(javax.swing.JComponent component,
                            java.lang.String searchString)

Specified by:

highlight in interface ComponentHighlightingListener

highlightOptions

public void highlightOptions(java.lang.String searchString)