Package com.intellij.openapi.editor

Class PsiAwareLineWrapPositionStrategy

java.lang.Object

com.intellij.openapi.editor.PsiAwareLineWrapPositionStrategy

All Implemented Interfaces:

LineWrapPositionStrategy

Direct Known Subclasses:

PsiAwareDefaultLineWrapPositionStrategy

public abstract class PsiAwareLineWrapPositionStrategy
extends java.lang.Object
implements LineWrapPositionStrategy

Base super-class for LineWrapPositionStrategy implementations that want to restrict wrap positions only for particular elements/tokens (e.g. we may want to avoid line wrap in the middle of xml tag name etc).

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_ELEMENT_WRAP
static int	NO_LINE_WRAP

Constructor Summary

Constructors

Constructor and Description
PsiAwareLineWrapPositionStrategy(boolean nonVirtualOnly, IElementType... enabledTypes) Creates new PsiAwareLineWrapPositionStrategy object.

Method Summary

Modifier and Type	Method and Description
int	calculateWrapPosition(Document document, Project project, int startOffset, int endOffset, int maxPreferredOffset, boolean allowToBeyondMaxPreferredOffset, boolean isSoftWrap) Allows to calculate the most appropriate position to wrap target line.
protected abstract int	doCalculateWrapPosition(Document document, Project project, PsiElement element, int startOffset, int endOffset, int maxPreferredOffset, boolean isSoftWrap) Serves for the same purposes as calculateWrapPosition(Document, Project, int, int, int, boolean, boolean) but ensures that given offsets target enabled token/element types.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ELEMENT_WRAP

public static final int NO_ELEMENT_WRAP

See Also:

Constant Field Values

NO_LINE_WRAP

public static final int NO_LINE_WRAP

See Also:

Constant Field Values

Constructor Detail

PsiAwareLineWrapPositionStrategy

public PsiAwareLineWrapPositionStrategy(boolean nonVirtualOnly,
                                        IElementType... enabledTypes)

Creates new PsiAwareLineWrapPositionStrategy object.

Parameters:

nonVirtualOnly - defines if current PSI-aware logic should be exploited only for 'real wrap' position requests

enabledTypes - target element/token types where line wrapping is allowed

Method Detail

calculateWrapPosition

public int calculateWrapPosition(Document document,
                                 Project project,
                                 int startOffset,
                                 int endOffset,
                                 int maxPreferredOffset,
                                 boolean allowToBeyondMaxPreferredOffset,
                                 boolean isSoftWrap)

Description copied from interface: LineWrapPositionStrategy

Allows to calculate the most appropriate position to wrap target line.

Specified by:

calculateWrapPosition in interface LineWrapPositionStrategy

Parameters:

document - target document which text is being processed

project - target project

startOffset - start offset to use with the given text holder (exclusive)

endOffset - end offset to use with the given text holder (exclusive)

maxPreferredOffset - this method is expected to do its best to return offset that belongs to (startOffset; maxPreferredOffset] interval. However, it's allowed to return value from (maxPreferredOffset; endOffset) interval unless 'allowToBeyondMaxPreferredOffset' if 'false'

allowToBeyondMaxPreferredOffset - indicates if it's allowed to return value from (maxPreferredOffset; endOffset] interval in case of inability to find appropriate offset from (startOffset; maxPreferredOffset] interval

isSoftWrap - identifies if current request is for isSoftWrap wrap position

Returns:

offset from (startOffset; endOffset) interval where target line should be wrapped OR -1 if no wrapping should be performed

doCalculateWrapPosition

protected abstract int doCalculateWrapPosition(Document document,
                                               Project project,
                                               PsiElement element,
                                               int startOffset,
                                               int endOffset,
                                               int maxPreferredOffset,
                                               boolean isSoftWrap)

Serves for the same purposes as calculateWrapPosition(Document, Project, int, int, int, boolean, boolean) but ensures that given offsets target enabled token/element types.

Parameters:

document - target document which text is being processed

project - target project

startOffset - start offset to use with the given text holder (inclusive)

endOffset - end offset to use with the given text holder (exclusive)

maxPreferredOffset - this method is expected to do its best to return offset that belongs to (startOffset; maxPreferredOffset] interval. However, it's allowed to return value from (maxPreferredOffset; endOffset] interval unless 'allowToBeyondMaxPreferredOffset' if 'false'

isSoftWrap - identifies if current request is for virtual wrap (soft wrap) position

Returns:

offset from (startOffset; endOffset] interval where target line should be wrapped, NO_ELEMENT_WRAP if no wrapping should be performed within the element OR NO_LINE_WRAP if the entire line wrapping is not allowed.