Package com.intellij.openapi.editor

Class SmartStripTrailingSpacesFilter

java.lang.Object

com.intellij.openapi.editor.SmartStripTrailingSpacesFilter

All Implemented Interfaces:

StripTrailingSpacesFilter

public abstract class SmartStripTrailingSpacesFilter
extends java.lang.Object
implements StripTrailingSpacesFilter

Allows to control how many whitespace characters must be left on any given line if not all of them can be removed.

Field Summary

Fields inherited from interface com.intellij.openapi.editor.StripTrailingSpacesFilter

ALL_LINES, ENFORCED_REMOVAL, NOT_ALLOWED, POSTPONED

Constructor Summary

Constructors

Constructor and Description
SmartStripTrailingSpacesFilter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SmartStripTrailingSpacesFilter

public SmartStripTrailingSpacesFilter()

Method Detail

isStripSpacesAllowedForLine

public final boolean isStripSpacesAllowedForLine(int line)

Specified by:

isStripSpacesAllowedForLine in interface StripTrailingSpacesFilter

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.

getTrailingSpacesToLeave

public abstract int getTrailingSpacesToLeave(int line)

Parameters:

line - The line for which a number of whitespace characters to leave must be calculated.

Returns:

The maximum number of whitespace characters to be left or -1 if the line should be left intact (trailing spaces can not be removed). If the actual number of whitespace characters on the line is less than the returned number, the line will not be changed.