Package com.intellij.openapi.editor

Interface StripTrailingSpacesFilter

All Known Implementing Classes:

PsiBasedStripTrailingSpacesFilter, SmartStripTrailingSpacesFilter

public interface StripTrailingSpacesFilter

Allows to suppress stripping spaces from some lines or from entire document when the document is being saved and "Settings|Editor|General|Strip trailing spaces on save" option is not "None".

See Also:

StripTrailingSpacesFilterFactory

Field Summary

Fields

Modifier and Type	Field and Description
static StripTrailingSpacesFilter	ALL_LINES The filter which does not put any restrictions on trailing spaces removal.
static StripTrailingSpacesFilter	ENFORCED_REMOVAL Forcibly allows all trailing spaces to be removed regardless of other filters.
static StripTrailingSpacesFilter	NOT_ALLOWED The filter which completely prohibits removing trailing spaces from a document regardless of other filters.
static StripTrailingSpacesFilter	POSTPONED Tells that strip trailing spaces is not currently possible since some conditions are not met for proper document processing.

Method Summary

Modifier and Type	Method and Description
boolean	isStripSpacesAllowedForLine(int line)

Field Detail

NOT_ALLOWED

static final StripTrailingSpacesFilter NOT_ALLOWED

The filter which completely prohibits removing trailing spaces from a document regardless of other filters.

POSTPONED

static final StripTrailingSpacesFilter POSTPONED

Tells that strip trailing spaces is not currently possible since some conditions are not met for proper document processing. The filter will force another attempt to strip trailing spaces later regardless of other filters.

ALL_LINES

static final StripTrailingSpacesFilter ALL_LINES

The filter which does not put any restrictions on trailing spaces removal. Other filters may be taken into account.

ENFORCED_REMOVAL

static final StripTrailingSpacesFilter ENFORCED_REMOVAL

Forcibly allows all trailing spaces to be removed regardless of other filters. The actual removal depends only on provided options.

Method Detail

isStripSpacesAllowedForLine

boolean isStripSpacesAllowedForLine(int line)

Parameters:

line - The document line. Lines are from 0 to Document.getLineCount() - 1 inclusive.

Returns:

True if trailing spaces can be removed from the line, false otherwise.