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

Class SoftWrapsStorage

java.lang.Object

com.intellij.openapi.editor.impl.softwrap.SoftWrapsStorage

All Implemented Interfaces:

Dumpable

public class SoftWrapsStorage
extends java.lang.Object
implements Dumpable

Holds registered soft wraps and provides monitoring and management facilities for them.

Not thread-safe.

Constructor Summary

Constructors

Constructor and Description
SoftWrapsStorage()

Method Summary

Modifier and Type	Method and Description
void	addAll(java.util.List<? extends SoftWrapImpl> softWraps) Adds soft wraps to storage.
boolean	addSoftWrapChangeListener(SoftWrapChangeListener listener) Registers given listener within the current model
java.lang.String	dumpState()
int	getNumberOfSoftWrapsInRange(int startOffset, int endOffset) Allows to answer how many soft wraps which start offsets belong to given [start; end] interval are registered withing the current storage.
SoftWrap	getSoftWrap(int offset)
int	getSoftWrapIndex(int offset) Tries to find index of the target soft wrap stored at myWraps collection.
java.util.List<SoftWrapImpl>	getSoftWraps()
boolean	isEmpty()
void	notifyListenersAboutChange()
void	remove(SoftWrapImpl softWrap)
void	removeAll() Removes all soft wraps registered at the current storage.
java.util.List<SoftWrapImpl>	removeStartingFrom(int offset) Removes soft wraps with offsets equal or larger than a given offset from storage.
void	storeOrReplace(SoftWrapImpl softWrap) Inserts given soft wrap to myWraps collection at the given index.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftWrapsStorage

public SoftWrapsStorage()

Method Detail

isEmpty

public boolean isEmpty()

Returns:

true if there is at least one soft wrap registered at the current storage; false otherwise

getSoftWrap

public SoftWrap getSoftWrap(int offset)

getSoftWraps

public java.util.List<SoftWrapImpl> getSoftWraps()

Returns:

view for registered soft wraps sorted by offset in ascending order if any; empty collection otherwise

getSoftWrapIndex

public int getSoftWrapIndex(int offset)

Tries to find index of the target soft wrap stored at myWraps 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 myWraps collection where soft wrap for the given index should be inserted

getNumberOfSoftWrapsInRange

public int getNumberOfSoftWrapsInRange(int startOffset,
                                       int endOffset)

Allows to answer how many soft wraps which start offsets belong to given [start; end] interval are registered withing the current storage.

Parameters:

startOffset - target start offset (inclusive)

endOffset - target end offset (inclusive)

Returns:

number of soft wraps which start offsets belong to the target range

storeOrReplace

public void storeOrReplace(SoftWrapImpl softWrap)

Inserts given soft wrap to myWraps collection at the given index.

Parameters:

softWrap - soft wrap to store

remove

public void remove(SoftWrapImpl softWrap)

removeStartingFrom

public java.util.List<SoftWrapImpl> removeStartingFrom(int offset)

Removes soft wraps with offsets equal or larger than a given offset from storage.

Returns:

soft wraps that were removed, ordered by offset

addAll

public void addAll(java.util.List<? extends SoftWrapImpl> softWraps)

Adds soft wraps to storage. They are supposed to be sorted by their offsets, and have offsets larger than offsets for soft wraps existing in storage at the moment.

removeAll

public void removeAll()

Removes all soft wraps registered at the current storage.

addSoftWrapChangeListener

public 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

notifyListenersAboutChange

public void notifyListenersAboutChange()

dumpState

public java.lang.String dumpState()

Specified by:

dumpState in interface Dumpable