Package com.intellij.psi.codeStyle

Class FileIndentOptionsProvider

java.lang.Object

com.intellij.psi.codeStyle.FileIndentOptionsProvider

Direct Known Subclasses:

DetectableIndentOptionsProvider, EditorConfigIndentOptionsProvider

public abstract class FileIndentOptionsProvider
extends java.lang.Object

Provides indent options for a PSI file thus allowing different PSI files having different indentation policies withing the same project. The provider can also offer ad hoc actions to control the current indentation policy without opening settings.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FileIndentOptionsProvider>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
FileIndentOptionsProvider()

Method Summary

Modifier and Type	Method and Description
abstract CommonCodeStyleSettings.IndentOptions	getIndentOptions(CodeStyleSettings settings, PsiFile file) Retrieves indent options for PSI file.
IndentStatusBarUIContributor	getIndentStatusBarUiContributor(CommonCodeStyleSettings.IndentOptions indentOptions)
protected static void	notifyIndentOptionsChanged(Project project, PsiFile file)
boolean	useOnFullReformat() Tells if the provider can be used when a complete file is reformatted.

Methods inherited from class java.lang.Object

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

Field Detail

EP_NAME

public static final ExtensionPointName<FileIndentOptionsProvider> EP_NAME

Constructor Detail

FileIndentOptionsProvider

public FileIndentOptionsProvider()

Method Detail

getIndentOptions

public abstract CommonCodeStyleSettings.IndentOptions getIndentOptions(CodeStyleSettings settings,
                                                                       PsiFile file)

Retrieves indent options for PSI file.

Parameters:

settings - Code style settings for which indent options are calculated.

file - The file to retrieve options for.

Returns:

Indent options or null if the provider can't retrieve them.

useOnFullReformat

public boolean useOnFullReformat()

Tells if the provider can be used when a complete file is reformatted.

Returns:

True by default

notifyIndentOptionsChanged

protected static void notifyIndentOptionsChanged(Project project,
                                                 PsiFile file)

getIndentStatusBarUiContributor

public IndentStatusBarUIContributor getIndentStatusBarUiContributor(CommonCodeStyleSettings.IndentOptions indentOptions)