public interface ITextViewerExtension5 extends ITextViewerExtension3
ITextViewer
. Defines
a conceptual replacement of the original visible region concept. This interface
replaces ITextViewerExtension3
.
Introduces 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.
All model ranges that have a corresponding widget ranges are considered "exposed model ranges". The viewer can be requested to expose a given model range. Thus, a visible region is a particular degeneration of exposed model ranges.
This interface allows implementers to follow a sophisticated presentation model in which the visible presentation is a complex projection of the viewer's input document.
Modifier and Type | Method and Description |
---|---|
boolean |
exposeModelRange(IRegion modelRange)
Exposes the given model range.
|
IRegion[] |
getCoveredModelRanges(IRegion modelRange)
Returns the maximal subranges of the given model range thus that there is
no offset inside a subrange for which there is no image offset.
|
IRegion |
getModelCoverage()
Returns the minimal region of the viewer's input document that completely
comprises everything that is visible in the viewer's widget or
null if there is no such region. |
int |
modelLine2WidgetLine(int modelLine)
Returns the widget line that corresponds to the given line of the
viewer's input 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 input 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 input document or
null if there is no such region. |
int |
widgetLine2ModelLine(int widgetLine)
Returns the line of the viewer's input document that corresponds to the
given widget line or
-1 if there is no such line. |
int |
widgetLineOfWidgetOffset(int widgetOffset)
Returns the widget line of the given widget offset.
|
int |
widgetOffset2ModelOffset(int widgetOffset)
Returns the offset of the viewer's input 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 input document that completely
comprises the given widget region or
null if there is no
such region. |
widgetlLine2ModelLine
IRegion getModelCoverage()
null
if there is no such region.getModelCoverage
in interface ITextViewerExtension3
null
int modelLine2WidgetLine(int modelLine)
-1
if there is no such line.modelLine2WidgetLine
in interface ITextViewerExtension3
modelLine
- the line of the viewer's document-1
int modelOffset2WidgetOffset(int modelOffset)
-1
if there is no such offsetmodelOffset2WidgetOffset
in interface ITextViewerExtension3
modelOffset
- the offset in the viewer's document-1
IRegion modelRange2WidgetRange(IRegion modelRange)
null
if there is no such region.modelRange2WidgetRange
in interface ITextViewerExtension3
modelRange
- the region of the viewer's documentmodelRange
or null
int widgetOffset2ModelOffset(int widgetOffset)
-1
if there is no such offsetwidgetOffset2ModelOffset
in interface ITextViewerExtension3
widgetOffset
- the widget offset-1
IRegion widgetRange2ModelRange(IRegion widgetRange)
null
if there is no
such region.widgetRange2ModelRange
in interface ITextViewerExtension3
widgetRange
- the widget regionwidgetlRange
or null
int widgetLine2ModelLine(int widgetLine)
-1
if there is no such line.widgetLine
- the widget line-1
int widgetLineOfWidgetOffset(int widgetOffset)
widgetLineOfWidgetOffset
in interface ITextViewerExtension3
widgetOffset
- the widget offsetIRegion[] getCoveredModelRanges(IRegion modelRange)
modelRange
- the model rangeboolean exposeModelRange(IRegion modelRange)
modelRange
- the model range to be exposedtrue
if the set of exposed model ranges changed,
false
otherwise
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.