Package com.intellij.formatting

Class FormatConstants

java.lang.Object

com.intellij.formatting.FormatConstants

public class FormatConstants
extends java.lang.Object

Is assumed to be a single place to hold various constants to use during formatting.

Thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESERVED_LINE_WRAP_WIDTH_IN_COLUMNS It may be necessary to wrap a long line sometimes (during formatting, when typing reaches right margin etc).

Method Summary

Modifier and Type	Method and Description
static int	getReservedLineWrapWidthInColumns(Editor editor)

Methods inherited from class java.lang.Object

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

Field Detail

RESERVED_LINE_WRAP_WIDTH_IN_COLUMNS

public static final int RESERVED_LINE_WRAP_WIDTH_IN_COLUMNS

It may be necessary to wrap a long line sometimes (during formatting, when typing reaches right margin etc). We should take into consideration possibility that additional symbols are inserted during that.

For example consider that we want to wrap long string literal:

                                |
                                | <- right margin
     "this is a long string to w|rap"
                                |
 

We can't just wrap before 'w' symbol of 'wrap' word because we can get the following situation then:

                                |
                                | <- right margin
     "this is a long string to "| + // Notice that '" +' string is inserted at the wrapped line
        "wrap"                  |
 

Hence, we need to reserve particular number of columns.

This constant is assumed to hold language-agnostic number of columns to reserve on smart line wrapping.

See Also:

Constant Field Values

Method Detail

getReservedLineWrapWidthInColumns

public static int getReservedLineWrapWidthInColumns(Editor editor)