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

Class WrapElementIterator

java.lang.Object

com.intellij.openapi.editor.impl.softwrap.WrapElementIterator

Direct Known Subclasses:

WrapElementMeasuringIterator

public class WrapElementIterator
extends java.lang.Object

Iterator over editor's 'atomic' (in terms of soft wrapping) elements. These are folded regions and individual Unicode characters (including the ones represented by surrogate pairs). Line breaks are treated separately as they represent a special interest, they can be represented as one or two (Windows line-ending style) characters.

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	myDocument
protected java.lang.CharSequence	myText

Constructor Summary

Constructors

Constructor and Description
WrapElementIterator(EditorEx editor, int startOffset, int endOffset)

Method Summary

Modifier and Type	Method and Description
void	advance()
boolean	atEnd()
int	getCodePoint()
FoldRegion	getCurrentFold()
int	getElementEndOffset()
int	getElementStartOffset()
int	getFontStyle()
int	getLogicalLine()
boolean	isFoldRegion()
boolean	isLineBreak()
boolean	isWhitespace()
boolean	nextIsFoldRegion()
void	retreat(int offset) Offset should be the one returned previously from getElementStartOffset(), otherwise behaviour is unspecified.

Methods inherited from class java.lang.Object

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

Field Detail

myDocument

protected final Document myDocument

myText

protected final java.lang.CharSequence myText

Constructor Detail

WrapElementIterator

public WrapElementIterator(EditorEx editor,
                           int startOffset,
                           int endOffset)

Method Detail

atEnd

public boolean atEnd()

advance

public void advance()

retreat

public void retreat(int offset)

Offset should be the one returned previously from getElementStartOffset(), otherwise behaviour is unspecified.

getElementStartOffset

public int getElementStartOffset()

getElementEndOffset

public int getElementEndOffset()

isLineBreak

public boolean isLineBreak()

getCurrentFold

public FoldRegion getCurrentFold()

isFoldRegion

public boolean isFoldRegion()

getCodePoint

public int getCodePoint()

isWhitespace

public boolean isWhitespace()

getLogicalLine

public int getLogicalLine()

nextIsFoldRegion

public boolean nextIsFoldRegion()

getFontStyle

public int getFontStyle()