org.eclipse.xtext.ui.editor

Class XtextSourceViewer

java.lang.Object

org.eclipse.jface.viewers.Viewer

org.eclipse.jface.text.TextViewer

org.eclipse.jface.text.source.SourceViewer

org.eclipse.jface.text.source.projection.ProjectionViewer

org.eclipse.xtext.ui.editor.XtextSourceViewer

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.jface.text.IEditingSupportRegistry, org.eclipse.jface.text.ITextOperationTarget, org.eclipse.jface.text.ITextOperationTargetExtension, org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.ITextViewerExtension, org.eclipse.jface.text.ITextViewerExtension2, org.eclipse.jface.text.ITextViewerExtension3, org.eclipse.jface.text.ITextViewerExtension4, org.eclipse.jface.text.ITextViewerExtension5, org.eclipse.jface.text.ITextViewerExtension6, org.eclipse.jface.text.ITextViewerExtension7, org.eclipse.jface.text.ITextViewerExtension8, org.eclipse.jface.text.IWidgetTokenOwner, org.eclipse.jface.text.IWidgetTokenOwnerExtension, org.eclipse.jface.text.source.ISourceViewer, org.eclipse.jface.text.source.ISourceViewerExtension, org.eclipse.jface.text.source.ISourceViewerExtension2, org.eclipse.jface.text.source.ISourceViewerExtension3, org.eclipse.jface.text.source.ISourceViewerExtension4, org.eclipse.jface.viewers.IInputProvider, org.eclipse.jface.viewers.IInputSelectionProvider, org.eclipse.jface.viewers.IPostSelectionProvider, org.eclipse.jface.viewers.ISelectionProvider

public class XtextSourceViewer
extends org.eclipse.jface.text.source.projection.ProjectionViewer
implements org.eclipse.core.runtime.IAdaptable

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XtextSourceViewer.DefaultFactory
static interface	XtextSourceViewer.Factory

Nested classes/interfaces inherited from class org.eclipse.jface.text.source.SourceViewer

org.eclipse.jface.text.source.SourceViewer.RulerLayout

Nested classes/interfaces inherited from class org.eclipse.jface.text.TextViewer

org.eclipse.jface.text.TextViewer.TextHoverKey, org.eclipse.jface.text.TextViewer.WidgetCommand

Nested classes/interfaces inherited from interface org.eclipse.jface.text.ITextViewerExtension8

org.eclipse.jface.text.ITextViewerExtension8.EnrichMode

Field Summary

Fields inherited from class org.eclipse.jface.text.source.projection.ProjectionViewer

COLLAPSE, COLLAPSE_ALL, EXPAND, EXPAND_ALL, TOGGLE

Fields inherited from class org.eclipse.jface.text.source.SourceViewer

_SELECTION_POSITION_CATEGORY, fAnnotationHover, fContentAssistant, fContentAssistantInstalled, fContentFormatter, fInformationPresenter, fOverviewRulerAnnotationHover, fPresentationReconciler, fQuickAssistAssistant, fQuickAssistAssistantInstalled, fReconciler, fSelectionCategory, fSelections, fSelectionUpdater, GAP_SIZE, GAP_SIZE_1, MODEL_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.ITextViewerExtension2

DEFAULT_HOVER_STATE_MASK

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

Constructor Summary

Constructors

Constructor and Description
XtextSourceViewer(org.eclipse.swt.widgets.Composite parent, org.eclipse.jface.text.source.IVerticalRuler ruler, org.eclipse.jface.text.source.IOverviewRuler overviewRuler, boolean showsAnnotationOverview, int styles)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getAdapter(java.lang.Class adapter)
org.eclipse.jface.text.contentassist.IContentAssistant	getContentAssistant()
void	prependTextPresentationListener(org.eclipse.jface.text.ITextPresentationListener listener) copied from org.eclipse.jdt.internal.ui.javaeditor.JavaSourceViewer.prependTextPresentationListener(ITextPresentationListener)
protected void	updateTextListeners(org.eclipse.jface.text.TextViewer.WidgetCommand cmd) Informs all registered text listeners about the change specified by the widget command.

Methods inherited from class org.eclipse.jface.text.source.projection.ProjectionViewer

addProjectionListener, addVerticalRulerColumn, canDoOperation, computeCollapsedRegion, computeCollapsedRegionAnchor, copyMarkedRegion, createSlaveDocumentManager, createVisualAnnotationModel, disableProjection, doOperation, enableProjection, exposeModelRange, findAndSelect, findAndSelectInRange, fireProjectionDisabled, fireProjectionEnabled, getCoveredModelRanges, getFindReplaceDocumentAdapter, getProjectionAnnotationModel, getVisibleRegion, handleDispose, handleVerifyEvent, handleVisibleDocumentAboutToBeChanged, handleVisibleDocumentChanged, isProjectionMode, overlapsWithVisibleRegion, postCatchupRequest, processCatchupRequest, reinitializeProjection, removeProjectionListener, removeVerticalRulerColumn, resetVisibleRegion, setDocument, setProjectionSummary, setRangeIndication, setVisibleDocument, setVisibleRegion, updateSlaveDocument, widgetSelection2ModelSelection

Methods inherited from class org.eclipse.jface.text.source.SourceViewer

activatePlugins, clearRememberedSelection, configure, createControl, createFormattingContext, createLayout, disposeVisualAnnotationModel, enableOperation, ensureAnnotationHoverManagerInstalled, ensureOverviewHoverManagerInstalled, getAnnotationModel, getContentAssistantFacade, getControl, getCurrentAnnotationHover, getQuickAssistAssistant, getQuickAssistInvocationContext, getRangeIndication, getVerticalRuler, getVisualAnnotationModel, rememberSelection, removeRangeIndication, restoreSelection, setAnnotationHover, setDocument, setDocument, setDocument, setHoverEnrichMode, setOverviewRulerAnnotationHover, setRangeIndicator, showAnnotations, showAnnotationsOverview, unconfigure, updateSlaveDocuments

Methods inherited from class org.eclipse.jface.text.TextViewer

_getVisibleRegionOffset, _internalGetVisibleRegion, addPainter, addPostSelectionChangedListener, addTextInputListener, addTextListener, addTextPresentationListener, addViewportListener, appendVerifyKeyListener, areMultipleLinesSelected, canPerformFind, changeTextPresentation, createDocumentAdapter, createSlaveDocument, createTextWidget, customizeDocumentCommand, deleteText, disableRedrawing, enabledRedrawing, enabledRedrawing, event2ModelRange, findAndSelect, fireInputDocumentAboutToBeChanged, fireInputDocumentChanged, firePostSelectionChanged, fireSelectionChanged, freeSlaveDocument, getAverageCharWidth, getBottomIndex, getBottomIndexEndOffset, getClosestWidgetLineForModelLine, getCurrentTextHover, getDocument, getDocumentPartitioning, getEmptySelectionChangedEventDelay, getExtent, getFindReplaceTarget, getHoverEventLocation, getInput, getMark, getModelCoverage, getPaintManager, getRegisteredSupports, getRewriteTarget, getSelectedRange, getSelection, getSelectionProvider, getSlaveDocumentManager, getTextHover, getTextHover, getTextHoveringController, getTextOperationTarget, getTextWidget, getTopIndex, getTopIndexStartOffset, getTopInset, getUndoManager, getVisibleDocument, getVisibleLinesInViewport, getWidthInPixels, getWidthInPixels, ignoreAutoEditStrategies, initializeDocumentInformationMapping, inputChanged, internalRevealRange, invalidateTextPresentation, invalidateTextPresentation, isBlockSelected, isEditable, isIgnoringAutoEditStrategies, isPrintable, markChanged, modelLine2WidgetLine, modelOffset2WidgetOffset, modelRange2ClosestWidgetRange, modelRange2WidgetRange, modelRange2WidgetRange, modelSelection2WidgetSelection, modelStyleRange2WidgetStyleRange, moveFocusToWidgetToken, prependAutoEditStrategy, prependVerifyKeyListener, print, print, redraws, refresh, register, releaseWidgetToken, removeAutoEditStrategy, removePainter, removePostSelectionChangedListener, removeTextHovers, removeTextInputListener, removeTextListener, removeTextPresentationListener, removeVerifyKeyListener, removeViewportListener, requestWidgetToken, requestWidgetToken, resetPlugins, 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, shift, shift, startSequentialRewriteMode, stopSequentialRewriteMode, unregister, updateViewportListeners, updateVisibleDocument, validateSelectionRange, widgetLine2ModelLine, widgetLineOfWidgetOffset, widgetlLine2ModelLine, widgetOffset2ModelOffset, widgetRange2ModelRange

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.text.ITextViewerExtension5

getModelCoverage, modelLine2WidgetLine, modelOffset2WidgetOffset, modelRange2WidgetRange, widgetLine2ModelLine, widgetLineOfWidgetOffset, widgetOffset2ModelOffset, widgetRange2ModelRange

Methods inherited from interface org.eclipse.jface.text.ITextViewerExtension3

widgetlLine2ModelLine

Methods inherited from interface org.eclipse.jface.text.ITextViewer

addTextInputListener, addTextListener, addViewportListener, changeTextPresentation, getBottomIndex, getBottomIndexEndOffset, getDocument, getFindReplaceTarget, getSelectedRange, getSelectionProvider, getTextOperationTarget, getTextWidget, getTopIndex, getTopIndexStartOffset, getTopInset, invalidateTextPresentation, isEditable, removeTextInputListener, removeTextListener, removeViewportListener, resetPlugins, revealRange, setAutoIndentStrategy, setDefaultPrefixes, setEditable, setEventConsumer, setIndentPrefixes, setSelectedRange, setTextColor, setTextColor, setTextDoubleClickStrategy, setTextHover, setTopIndex, setUndoManager

Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider

addSelectionChangedListener, removeSelectionChangedListener, setSelection

Constructor Detail

XtextSourceViewer

public XtextSourceViewer(org.eclipse.swt.widgets.Composite parent,
                 org.eclipse.jface.text.source.IVerticalRuler ruler,
                 org.eclipse.jface.text.source.IOverviewRuler overviewRuler,
                 boolean showsAnnotationOverview,
                 int styles)

Method Detail

prependTextPresentationListener

public void prependTextPresentationListener(org.eclipse.jface.text.ITextPresentationListener listener)

copied from org.eclipse.jdt.internal.ui.javaeditor.JavaSourceViewer.prependTextPresentationListener(ITextPresentationListener)

updateTextListeners

protected void updateTextListeners(org.eclipse.jface.text.TextViewer.WidgetCommand cmd)

Informs all registered text listeners about the change specified by the widget command. This method does not use a robust iterator.

Overrides:

updateTextListeners in class org.eclipse.jface.text.TextViewer

Parameters:

cmd - the widget command translated into a text event sent to all text listeners

getContentAssistant

public org.eclipse.jface.text.contentassist.IContentAssistant getContentAssistant()

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapter)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

Since:

2.3