Package com.intellij.openapi.editor

Class GenericLineWrapPositionStrategy

java.lang.Object

com.intellij.openapi.editor.GenericLineWrapPositionStrategy

All Implemented Interfaces:

LineWrapPositionStrategy

Direct Known Subclasses:

DefaultLineWrapPositionStrategy, PyLineWrapPositionStrategy

public class GenericLineWrapPositionStrategy
extends java.lang.Object
implements LineWrapPositionStrategy

Highly customizable LineWrapPositionStrategy implementation.

Not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericLineWrapPositionStrategy.Rule Encapsulates information about rule to use during line wrapping.
static class	GenericLineWrapPositionStrategy.WrapCondition Defines how wrapping may be performed for particular symbol.

Constructor Summary

Constructors

Constructor and Description
GenericLineWrapPositionStrategy()

Method Summary

Modifier and Type	Method and Description
void	addRule(GenericLineWrapPositionStrategy.Rule rule) Registers given rule with the current strategy.
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 boolean	canUseOffset(Document document, int offset, boolean virtual)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericLineWrapPositionStrategy

public GenericLineWrapPositionStrategy()

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

canUseOffset

protected boolean canUseOffset(Document document,
                               int offset,
                               boolean virtual)

addRule

public void addRule(GenericLineWrapPositionStrategy.Rule rule)
             throws java.lang.IllegalArgumentException

Registers given rule with the current strategy.

Parameters:

rule - rule to register

Throws:

java.lang.IllegalArgumentException - if another rule for the same symbol is already registered within the current strategy