Package com.intellij.openapi.editor.impl

Class SoftWrapModelImpl

java.lang.Object

com.intellij.openapi.editor.InlayModel.SimpleAdapter

com.intellij.openapi.editor.impl.SoftWrapModelImpl

All Implemented Interfaces:

Dumpable, Disposable, DocumentListener, FoldingListener, PrioritizedDocumentListener, SoftWrapModelEx, InlayModel.Listener, SoftWrapModel, java.beans.PropertyChangeListener, java.util.EventListener

public class SoftWrapModelImpl
extends InlayModel.SimpleAdapter
implements SoftWrapModelEx, PrioritizedDocumentListener, FoldingListener, java.beans.PropertyChangeListener, Dumpable, Disposable

Default SoftWrapModelEx implementation.

Works as a mix of GoF Facade and Bridge, i.e. delegates the processing to the target sub-components and provides utility methods built on top of sub-components API.

Not thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from interface com.intellij.openapi.editor.ex.PrioritizedDocumentListener

COMPARATOR

Fields inherited from interface com.intellij.openapi.editor.event.DocumentListener

ARRAY_FACTORY, EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
boolean	addSoftWrapChangeListener(SoftWrapChangeListener listener) Registers given listener within the current model
void	beforeDocumentChange(DocumentEvent event) Called before the text of the document is changed.
void	beforeDocumentChangeAtCaret() Notifies current model that target document is about to be changed at current caret location.
void	dispose() Usually not invoked directly, see class javadoc.
void	documentChanged(DocumentEvent event) Called after the text of the document has been changed.
int	doPaint(java.awt.Graphics g, SoftWrapDrawingType drawingType, int x, int y, int lineHeight)
java.lang.String	dumpState()
void	forceAdditionalColumnsUsage() Allows to instruct current model to return 'true' from SoftWrapModelEx.isRespectAdditionalColumns().
SoftWrapApplianceManager	getApplianceManager()
EditorTextRepresentationHelper	getEditorTextRepresentationHelper()
int	getMinDrawingWidthInPixels(SoftWrapDrawingType drawingType) Allows to ask for the minimal width in pixels required for painting of the given type.
int	getPriority()
java.util.List<? extends SoftWrap>	getRegisteredSoftWraps()
SoftWrap	getSoftWrap(int offset) Asks current model for the soft wrap registered for the given document offset if any.
int	getSoftWrapIndex(int offset) Tries to find index of the target soft wrap at soft wraps collection.
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	isDirty()
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 visual) Allows to answer if given visual position points to soft wrap-introduced virtual space.
boolean	isRespectAdditionalColumns() IJ editor defines a notion of additional columns.
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	onBatchModeFinish(Editor editor)
void	onFoldProcessingEnd() Informs that fold processing is done.
void	onFoldRegionStateChange(FoldRegion region) Informs that 'collapsed' state of given fold region is just changed, or that the given fold region has just been created.
void	onUpdated(Inlay inlay, int changeFlags)
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.
void	prepareToMapping() Encapsulates preparations for performing document dimension mapping (e.g.
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	reinitSettings() Called on editor settings change.
void	release() Callback method to ask soft wrap model to release all resources.
void	setEditorTextRepresentationHelper(EditorTextRepresentationHelper editorTextRepresentationHelper)
void	setSoftWrapPainter(SoftWrapPainter painter)
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.editor.InlayModel.SimpleAdapter

onAdded, onRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.editor.event.DocumentListener

bulkUpdateFinished, bulkUpdateStarting

Methods inherited from interface com.intellij.openapi.editor.ex.FoldingListener

beforeFoldRegionRemoved

Methods inherited from interface com.intellij.openapi.editor.InlayModel.Listener

onBatchModeStart, onUpdated

Method Detail

reinitSettings

public void reinitSettings()

Called on editor settings change. Current model is expected to drop all cached information about the settings if any.

isRespectAdditionalColumns

public boolean isRespectAdditionalColumns()

Description copied from interface: SoftWrapModelEx

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 SoftWrapModelEx.forceAdditionalColumnsUsage() has been invoked previously.

Specified by:

isRespectAdditionalColumns in interface SoftWrapModelEx

forceAdditionalColumnsUsage

public void forceAdditionalColumnsUsage()

Description copied from interface: SoftWrapModelEx

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

Specified by:

forceAdditionalColumnsUsage in interface SoftWrapModelEx

isSoftWrappingEnabled

public boolean isSoftWrappingEnabled()

Description copied from interface: SoftWrapModel

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

Specified by:

isSoftWrappingEnabled in interface SoftWrapModel

Returns:

true if 'soft wraps' are enabled; false otherwise

getSoftWrap

public SoftWrap getSoftWrap(int offset)

Description copied from interface: SoftWrapModel

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

Specified by:

getSoftWrap in interface SoftWrapModel

Parameters:

offset - target document offset

Returns:

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

getSoftWrapIndex

public int getSoftWrapIndex(int offset)

Description copied from interface: SoftWrapModelEx

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.

Specified by:

getSoftWrapIndex in interface SoftWrapModelEx

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

getSoftWrapsForRange

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

Description copied from interface: SoftWrapModel

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

Specified by:

getSoftWrapsForRange in interface SoftWrapModel

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

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

Description copied from interface: SoftWrapModel

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

Specified by:

getSoftWrapsForLine in interface SoftWrapModel

Parameters:

documentLine - target document line

Returns:

all soft wraps registered for the given document line

getRegisteredSoftWraps

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

Specified by:

getRegisteredSoftWraps in interface SoftWrapModelEx

Returns:

unmodifiable collection of soft wraps currently registered within the current model

isVisible

public boolean isVisible(SoftWrap softWrap)

Description copied from interface: SoftWrapModel

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.

Specified by:

isVisible in interface SoftWrapModel

Parameters:

softWrap - soft wrap to check

Returns:

true if given soft wrap is visible; false otherwise

paint

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

Description copied from interface: SoftWrapModelEx

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

Specified by:

paint in interface SoftWrapModelEx

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

doPaint

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

getMinDrawingWidthInPixels

public int getMinDrawingWidthInPixels(SoftWrapDrawingType drawingType)

Description copied from interface: SoftWrapModelEx

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

Specified by:

getMinDrawingWidthInPixels in interface SoftWrapModelEx

Parameters:

drawingType - target drawing type

Returns:

width in pixels required for the painting of the given type

prepareToMapping

public void prepareToMapping()

Encapsulates preparations for performing document dimension mapping (e.g. visual to logical position) and answers if soft wraps-aware processing should be used (e.g. there is no need to consider soft wraps if user configured them not to be used).

isInsideSoftWrap

public boolean isInsideSoftWrap(VisualPosition visual)

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

Specified by:

isInsideSoftWrap in interface SoftWrapModel

Parameters:

visual - target visual position to check

Returns:

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

isInsideOrBeforeSoftWrap

public boolean isInsideOrBeforeSoftWrap(VisualPosition visual)

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

Specified by:

isInsideOrBeforeSoftWrap in interface SoftWrapModel

Parameters:

visual - target visual position to check

Returns:

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

beforeDocumentChangeAtCaret

public void beforeDocumentChangeAtCaret()

Description copied from interface: SoftWrapModel

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.

Specified by:

beforeDocumentChangeAtCaret in interface SoftWrapModel

addSoftWrapChangeListener

public boolean addSoftWrapChangeListener(SoftWrapChangeListener listener)

Description copied from interface: SoftWrapModelEx

Registers given listener within the current model

Specified by:

addSoftWrapChangeListener in interface SoftWrapModelEx

Parameters:

listener - listener to register

Returns:

true if given listener was not registered before; false otherwise

getPriority

public int getPriority()

Specified by:

getPriority in interface PrioritizedDocumentListener

beforeDocumentChange

public void beforeDocumentChange(DocumentEvent event)

Description copied from interface: DocumentListener

Called before the text of the document is changed.

Specified by:

beforeDocumentChange in interface DocumentListener

Parameters:

event - the event containing the information about the change.

documentChanged

public void documentChanged(DocumentEvent event)

Description copied from interface: DocumentListener

Called after the text of the document has been changed.

Specified by:

documentChanged in interface DocumentListener

Parameters:

event - the event containing the information about the change.

onFoldRegionStateChange

public void onFoldRegionStateChange(FoldRegion region)

Description copied from interface: FoldingListener

Informs that 'collapsed' state of given fold region is just changed, or that the given fold region has just been created.

Note: listener should delay fold region state processing until FoldingListener.onFoldProcessingEnd() is called. I.e. folding model may return inconsistent data between current moment and FoldingListener.onFoldProcessingEnd().

Specified by:

onFoldRegionStateChange in interface FoldingListener

Parameters:

region - fold region that is just collapsed or expanded

onFoldProcessingEnd

public void onFoldProcessingEnd()

Description copied from interface: FoldingListener

Informs that fold processing is done.

Specified by:

onFoldProcessingEnd in interface FoldingListener

onUpdated

public void onUpdated(Inlay inlay,
                      int changeFlags)

Specified by:

onUpdated in interface InlayModel.Listener

changeFlags - see InlayModel.ChangeFlags

onBatchModeFinish

public void onBatchModeFinish(Editor editor)

Specified by:

onBatchModeFinish in interface InlayModel.Listener

See Also:

InlayModel.execute(boolean, Runnable)

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

release

public void release()

Description copied from interface: SoftWrapModel

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

Specified by:

release in interface SoftWrapModel

getApplianceManager

public SoftWrapApplianceManager getApplianceManager()

setSoftWrapPainter

public void setSoftWrapPainter(SoftWrapPainter painter)

getEditorTextRepresentationHelper

public EditorTextRepresentationHelper getEditorTextRepresentationHelper()

Specified by:

getEditorTextRepresentationHelper in interface SoftWrapModelEx

setEditorTextRepresentationHelper

public void setEditorTextRepresentationHelper(EditorTextRepresentationHelper editorTextRepresentationHelper)

dumpState

public java.lang.String dumpState()

Specified by:

dumpState in interface Dumpable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isDirty

public boolean isDirty()