Package com.intellij.openapi.editor.impl.softwrap.mapping

Class SoftWrapApplianceManager

java.lang.Object

com.intellij.openapi.editor.impl.softwrap.mapping.SoftWrapApplianceManager

All Implemented Interfaces:

Dumpable

public class SoftWrapApplianceManager
extends java.lang.Object
implements Dumpable

The general idea of soft wraps processing is to build a cache to use for quick document dimensions mapping ('logical position -> visual position', 'offset -> logical position' etc) and update it incrementally on events like document modification fold region(s) expanding/collapsing etc.

This class encapsulates document parsing logic. It notifies registered listeners about parsing and they are free to store necessary information for further usage.

Not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SoftWrapApplianceManager.VisibleAreaWidthProvider This interface is introduced mostly for encapsulating GUI-specific values retrieval and make it possible to write tests for soft wraps processing.

Constructor Summary

Constructors

Constructor and Description
SoftWrapApplianceManager(SoftWrapsStorage storage, EditorImpl editor, SoftWrapPainter painter, CachingSoftWrapDataMapper dataMapper)

Method Summary

Modifier and Type	Method and Description
boolean	addListener(com.intellij.openapi.editor.impl.softwrap.mapping.SoftWrapAwareDocumentParsingListener listener) Registers given listener within the current manager.
void	beforeDocumentChange(DocumentEvent event)
void	documentChanged(DocumentEvent event, boolean processAlsoLineEnd)
java.lang.String	dumpState()
void	recalculate(java.util.List<? extends Segment> ranges)
boolean	recalculateIfNecessary() There is a possible case that we need to reparse the whole document (e.g.
void	registerSoftWrapIfNecessary()
boolean	removeListener(com.intellij.openapi.editor.impl.softwrap.mapping.SoftWrapAwareDocumentParsingListener listener)
void	reset()
void	setSoftWrapPainter(SoftWrapPainter painter)
void	setWidthProvider(SoftWrapApplianceManager.VisibleAreaWidthProvider widthProvider)
java.lang.String	toString()
void	updateAvailableArea()

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftWrapApplianceManager

public SoftWrapApplianceManager(SoftWrapsStorage storage,
                                EditorImpl editor,
                                SoftWrapPainter painter,
                                CachingSoftWrapDataMapper dataMapper)

Method Detail

registerSoftWrapIfNecessary

public void registerSoftWrapIfNecessary()

reset

public void reset()

recalculate

public void recalculate(java.util.List<? extends Segment> ranges)

recalculateIfNecessary

public boolean recalculateIfNecessary()

There is a possible case that we need to reparse the whole document (e.g. visible area width is changed or user-defined soft wrap indent is changed etc). This method encapsulates that logic, i.e. it checks if necessary conditions are satisfied and updates internal state as necessary.

Returns:

true if re-calculation logic was performed; false otherwise (e.g. we need to perform re-calculation but current editor is now shown, i.e. we don't have information about viewport width

addListener

public boolean addListener(com.intellij.openapi.editor.impl.softwrap.mapping.SoftWrapAwareDocumentParsingListener listener)

Registers given listener within the current manager.

Parameters:

listener - listener to register

Returns:

true if this collection changed as a result of the call; false otherwise

removeListener

public boolean removeListener(com.intellij.openapi.editor.impl.softwrap.mapping.SoftWrapAwareDocumentParsingListener listener)

beforeDocumentChange

public void beforeDocumentChange(DocumentEvent event)

documentChanged

public void documentChanged(DocumentEvent event,
                            boolean processAlsoLineEnd)

setWidthProvider

public void setWidthProvider(SoftWrapApplianceManager.VisibleAreaWidthProvider widthProvider)

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

setSoftWrapPainter

public void setSoftWrapPainter(SoftWrapPainter painter)

updateAvailableArea

public void updateAvailableArea()