Class SourceViewer
- All Implemented Interfaces:
IEditingSupportRegistry
,ITextOperationTarget
,ITextOperationTargetExtension
,ITextViewer
,ITextViewerExtension
,ITextViewerExtension2
,ITextViewerExtension4
,ITextViewerExtension6
,ITextViewerExtension7
,ITextViewerExtension8
,ITextViewerExtension9
,IWidgetTokenOwner
,IWidgetTokenOwnerExtension
,ISourceViewer
,ISourceViewerExtension
,ISourceViewerExtension2
,ISourceViewerExtension3
,ISourceViewerExtension4
,ISourceViewerExtension5
,IInputProvider
,IInputSelectionProvider
,IPostSelectionProvider
,ISelectionProvider
- Direct Known Subclasses:
ProjectionViewer
,TextConsoleViewer
ISourceViewer
and its extension
interfaces. The same rules apply as for
TextViewer
. A source viewer uses an
IVerticalRuler
as its annotation presentation area. The
vertical ruler is a small strip shown left of the viewer's text widget. A
source viewer uses an IOverviewRuler
as its presentation area
for the annotation overview. The overview ruler is a small strip shown right
of the viewer's text widget.
Clients are supposed to instantiate a source viewer and subsequently to
communicate with it exclusively using the ISourceViewer
and
its extension interfaces.
Clients may subclass this class but should expect some breakage by future releases.
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
Layout of a source viewer.Nested classes/interfaces inherited from class org.eclipse.jface.text.TextViewer
TextViewer.TextHoverKey, TextViewer.WidgetCommand
Nested classes/interfaces inherited from interface org.eclipse.jface.text.ITextViewerExtension8
ITextViewerExtension8.EnrichMode
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final String
Partial name of the position category to manage remembered selections.protected IAnnotationHover
The viewer's annotation hoverprotected IContentAssistant
The viewer's content assistantprotected boolean
Flag indicating whether the viewer's content assistant is installed.protected IContentFormatter
The viewer's content formatterprotected IInformationPresenter
The viewer's information presenterprotected IAnnotationHover
The viewer's overview ruler annotation hoverprotected IPresentationReconciler
The viewer's presentation reconcilerprotected IQuickAssistAssistant
This viewer's quick assist assistant.protected boolean
Flag indicating whether this viewer's quick assist assistant is installed.protected IReconciler
The viewer's model reconcilerprotected String
Position category used by the selection updaterStack of saved selections in the underlying documentprotected IPositionUpdater
Position updater for saved selectionsprotected static final int
The size of the gap between the vertical ruler and the text widget (value2
).protected static final int
The size of the gap between the vertical ruler and the text widget (value1
).protected static final Object
Key of the model annotation model inside the visual annotation model.Fields inherited from class org.eclipse.jface.text.TextViewer
fAutoIndentStrategies, fDefaultPrefixChars, fDoubleClickStrategies, fEventConsumer, fFindReplaceDocumentAdapter, fHoverControlCreator, fHyperlinkDetectors, fHyperlinkManager, fHyperlinkPresenter, fHyperlinkStateMask, fIgnoreAutoIndent, fIndentChars, fInformationMapping, fLastTopPixel, fMarkPosition, fPaintManager, fPartitioning, fReplaceTextPresentation, fTextHovers, fTextInputListeners, fTextListeners, fTextPresentationListeners, fUndoManager, fViewportListeners, INTERNAL, KEY, MOUSE, MOUSE_END, RESIZE, SCROLLER, SHIFTING, TRACE_ERRORS
Fields inherited from class org.eclipse.jface.viewers.Viewer
WIDGET_DATA_KEY
Fields inherited from interface org.eclipse.jface.text.source.ISourceViewer
CONTENTASSIST_CONTEXT_INFORMATION, CONTENTASSIST_PROPOSALS, FORMAT, INFORMATION, QUICK_ASSIST
Fields inherited from interface org.eclipse.jface.text.ITextOperationTarget
COPY, CUT, DELETE, PASTE, PREFIX, PRINT, REDO, SELECT_ALL, SHIFT_LEFT, SHIFT_RIGHT, STRIP_PREFIX, UNDO
Fields inherited from interface org.eclipse.jface.text.ITextViewerExtension2
DEFAULT_HOVER_STATE_MASK
-
Constructor Summary
ConstructorDescriptionSourceViewer
(Composite parent, IVerticalRuler ruler, int styles) Constructs a new source viewer.SourceViewer
(Composite parent, IVerticalRuler verticalRuler, IOverviewRuler overviewRuler, boolean showAnnotationsOverview, int styles) Constructs a new source viewer. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Activates the installed plug-ins.void
Adds the give column as last column to this viewer's vertical ruler.boolean
canDoOperation
(int operation) Returns whether the operation specified by the given operation code can be performed.protected void
void
configure
(SourceViewerConfiguration configuration) Configures the source viewer using the given configuration.protected void
createControl
(Composite parent, int styles) Creates the viewer's SWT control.protected IFormattingContext
Creates a new formatting context for a format operation.protected IFormattingContext
createFormattingContext
(int selectionOffset, int selectionLength) Creates a new formatting context for a format operation.protected Layout
Creates the layout used for this viewer.protected IAnnotationModel
createVisualAnnotationModel
(IAnnotationModel annotationModel) Creates the visual annotation model on top of the given annotation model.protected void
Disposes the visual annotation model.void
doOperation
(int operation) Performs the operation specified by the operation code on the target.void
enableOperation
(int operation, boolean enable) Enables/disabled the given text operation.protected void
After this method has been executed the caller knows that any installed annotation hover has been installed.protected void
After this method has been executed the caller knows that any installed overview hover has been installed.Returns this viewer's annotation model.final ContentAssistantFacade
Returns a facade for this viewer's content assistant.Returns the primary control associated with this viewer.Returns the currently displayed annotation hover if any,null
otherwise.Returns this viewers quick assist assistant.Returns this viewer's quick assist invocation context.Returns the viewer's range indication.protected final IVerticalRuler
Returns the vertical ruler of this viewer.Returns the visual annotation model of this viewer.protected void
Frees all resources allocated by this viewer.boolean
Returnstrue
if there are code mining providers andfalse
otherwise.protected Point
Remembers and returns the current selection.void
Removes the viewer's range indication.void
Removes the give column from this viewer's vertical ruler.protected void
Restores a previously saved selection in the document.void
setAnnotationHover
(IAnnotationHover annotationHover) Sets the annotation hover of this source viewer.void
Set theAnnotationPainter
to use to draw code minings.void
setCodeMiningProviders
(ICodeMiningProvider[] codeMiningProviders) Register the code mining providers.void
setDocument
(IDocument document) Sets the given document as the text viewer's model and updates the presentation accordingly.void
setDocument
(IDocument document, int visibleRegionOffset, int visibleRegionLength) Sets the given document as this viewer's model and exposes the specified region.void
setDocument
(IDocument document, IAnnotationModel annotationModel) Sets the given document as this viewer's text model and the given annotation model as the model for this viewer's visual annotations.void
setDocument
(IDocument document, IAnnotationModel annotationModel, int modelRangeOffset, int modelRangeLength) Sets the given document as this viewer's text model and the given annotation model as the model for this viewer's visual annotations.void
Sets the hover enrich mode.void
setOverviewRulerAnnotationHover
(IAnnotationHover annotationHover) Sets the overview ruler's annotation hover of this source viewer.void
setRangeIndication
(int start, int length, boolean moveCursor) Sets the viewers's range indication to the specified range.void
setRangeIndicator
(Annotation rangeIndicator) Sets the annotation used by this viewer as range indicator.void
showAnnotations
(boolean show) Controls the visibility of annotations and in the case of separate presentation areas of text and annotations, the visibility of the annotation's presentation area.void
showAnnotationsOverview
(boolean show) Shows/hides an overview representation of the annotations of the whole document of this viewer.void
Rolls back the configuration process of this source viewer.void
Update the code minings.protected void
updateSlaveDocuments
(IDocument masterDocument) Updates all slave documents of the given document.Methods inherited from class org.eclipse.jface.text.TextViewer
_getVisibleRegionOffset, _internalGetVisibleRegion, addPainter, addPostSelectionChangedListener, addTextInputListener, addTextListener, addTextPresentationListener, addViewportListener, appendVerifyKeyListener, areMultipleLinesSelected, canPerformFind, changeTextPresentation, copyMarkedRegion, createDocumentAdapter, createSlaveDocument, createSlaveDocumentManager, createTextWidget, customizeDocumentCommand, deleteText, disableRedrawing, enabledRedrawing, enabledRedrawing, event2ModelRange, findAndSelect, findAndSelect, findAndSelectInRange, fireInputDocumentAboutToBeChanged, fireInputDocumentChanged, firePostSelectionChanged, fireSelectionChanged, freeSlaveDocument, getAverageCharWidth, getBottomIndex, getBottomIndexEndOffset, getClosestWidgetLineForModelLine, getCurrentTextHover, getDocument, getDocumentPartitioning, getEmptySelectionChangedEventDelay, getExtent, getFindReplaceDocumentAdapter, getFindReplaceTarget, getHoverEventLocation, getInput, getLastKnownSelection, getMark, getModelCoverage, getPaintManager, getRegisteredSupports, getRewriteTarget, getSelectedRange, getSelection, getSelectionProvider, getSlaveDocumentManager, getTextHover, getTextHover, getTextHoveringController, getTextOperationTarget, getTextWidget, getTopIndex, getTopIndexStartOffset, getTopInset, getUndoManager, getVisibleDocument, getVisibleLinesInViewport, getVisibleRegion, getWidthInPixels, getWidthInPixels, handleVerifyEvent, handleVisibleDocumentAboutToBeChanged, handleVisibleDocumentChanged, ignoreAutoEditStrategies, initializeDocumentInformationMapping, inputChanged, internalRevealRange, invalidateTextPresentation, invalidateTextPresentation, isBlockSelected, isEditable, isIgnoringAutoEditStrategies, isPrintable, markChanged, modelLine2WidgetLine, modelOffset2WidgetOffset, modelRange2ClosestWidgetRange, modelRange2WidgetRange, modelRange2WidgetRange, modelSelection2WidgetSelection, modelStyleRange2WidgetStyleRange, moveFocusToWidgetToken, overlapsWithVisibleRegion, prependAutoEditStrategy, prependVerifyKeyListener, print, print, redraws, refresh, register, releaseWidgetToken, removeAutoEditStrategy, removePainter, removePostSelectionChangedListener, removeTextHovers, removeTextInputListener, removeTextListener, removeTextPresentationListener, removeVerifyKeyListener, removeViewportListener, requestWidgetToken, requestWidgetToken, resetPlugins, resetVisibleRegion, revealRange, selectContentTypePlugin, selectionChanged, setAutoEditStrategies, setAutoIndentStrategy, setDefaultPrefixes, setDocumentPartitioning, setEditable, setEventConsumer, setHoverControlCreator, setHyperlinkDetectors, setHyperlinkPresenter, setIndentPrefixes, setInput, setMark, setRedraw, setRedraw, setSelectedRange, setSelection, setTabsToSpacesConverter, setTextColor, setTextColor, setTextDoubleClickStrategy, setTextHover, setTextHover, setTopIndex, setUndoManager, setVisibleDocument, setVisibleRegion, shift, shift, startSequentialRewriteMode, stopSequentialRewriteMode, unregister, updateSlaveDocument, updateTextListeners, updateViewportListeners, updateVisibleDocument, validateSelectionRange, widgetLine2ModelLine, widgetLineOfWidgetOffset, widgetlLine2ModelLine, widgetOffset2ModelOffset, widgetRange2ModelRange, widgetSelection2ModelSelection
Methods inherited from class org.eclipse.jface.viewers.Viewer
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider
addSelectionChangedListener, removeSelectionChangedListener, setSelection
Methods inherited from interface org.eclipse.jface.text.ITextViewer
addTextInputListener, addTextListener, addViewportListener, changeTextPresentation, getBottomIndex, getBottomIndexEndOffset, getDocument, getFindReplaceTarget, getSelectedRange, getSelectionProvider, getTextOperationTarget, getTextWidget, getTopIndex, getTopIndexStartOffset, getTopInset, getVisibleRegion, invalidateTextPresentation, isEditable, overlapsWithVisibleRegion, removeTextInputListener, removeTextListener, removeViewportListener, resetPlugins, resetVisibleRegion, revealRange, setAutoIndentStrategy, setDefaultPrefixes, setEditable, setEventConsumer, setIndentPrefixes, setSelectedRange, setTextColor, setTextColor, setTextDoubleClickStrategy, setTextHover, setTopIndex, setUndoManager, setVisibleRegion
-
Field Details
-
GAP_SIZE
protected static final int GAP_SIZEThe size of the gap between the vertical ruler and the text widget (value2
).Note: As of 3.2, the text editor framework is no longer using 2 as gap but 1, see {
GAP_SIZE_1
.- See Also:
-
GAP_SIZE_1
protected static final int GAP_SIZE_1The size of the gap between the vertical ruler and the text widget (value1
).- Since:
- 3.2
- See Also:
-
_SELECTION_POSITION_CATEGORY
Partial name of the position category to manage remembered selections.- Since:
- 3.0
- See Also:
-
MODEL_ANNOTATION_MODEL
Key of the model annotation model inside the visual annotation model.- Since:
- 3.0
-
fContentAssistant
The viewer's content assistant -
fContentAssistantInstalled
protected boolean fContentAssistantInstalledFlag indicating whether the viewer's content assistant is installed.- Since:
- 2.0
-
fQuickAssistAssistant
This viewer's quick assist assistant.- Since:
- 3.2
-
fQuickAssistAssistantInstalled
protected boolean fQuickAssistAssistantInstalledFlag indicating whether this viewer's quick assist assistant is installed.- Since:
- 3.2
-
fContentFormatter
The viewer's content formatter -
fReconciler
The viewer's model reconciler -
fPresentationReconciler
The viewer's presentation reconciler -
fAnnotationHover
The viewer's annotation hover -
fSelections
Stack of saved selections in the underlying document- Since:
- 3.0
-
fSelectionUpdater
Position updater for saved selections- Since:
- 3.0
-
fSelectionCategory
Position category used by the selection updater- Since:
- 3.0
-
fOverviewRulerAnnotationHover
The viewer's overview ruler annotation hover- Since:
- 3.0
-
fInformationPresenter
The viewer's information presenter- Since:
- 2.0
-
-
Constructor Details
-
SourceViewer
Constructs a new source viewer. The vertical ruler is initially visible. The viewer has not yet been initialized with a source viewer configuration.- Parameters:
parent
- the parent of the viewer's controlruler
- the vertical ruler used by this source viewerstyles
- the SWT style bits for the viewer's control, ifSWT.WRAP
is set then a custom document adapter needs to be provided, seeTextViewer.createDocumentAdapter()
-
SourceViewer
public SourceViewer(Composite parent, IVerticalRuler verticalRuler, IOverviewRuler overviewRuler, boolean showAnnotationsOverview, int styles) Constructs a new source viewer. The vertical ruler is initially visible. The overview ruler visibility is controlled by the value ofshowAnnotationsOverview
. The viewer has not yet been initialized with a source viewer configuration.- Parameters:
parent
- the parent of the viewer's controlverticalRuler
- the vertical ruler used by this source vieweroverviewRuler
- the overview rulershowAnnotationsOverview
-true
if the overview ruler should be visible,false
otherwisestyles
- the SWT style bits for the viewer's control, ifSWT.WRAP
is set then a custom document adapter needs to be provided, seeTextViewer.createDocumentAdapter()
- Since:
- 2.1
-
-
Method Details
-
createControl
Description copied from class:TextViewer
Creates the viewer's SWT control. The viewer's text widget either is the control or is a child of the control.- Overrides:
createControl
in classTextViewer
- Parameters:
parent
- the parent of the viewer's controlstyles
- the SWT style bits for the viewer's control
-
createLayout
Creates the layout used for this viewer. Subclasses may override this method.- Returns:
- the layout used for this viewer
- Since:
- 3.0
-
getControl
Description copied from class:Viewer
Returns the primary control associated with this viewer.- Specified by:
getControl
in interfaceITextViewerExtension
- Overrides:
getControl
in classTextViewer
- Returns:
- the SWT control which displays this viewer's content
-
setAnnotationHover
Description copied from interface:ISourceViewer
Sets the annotation hover of this source viewer. The annotation hover provides the information to be displayed in a hover popup window if requested over the annotation presentation area. The annotation hover is assumed to be line oriented.- Specified by:
setAnnotationHover
in interfaceISourceViewer
- Parameters:
annotationHover
- the hover to be used,null
is a valid argument
-
setOverviewRulerAnnotationHover
Sets the overview ruler's annotation hover of this source viewer. The annotation hover provides the information to be displayed in a hover popup window if requested over the overview rulers area. The annotation hover is assumed to be line oriented.- Parameters:
annotationHover
- the hover to be used,null
is a valid argument- Since:
- 3.0
-
configure
Description copied from interface:ISourceViewer
Configures the source viewer using the given configuration. Prior to 3.0 this method can only be called once. Since 3.0 this method can be called again after a call toISourceViewerExtension2.unconfigure()
.- Specified by:
configure
in interfaceISourceViewer
- Parameters:
configuration
- the source viewer configuration to be used
-
ensureAnnotationHoverManagerInstalled
protected void ensureAnnotationHoverManagerInstalled()After this method has been executed the caller knows that any installed annotation hover has been installed. -
ensureOverviewHoverManagerInstalled
protected void ensureOverviewHoverManagerInstalled()After this method has been executed the caller knows that any installed overview hover has been installed. -
setHoverEnrichMode
Description copied from class:TextViewer
Sets the hover enrich mode. A non-null
mode
defines when hovers should be enriched once the mouse is moved into them. Ifmode
isnull
, hovers are automatically closed when the mouse is moved out of thehover region
.Note that a hover can only be enriched if its
IInformationControlExtension5.getInformationPresenterControlCreator()
is notnull
.- Specified by:
setHoverEnrichMode
in interfaceITextViewerExtension8
- Overrides:
setHoverEnrichMode
in classTextViewer
- Parameters:
mode
- the enrich mode, ornull
-
activatePlugins
public void activatePlugins()Description copied from interface:ITextViewer
Activates the installed plug-ins. If the plug-ins are already activated this call has no effect.- Specified by:
activatePlugins
in interfaceITextViewer
- Overrides:
activatePlugins
in classTextViewer
-
setDocument
Description copied from interface:ITextViewer
Sets the given document as the text viewer's model and updates the presentation accordingly. An appropriateTextEvent
is issued. This text event does not carry a related document event.- Specified by:
setDocument
in interfaceITextViewer
- Overrides:
setDocument
in classTextViewer
- Parameters:
document
- the viewer's new input documentnull
if none
-
setDocument
Description copied from interface:ITextViewer
Sets the given document as this viewer's model and exposes the specified region. An appropriateTextEvent
is issued. The text event does not carry a related document event. This method is a convenience method forsetDocument(document);setVisibleRegion(offset, length)
.- Specified by:
setDocument
in interfaceITextViewer
- Overrides:
setDocument
in classTextViewer
- Parameters:
document
- the new input document ornull
if nonevisibleRegionOffset
- the offset of the model rangevisibleRegionLength
- the length of the model range
-
setDocument
Description copied from interface:ISourceViewer
Sets the given document as this viewer's text model and the given annotation model as the model for this viewer's visual annotations. The presentation is accordingly updated. An appropriateTextEvent
is issued. This text event does not carry a related document event.- Specified by:
setDocument
in interfaceISourceViewer
- Parameters:
document
- the viewer's new input documentannotationModel
- the model for the viewer's visual annotations- See Also:
-
createVisualAnnotationModel
Creates the visual annotation model on top of the given annotation model.- Parameters:
annotationModel
- the wrapped annotation model- Returns:
- the visual annotation model on top of the given annotation model
- Since:
- 3.0
-
disposeVisualAnnotationModel
protected void disposeVisualAnnotationModel()Disposes the visual annotation model.- Since:
- 3.1
-
setDocument
public void setDocument(IDocument document, IAnnotationModel annotationModel, int modelRangeOffset, int modelRangeLength) Description copied from interface:ISourceViewer
Sets the given document as this viewer's text model and the given annotation model as the model for this viewer's visual annotations. The presentation is accordingly updated whereby only the specified region is exposed. An appropriateTextEvent
is issued. The text event does not carry a related document event. This method is a convenience method forsetDocument(document, annotationModel);setVisibleRegion(offset, length)
.- Specified by:
setDocument
in interfaceISourceViewer
- Parameters:
document
- the new input documentannotationModel
- the model of the viewer's visual annotationsmodelRangeOffset
- the offset of the model rangemodelRangeLength
- the length of the model range- See Also:
-
getAnnotationModel
Description copied from interface:ISourceViewer
Returns this viewer's annotation model. UseISourceViewerExtension2.getVisualAnnotationModel()
in order to get access to the viewer's visual annotation model.- Specified by:
getAnnotationModel
in interfaceISourceViewer
- Returns:
- this viewer's annotation model, or
null
if none could be determined
-
getQuickAssistAssistant
Description copied from interface:ISourceViewerExtension3
Returns this viewers quick assist assistant.- Specified by:
getQuickAssistAssistant
in interfaceISourceViewerExtension3
- Returns:
- the quick assist assistant or
null
if none is configured
-
getContentAssistantFacade
Returns a facade for this viewer's content assistant.- Specified by:
getContentAssistantFacade
in interfaceISourceViewerExtension4
- Returns:
- a content assistant facade or
null
if none is configured - Since:
- 3.4
-
getQuickAssistInvocationContext
Description copied from interface:ISourceViewerExtension3
Returns this viewer's quick assist invocation context.- Specified by:
getQuickAssistInvocationContext
in interfaceISourceViewerExtension3
- Returns:
- the quick assist invocation context or
null
if none is available
-
getVisualAnnotationModel
Description copied from interface:ISourceViewerExtension2
Returns the visual annotation model of this viewer.- Specified by:
getVisualAnnotationModel
in interfaceISourceViewerExtension2
- Returns:
- the visual annotation model of this viewer
-
unconfigure
public void unconfigure()Description copied from interface:ISourceViewerExtension2
Rolls back the configuration process of this source viewer. The source viewer can be configured again after a call to this method. UnlikeISourceViewer.configure(SourceViewerConfiguration)
this method can be called more than once without interleaving calls toISourceViewer.configure(SourceViewerConfiguration)
.- Specified by:
unconfigure
in interfaceISourceViewerExtension2
-
handleDispose
protected void handleDispose()Description copied from class:TextViewer
Frees all resources allocated by this viewer. Internally called when the viewer's control has been disposed.- Overrides:
handleDispose
in classTextViewer
-
canDoOperation
public boolean canDoOperation(int operation) Description copied from interface:ITextOperationTarget
Returns whether the operation specified by the given operation code can be performed.- Specified by:
canDoOperation
in interfaceITextOperationTarget
- Overrides:
canDoOperation
in classTextViewer
- Parameters:
operation
- the operation code- Returns:
true
if the specified operation can be performed
-
createFormattingContext
Creates a new formatting context for a format operation.After the use of the context, clients are required to call its
dispose
method.- Returns:
- The new formatting context
- Since:
- 3.0
-
createFormattingContext
Creates a new formatting context for a format operation. If the returned context has theFormattingContextProperties.CONTEXT_REGION
property set to anIRegion
, the section of the document defined by that region is formatted, otherwise the whole document is formatted.The default implementation calls
createFormattingContext()
and sets theFormattingContextProperties.CONTEXT_REGION
property if the selection is not empty. Overriding methods may implement a different logic, or returnnull
to indicate that the formatting operation should not proceed.Returning
null
may be used, for example, when the user clicks on the Cancel button in a dialog that, in case of an empty selection, asks the user whether formatting should be applied to the whole document or to the current statement. Please notice that returningnull
from this method cancels the already initiated formatting operation unlikecanDoOperation(int)
, which is used for enabling and disabling formatting actions.After the use of the context, clients are required to call its
dispose
method.- Parameters:
selectionOffset
- the character offset of the selection in the documentselectionLength
- the length of the selection- Returns:
- The new formatting context, or
null
to cancel the formatting - Since:
- 3.10
-
rememberSelection
Remembers and returns the current selection. The saved selection can be restored by callingrestoreSelection()
.- Returns:
- the current selection
- Since:
- 3.0
- See Also:
-
restoreSelection
protected void restoreSelection()Restores a previously saved selection in the document.If no selection was previously saved, nothing happens.
- Since:
- 3.0
-
clearRememberedSelection
protected void clearRememberedSelection() -
doOperation
public void doOperation(int operation) Description copied from interface:ITextOperationTarget
Performs the operation specified by the operation code on the target.doOperation
must only be called ifcanDoOperation
returnstrue
.- Specified by:
doOperation
in interfaceITextOperationTarget
- Overrides:
doOperation
in classTextViewer
- Parameters:
operation
- the operation code
-
updateSlaveDocuments
Updates all slave documents of the given document. This default implementation callsupdateSlaveDocument
for their current visible range. Subclasses may reimplement.- Parameters:
masterDocument
- the master document- Since:
- 3.0
-
enableOperation
public void enableOperation(int operation, boolean enable) Description copied from interface:ITextOperationTargetExtension
Enables/disabled the given text operation.- Specified by:
enableOperation
in interfaceITextOperationTargetExtension
- Overrides:
enableOperation
in classTextViewer
- Parameters:
operation
- the operation to enable/disableenable
-true
to enable the operation otherwisefalse
-
setRangeIndicator
Description copied from interface:ISourceViewer
Sets the annotation used by this viewer as range indicator. The range covered by this annotation is referred to as range indication.- Specified by:
setRangeIndicator
in interfaceISourceViewer
- Parameters:
rangeIndicator
- the annotation to be used as this viewer's range indicator
-
setRangeIndication
public void setRangeIndication(int start, int length, boolean moveCursor) Description copied from interface:ISourceViewer
Sets the viewers's range indication to the specified range. It is indicated whether the cursor should also be moved to the beginning of the specified range.- Specified by:
setRangeIndication
in interfaceISourceViewer
- Parameters:
start
- the offset of the rangelength
- the length of the rangemoveCursor
- indicates whether the cursor should be moved to the given offset
-
getRangeIndication
Description copied from interface:ISourceViewer
Returns the viewer's range indication.- Specified by:
getRangeIndication
in interfaceISourceViewer
- Returns:
- the viewer's range indication.
-
removeRangeIndication
public void removeRangeIndication()Description copied from interface:ISourceViewer
Removes the viewer's range indication. There is no visible range indication after this method completed.- Specified by:
removeRangeIndication
in interfaceISourceViewer
-
showAnnotations
public void showAnnotations(boolean show) Description copied from interface:ISourceViewer
Controls the visibility of annotations and in the case of separate presentation areas of text and annotations, the visibility of the annotation's presentation area.By default, annotations and their presentation area are visible.
- Specified by:
showAnnotations
in interfaceISourceViewer
- Parameters:
show
- indicates the visibility of annotations
-
getVerticalRuler
Returns the vertical ruler of this viewer.- Returns:
- the vertical ruler of this viewer
- Since:
- 3.0
-
addVerticalRulerColumn
Adds the give column as last column to this viewer's vertical ruler.- Parameters:
column
- the column to be added- Since:
- 3.8
-
removeVerticalRulerColumn
Removes the give column from this viewer's vertical ruler.- Parameters:
column
- the column to be removed- Since:
- 3.8
-
showAnnotationsOverview
public void showAnnotationsOverview(boolean show) Description copied from interface:ISourceViewerExtension
Shows/hides an overview representation of the annotations of the whole document of this viewer.- Specified by:
showAnnotationsOverview
in interfaceISourceViewerExtension
- Parameters:
show
-true
if annotation overview should be visible,false
otherwise
-
getCurrentAnnotationHover
Description copied from interface:ISourceViewerExtension3
Returns the currently displayed annotation hover if any,null
otherwise.- Specified by:
getCurrentAnnotationHover
in interfaceISourceViewerExtension3
- Returns:
- the currently displayed annotation hover or
null
-
setCodeMiningProviders
Description copied from interface:ISourceViewerExtension5
Register the code mining providers.- Specified by:
setCodeMiningProviders
in interfaceISourceViewerExtension5
- Parameters:
codeMiningProviders
- the code mining providers to register.
-
hasCodeMiningProviders
public boolean hasCodeMiningProviders()Description copied from interface:ISourceViewerExtension5
Returnstrue
if there are code mining providers andfalse
otherwise.- Specified by:
hasCodeMiningProviders
in interfaceISourceViewerExtension5
- Returns:
true
if there are code mining providers andfalse
otherwise.
-
updateCodeMinings
public void updateCodeMinings()Description copied from interface:ISourceViewerExtension5
Update the code minings. Clients and implementors are responsible of calling this method when needed. A typical use-case can be to run it upon completion of a reconcilier and after a job that would compute all the necessary pre-requisites to insert code mining annotations.- Specified by:
updateCodeMinings
in interfaceISourceViewerExtension5
-
setCodeMiningAnnotationPainter
Description copied from interface:ISourceViewerExtension5
Set theAnnotationPainter
to use to draw code minings.- Specified by:
setCodeMiningAnnotationPainter
in interfaceISourceViewerExtension5
- Parameters:
painter
- theAnnotationPainter
to use to draw code minings.
-