Package com.intellij.openapi.editor

Interface LineNumberConverter

All Known Subinterfaces:

LineNumberConverter.Increasing

All Known Implementing Classes:

LineNumberConverterAdapter

public interface LineNumberConverter

Defines a mapping between document line number and the numbers displayed in gutter.

See Also:

EditorGutter.setLineNumberConverter(LineNumberConverter, LineNumberConverter), LineNumberConverter.Increasing

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LineNumberConverter.Increasing Specialization of LineNumberConverter whose convert(Editor, int) method always produces monotonically increasing numbers.

Field Summary

Fields

Modifier and Type	Field and Description
static LineNumberConverter	DEFAULT

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	convert(Editor editor, int lineNumber) Defines the number to be displayed in gutter for the given document line.
java.lang.Integer	getMaxLineNumber(Editor editor) Number which should be used to calculate width of line number area in gutter.

Field Detail

DEFAULT

static final LineNumberConverter DEFAULT

Method Detail

convert

java.lang.Integer convert(Editor editor,
                          int lineNumber)

Defines the number to be displayed in gutter for the given document line.

Parameters:

lineNumber - one-based line number

Returns:

number to be displayed in gutter, null means no number is displayed

getMaxLineNumber

java.lang.Integer getMaxLineNumber(Editor editor)

Number which should be used to calculate width of line number area in gutter. This should be the largest number which will be displayed. null means no width will be allocated to the line number area.