org.eclipse.jface.text
Interface ITextViewerExtension3

All Known Implementing Classes:

ProjectionSourceViewer

public interface ITextViewerExtension3

Extension interface for ITextViewer. Extends ITextViewer with the explicit concept of model and widget coordinates. For example, a selection returned by the text viewer's control is a widget selection. A widget selection always maps to a certain range of the viewer's document. This range is considered the model selection.

This general concepts replaces the notion of visible region.

Since:

2.1

Method Summary

IRegion	getModelCoverage() Returns the minimal region of the viewer's document that completely comprises everything that is visible in the viewer's widget.
int	modelLine2WidgetLine(int modelLine) Returns the widget line that corresponds to the given line of the viewer's document or -1 if there is no such line.
int	modelOffset2WidgetOffset(int modelOffset) Returns the widget offset that corresponds to the given offset in the viewer's document or -1 if there is no such offset
IRegion	modelRange2WidgetRange(IRegion modelRange) Returns the minimal region of the viewer's widget that completely comprises the given region of the viewer's document or null if there is no such region.
int	widgetLineOfWidgetOffset(int widgetOffset) Returns the widget line of the given widget offset.
int	widgetlLine2ModelLine(int widgetLine) Returns the line of the viewer's document that corresponds to the given widget line or -1 if there is no such line.
int	widgetOffset2ModelOffset(int widgetOffset) Returns the offset of the viewer's document that corresponds to the given widget offset or -1 if there is no such offset
IRegion	widgetRange2ModelRange(IRegion widgetRange) Returns the minimal region of the viewer's document that completely comprises the given widget region or null if there is no such region.

Method Detail

getModelCoverage

public IRegion getModelCoverage()

Returns the minimal region of the viewer's document that completely comprises everything that is visible in the viewer's widget.

Returns:

the minimal region of the viewer's document comprising the contents of the viewer's widget

modelLine2WidgetLine

public int modelLine2WidgetLine(int modelLine)

Returns the widget line that corresponds to the given line of the viewer's document or -1 if there is no such line.

Parameters:

modelLine - the line of the viewer's document

Returns:

the corresponding widget line or -1

modelOffset2WidgetOffset

public int modelOffset2WidgetOffset(int modelOffset)

Returns the widget offset that corresponds to the given offset in the viewer's document or -1 if there is no such offset

Parameters:

modelOffset - the offset in the viewer's document

Returns:

the corresponding widget offset or -1

modelRange2WidgetRange

public IRegion modelRange2WidgetRange(IRegion modelRange)

Returns the minimal region of the viewer's widget that completely comprises the given region of the viewer's document or null if there is no such region.

Parameters:

modelRange - the region of the viewer's document

Returns:

the minimal region of the widget comprising modelRange or null

widgetOffset2ModelOffset

public int widgetOffset2ModelOffset(int widgetOffset)

Returns the offset of the viewer's document that corresponds to the given widget offset or -1 if there is no such offset

Parameters:

widgetOffset - the widget offset

Returns:

the corresponding offset in the viewer's document or -1

widgetRange2ModelRange

public IRegion widgetRange2ModelRange(IRegion widgetRange)

Returns the minimal region of the viewer's document that completely comprises the given widget region or null if there is no such region.

Parameters:

widgetRange - the widget region

Returns:

the minimal region of the viewer's document comprising widgetlRange or null

widgetlLine2ModelLine

public int widgetlLine2ModelLine(int widgetLine)

Returns the line of the viewer's document that corresponds to the given widget line or -1 if there is no such line.

Parameters:

widgetLine - the widget line

Returns:

the corresponding line of the viewer's document or -1

widgetLineOfWidgetOffset

public int widgetLineOfWidgetOffset(int widgetOffset)

Returns the widget line of the given widget offset.

Parameters:

widgetOffset - the widget offset

Returns:

the widget line of the widget offset