Package com.intellij.openapi.editor.ex

Interface SoftWrapModelEx

All Superinterfaces:

SoftWrapModel

All Known Implementing Classes:

SoftWrapModelImpl

public interface SoftWrapModelEx
extends SoftWrapModel

Extends SoftWrapModel in order to define implementation-specific contract.

Method Summary

Modifier and Type	Method and Description
boolean	addSoftWrapChangeListener(SoftWrapChangeListener listener) Registers given listener within the current model
void	forceAdditionalColumnsUsage() Allows to instruct current model to return 'true' from isRespectAdditionalColumns().
EditorTextRepresentationHelper	getEditorTextRepresentationHelper() Deprecated. To be removed in version 2021.1
int	getMinDrawingWidthInPixels(SoftWrapDrawingType drawingType) Allows to ask for the minimal width in pixels required for painting of the given type.
java.util.List<? extends SoftWrap>	getRegisteredSoftWraps()
int	getSoftWrapIndex(int offset) Tries to find index of the target soft wrap at soft wraps collection.
boolean	isRespectAdditionalColumns() IJ editor defines a notion of additional columns.
int	paint(java.awt.Graphics g, SoftWrapDrawingType drawingType, int x, int y, int lineHeight) Asks to paint drawing of target type at the given graphics buffer at the given position.

Methods inherited from interface com.intellij.openapi.editor.SoftWrapModel

beforeDocumentChangeAtCaret, getSoftWrap, getSoftWrapsForLine, getSoftWrapsForRange, isInsideOrBeforeSoftWrap, isInsideSoftWrap, isSoftWrappingEnabled, isVisible, release

Method Detail

getRegisteredSoftWraps

java.util.List<? extends SoftWrap> getRegisteredSoftWraps()

Returns:

unmodifiable collection of soft wraps currently registered within the current model

getSoftWrapIndex

int getSoftWrapIndex(int offset)

Tries to find index of the target soft wrap at soft wraps collection. 'Target' soft wrap is the one that starts at the given offset.

Parameters:

offset - target offset

Returns:

index that conforms to Collections.binarySearch(List, Object) contract, i.e. non-negative returned index points to soft wrap that starts at the given offset; '-(negative value) - 1' points to position at soft wraps collection where soft wrap for the given index should be inserted

paint

int paint(java.awt.Graphics g,
          SoftWrapDrawingType drawingType,
          int x,
          int y,
          int lineHeight)

Asks to paint drawing of target type at the given graphics buffer at the given position.

Parameters:

g - target graphics buffer to draw in

drawingType - target drawing type

x - target 'x' coordinate to use

y - target 'y' coordinate to use

lineHeight - line height used at editor

Returns:

painted drawing width

getMinDrawingWidthInPixels

int getMinDrawingWidthInPixels(SoftWrapDrawingType drawingType)

Allows to ask for the minimal width in pixels required for painting of the given type.

Parameters:

drawingType - target drawing type

Returns:

width in pixels required for the painting of the given type

addSoftWrapChangeListener

boolean addSoftWrapChangeListener(SoftWrapChangeListener listener)

Registers given listener within the current model

Parameters:

listener - listener to register

Returns:

true if given listener was not registered before; false otherwise

isRespectAdditionalColumns

boolean isRespectAdditionalColumns()

IJ editor defines a notion of additional columns. They define additional amount of space to be used during editor component's width calculation (IJ editor perform 'preventive UI component expansion' when user types near the right edge).

The main idea of soft wraps is to avoid horizontal scrolling, so, when soft wrapping is enabled and succeeds (so that resulting text layout fits view area's width), additional columns wont be added to the preferred editor width. This method answers whether the above behaviour should be overridden, and additional columns setting should be respected regardless of soft wrapping success. This happens when forceAdditionalColumnsUsage() has been invoked previously.

forceAdditionalColumnsUsage

void forceAdditionalColumnsUsage()

Allows to instruct current model to return 'true' from isRespectAdditionalColumns().

getEditorTextRepresentationHelper

@Deprecated
EditorTextRepresentationHelper getEditorTextRepresentationHelper()

Deprecated. To be removed in version 2021.1