Package com.intellij.openapi.editor

Interface LineWrapPositionStrategy

All Known Implementing Classes:

DefaultLineWrapPositionStrategy, GenericLineWrapPositionStrategy, JavaLineWrapPositionStrategy, JsonLineWrapPositionStrategy, MarkupLineWrapPositionStrategy, PsiAwareDefaultLineWrapPositionStrategy, PsiAwareLineWrapPositionStrategy, PyLineWrapPositionStrategy

public interface LineWrapPositionStrategy

Defines contract for the strategy that calculates the best place to apply wrap to particular line (sequence of characters).

One possible use case for such functionality is a situation when user opens document with lines that are wider that editor's visible area. We can represent such long strings in multiple visual line then and need to know the best place to insert such virtual wrap.

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.

Method Detail

calculateWrapPosition

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.

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