Package com.intellij.openapi.editor

Class StripTrailingSpacesFilterFactory

java.lang.Object

com.intellij.openapi.editor.StripTrailingSpacesFilterFactory

Direct Known Subclasses:

EditorConfigTrailingSpacesFilterFactory, KeepTrailingSpacesOnEmptyLinesFilterFactory, MarkdownStripTrailingSpacesFilterFactory, PsiBasedStripTrailingSpacesFilter.Factory

public abstract class StripTrailingSpacesFilterFactory
extends java.lang.Object

Allows adding restrictions on how trailing spaces will be handled in a document.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<StripTrailingSpacesFilterFactory>	EXTENSION_POINT

Constructor Summary

Constructors

Constructor and Description
StripTrailingSpacesFilterFactory()

Method Summary

Modifier and Type	Method and Description
abstract StripTrailingSpacesFilter	createFilter(Project project, Document document) Creates a filter which may restrict trailing spaces removal.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_POINT

public static final ExtensionPointName<StripTrailingSpacesFilterFactory> EXTENSION_POINT

Constructor Detail

StripTrailingSpacesFilterFactory

public StripTrailingSpacesFilterFactory()

Method Detail

createFilter

public abstract StripTrailingSpacesFilter createFilter(Project project,
                                                       Document document)

Creates a filter which may restrict trailing spaces removal.

Parameters:

project - The current project or null if there is no project context.

document - The document to be processed.

Returns:

The filter which will be called on document save. The factory may return one of the several predefined filters:

• StripTrailingSpacesFilter.NOT_ALLOWED No stripping allowed. The IDE will not try to strip any whitespace at all in this case.
• StripTrailingSpacesFilter.POSTPONED The stripping is not possible at the moment. For example, the caret is in the way and the "Settings|General|Editor|Allow caret after end of the line" is off. In this case, the IDE will try to restart the stripping later.
• StripTrailingSpacesFilter.ALL_LINES Allow stripping with no restrictions. Return this value by default.