Package com.intellij.openapi.editor

Class PsiAwareDefaultLineWrapPositionStrategy

java.lang.Object

com.intellij.openapi.editor.PsiAwareLineWrapPositionStrategy

com.intellij.openapi.editor.PsiAwareDefaultLineWrapPositionStrategy

All Implemented Interfaces:

LineWrapPositionStrategy

Direct Known Subclasses:

JavaLineWrapPositionStrategy, MarkupLineWrapPositionStrategy

public class PsiAwareDefaultLineWrapPositionStrategy
extends PsiAwareLineWrapPositionStrategy

LineWrapPositionStrategy implementation that uses default line wrap strategy but restricts its scope by target tokens/elements.

Field Summary

Fields inherited from class com.intellij.openapi.editor.PsiAwareLineWrapPositionStrategy

NO_ELEMENT_WRAP, NO_LINE_WRAP

Constructor Summary

Constructors

Constructor and Description
PsiAwareDefaultLineWrapPositionStrategy(boolean nonVirtualOnly, IElementType... enabledTypes)

Method Summary

Modifier and Type	Method and Description
protected int	doCalculateWrapPosition(Document document, Project project, PsiElement element, int startOffset, int endOffset, int maxPreferredOffset, boolean isSoftWrap) Serves for the same purposes as PsiAwareLineWrapPositionStrategy.calculateWrapPosition(Document, Project, int, int, int, boolean, boolean) but ensures that given offsets target enabled token/element types.

Methods inherited from class com.intellij.openapi.editor.PsiAwareLineWrapPositionStrategy

calculateWrapPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

PsiAwareDefaultLineWrapPositionStrategy

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

Method Detail

doCalculateWrapPosition

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

Description copied from class: PsiAwareLineWrapPositionStrategy

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

Specified by:

doCalculateWrapPosition in class PsiAwareLineWrapPositionStrategy

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, PsiAwareLineWrapPositionStrategy.NO_ELEMENT_WRAP if no wrapping should be performed within the element OR PsiAwareLineWrapPositionStrategy.NO_LINE_WRAP if the entire line wrapping is not allowed.