Package com.intellij.openapi.editor

Interface SoftWrapModel

All Known Subinterfaces:

SoftWrapModelEx

All Known Implementing Classes:

SoftWrapModelImpl

public interface SoftWrapModel

Defines contract for the services that bring 'soft wrapping' to the editor.

'Soft wrap' here means representation of the line that exceeds right component viewport margin as if it is wrapped. No changes are introduced to the actual document/file system during that, i.e. it's a pure 'view' facility.

Example:

Raw text (as stored at file system)

     public class Test {                                         | <- right margin
                                                                 |
         public void baz() {                                     |
             foo("test1", "test2", "test3", "test4", "test5", "test6");
         }                                                       |
                                                                 |
         public void foo(Object ... args) {                      |
         }                                                       |
     }                                                           |
      

The same text with soft wraps as shown to end-user at editor

     public class Test {                                         | <- right margin
                                                                 |
         public void baz() {                                     |
             foo("test1", "test2", "test3", "test4", "test5",    |
                 "test6");                                       |
         }                                                       |
                                                                 |
         public void foo(Object ... args) {                      |
         }                                                       |
     }                                                           |
      

Another important soft wrap feature is that as soon as the user starts typing on a line which representation is affected by soft wrap (e.g. starts adding new call argument after "test6" at example above), that soft wraps becomes 'hard wrap', i.e. virtual changes introduced by it are flushed to the underlying document.

Note: soft wrap is assumed to provide as user-friendly indentation for those wrapped line as possible (note that "test6" at example below is aligned to the parameters start).

Implementations of this interface are not obliged to be thread-safe.

Method Summary

Modifier and Type	Method and Description
void	beforeDocumentChangeAtCaret() Notifies current model that target document is about to be changed at current caret location.
SoftWrap	getSoftWrap(int offset) Asks current model for the soft wrap registered for the given document offset if any.
java.util.List<? extends SoftWrap>	getSoftWrapsForLine(int documentLine) Allows to ask current model about all soft wraps registered for the given document line.
java.util.List<? extends SoftWrap>	getSoftWrapsForRange(int start, int end) Allows to ask current model about all soft wraps registered for the given document offsets range.
boolean	isInsideOrBeforeSoftWrap(VisualPosition visual) Allows to answer if given visual position points to soft wrap-introduced virtual space or points just before soft wrap.
boolean	isInsideSoftWrap(VisualPosition position) Allows to answer if given visual position points to soft wrap-introduced virtual space.
boolean	isSoftWrappingEnabled() Allows to answer if 'soft wrap' feature is enabled.
boolean	isVisible(SoftWrap softWrap) Allows to answer if given soft wrap is shown.
void	release() Callback method to ask soft wrap model to release all resources.

Method Detail

isSoftWrappingEnabled

boolean isSoftWrappingEnabled()

Allows to answer if 'soft wrap' feature is enabled.

Returns:

true if 'soft wraps' are enabled; false otherwise

getSoftWrap

SoftWrap getSoftWrap(int offset)

Asks current model for the soft wrap registered for the given document offset if any.

Parameters:

offset - target document offset

Returns:

soft wrap registered for the given offset within the current model if any; null otherwise

getSoftWrapsForRange

java.util.List<? extends SoftWrap> getSoftWrapsForRange(int start,
                                                        int end)

Allows to ask current model about all soft wraps registered for the given document offsets range.

Parameters:

start - start document offset range to use (inclusive)

end - end document offset range to use (inclusive)

Returns:

all soft wraps registered for the target document offsets range

getSoftWrapsForLine

java.util.List<? extends SoftWrap> getSoftWrapsForLine(int documentLine)

Allows to ask current model about all soft wraps registered for the given document line.

Parameters:

documentLine - target document line

Returns:

all soft wraps registered for the given document line

isVisible

boolean isVisible(SoftWrap softWrap)

Allows to answer if given soft wrap is shown.

The soft wrap may be not shown if it's located, for example, inside collapsed folding region.

Parameters:

softWrap - soft wrap to check

Returns:

true if given soft wrap is visible; false otherwise

beforeDocumentChangeAtCaret

void beforeDocumentChangeAtCaret()

Notifies current model that target document is about to be changed at current caret location.

Primary purpose of this method is to perform 'soft wrap' -> 'hard wrap' conversion if the user types in virtual soft wraps-introduced space.

isInsideSoftWrap

boolean isInsideSoftWrap(VisualPosition position)

Allows to answer if given visual position points to soft wrap-introduced virtual space.

Parameters:

position - target visual position to check

Returns:

true if given visual position points to soft wrap-introduced virtual space; false otherwise

isInsideOrBeforeSoftWrap

boolean isInsideOrBeforeSoftWrap(VisualPosition visual)

Allows to answer if given visual position points to soft wrap-introduced virtual space or points just before soft wrap.

Parameters:

visual - target visual position to check

Returns:

true if given visual position points to soft wrap-introduced virtual space; false otherwise

release

void release()

Callback method to ask soft wrap model to release all resources.