java.lang.Object
- org.eclipse.jface.viewers.Viewer
- - org.eclipse.jface.text.TextViewer

All Implemented Interfaces:

IEditingSupportRegistry, ITextOperationTarget, ITextOperationTargetExtension, ITextViewer, ITextViewerExtension, ITextViewerExtension2, ITextViewerExtension4, ITextViewerExtension6, ITextViewerExtension7, ITextViewerExtension8, ITextViewerExtension9, IWidgetTokenOwner, IWidgetTokenOwnerExtension, IInputProvider, IInputSelectionProvider, IPostSelectionProvider, ISelectionProvider

Direct Known Subclasses:

SourceViewer
```
public class TextViewer
extends Viewer
implements ITextViewer, ITextViewerExtension, ITextViewerExtension2, ITextViewerExtension4, ITextViewerExtension6, ITextViewerExtension7, ITextViewerExtension8, ITextViewerExtension9, IEditingSupportRegistry, ITextOperationTarget, ITextOperationTargetExtension, IWidgetTokenOwner, IWidgetTokenOwnerExtension, IPostSelectionProvider
```
SWT based implementation of ITextViewer and its extension interfaces. Once the viewer and its SWT control have been created the viewer can only indirectly be disposed by disposing its SWT control.
Clients are supposed to instantiate a text viewer and subsequently to communicate with it exclusively using the ITextViewer interface or any of the implemented extension interfaces.
A text viewer serves as text operation target. It only partially supports the external control of the enable state of its text operations. A text viewer is also a widget token owner. Anything that wants to display an overlay window on top of a text viewer should implement the IWidgetTokenKeeper interface and participate in the widget token negotiation between the text viewer and all its potential widget token keepers.
This class is not intended to be subclassed outside the JFace Text component.

Restriction:

This class is not intended to be subclassed by clients.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected class`	`TextViewer.TextHoverKey`	Value object used as key in the text hover configuration table.
`protected class`	`TextViewer.WidgetCommand`	Represents a replace command that brings the text viewer's text widget back in synchronization with text viewer's document after the document has been changed.

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

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,List<IAutoEditStrategy>>`	`fAutoIndentStrategies`	The text viewer's auto indent strategies
`protected Map<String,String[]>`	`fDefaultPrefixChars`	The string a line is prefixed with on PREFIX and removed from each line on STRIP_PREFIX
`protected Map<String,ITextDoubleClickStrategy>`	`fDoubleClickStrategies`	The text viewer's text double click strategies
`protected IEventConsumer`	`fEventConsumer`	The text viewer's event consumer
`protected FindReplaceDocumentAdapter`	`fFindReplaceDocumentAdapter`	The find/replace document adapter.
`protected IInformationControlCreator`	`fHoverControlCreator`	The creator of the text hover control
`protected IHyperlinkDetector[]`	`fHyperlinkDetectors`	The text viewer's hyperlink detectors.
`protected HyperlinkManager`	`fHyperlinkManager`	The text viewer's hyperlink manager.
`protected IHyperlinkPresenter`	`fHyperlinkPresenter`	The text viewer's hyperlink presenter.
`protected int`	`fHyperlinkStateMask`	The SWT key modifier mask which in combination with the left mouse button triggers the hyperlink mode.
`protected boolean`	`fIgnoreAutoIndent`	Should the auto indent strategies ignore the next edit operation
`protected Map<String,String[]>`	`fIndentChars`	The strings a line is prefixed with on SHIFT_RIGHT and removed from each line on SHIFT_LEFT
`protected IDocumentInformationMapping`	`fInformationMapping`	The mapping between model and visible document.
`protected int`	`fLastTopPixel`	The last visible vertical position of the top line
`protected Position`	`fMarkPosition`	The mark position.
`protected PaintManager`	`fPaintManager`	The viewer's paint manager.
`protected String`	`fPartitioning`	The viewers partitioning.
`protected boolean`	`fReplaceTextPresentation`	Indicates whether the viewer's text presentation should be replaced are modified.
`protected Map<TextViewer.TextHoverKey,ITextHover>`	`fTextHovers`	The text viewer's text hovers
`protected List<ITextInputListener>`	`fTextInputListeners`	All registered text input listeners
`protected List<ITextListener>`	`fTextListeners`	All registered text listeners
`protected List<ITextPresentationListener>`	`fTextPresentationListeners`	All registered text presentation listeners.
`protected IUndoManager`	`fUndoManager`	The text viewer's undo manager
`protected List<IViewportListener>`	`fViewportListeners`	All registered view port listeners
`protected static int`	`INTERNAL`	Identifies internal reasons as originators of a view port change.
`protected static int`	`KEY`	Identifies key strokes as originators of a view port change.
`protected static int`	`MOUSE`	Identifies mouse moves as originators of a view port change.
`protected static int`	`MOUSE_END`	Identifies mouse button up as originator of a view port change.
`protected static int`	`RESIZE`	Identifies window resizing as originator of a view port change.
`protected static int`	`SCROLLER`	Identifies the scrollbars as originators of a view port change.
`protected static String`	`SHIFTING`	Internal name of the position category used selection preservation during shift.
`static boolean`	`TRACE_ERRORS`	Internal flag to indicate the debug state.

Fields inherited from class org.eclipse.jface.viewers.Viewer
WIDGET_DATA_KEY

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

Constructors
Modifier	Constructor	Description
`protected`	`TextViewer()`	Internal use only
	`TextViewer(Composite parent, int styles)`	Create a new text viewer with the given SWT style bits.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected int`	`_getVisibleRegionOffset()`	Returns the offset of the visible region.
`protected IRegion`	`_internalGetVisibleRegion()`	Returns the visible region if it is not equal to the whole document.
`void`	`activatePlugins()`	Activates the installed plug-ins.
`void`	`addPainter(IPainter painter)`	Adds the given painter to this viewer.
`void`	`addPostSelectionChangedListener(ISelectionChangedListener listener)`	Adds a listener for post selection changes in this selection provider.
`void`	`addTextInputListener(ITextInputListener listener)`	Adds a text input listener to this viewer.
`void`	`addTextListener(ITextListener listener)`	Adds a text listener to this viewer.
`void`	`addTextPresentationListener(ITextPresentationListener listener)`	Adds the given text presentation listener to this text viewer.
`void`	`addViewportListener(IViewportListener listener)`	Adds the given view port listener to this viewer.
`void`	`appendVerifyKeyListener(VerifyKeyListener listener)`	Appends a verify key listener to the viewer's list of verify key listeners.
`protected boolean`	`areMultipleLinesSelected()`	Returns `true` if one line is completely selected or if multiple lines are selected.
`boolean`	`canDoOperation(int operation)`	Returns whether the operation specified by the given operation code can be performed.
`protected boolean`	`canPerformFind()`	Adheres to the contract of `IFindReplaceTarget.canPerformFind()`.
`void`	`changeTextPresentation(TextPresentation presentation, boolean controlRedraw)`	Applies the color information encoded in the given text presentation.
`protected void`	`copyMarkedRegion(boolean delete)`	Copies/cuts the marked region.
`protected void`	`createControl(Composite parent, int styles)`	Creates the viewer's SWT control.
`protected IDocumentAdapter`	`createDocumentAdapter()`	Factory method to create the document adapter to be used by this viewer.
`protected IDocument`	`createSlaveDocument(IDocument document)`	Creates a slave document for the given document if there is a slave document manager associated with this viewer.
`protected ISlaveDocumentManager`	`createSlaveDocumentManager()`	Creates a new slave document manager.
`protected StyledText`	`createTextWidget(Composite parent, int styles)`	Factory method to create the text widget to be used as the viewer's text widget.
`protected void`	`customizeDocumentCommand(DocumentCommand command)`	Hook called on receipt of a `VerifyEvent`.
`protected void`	`deleteText()`	Deprecated. use `StyledText.invokeAction` instead
`protected void`	`disableRedrawing()`	Disables the redrawing of this text viewer.
`void`	`doOperation(int operation)`	Performs the operation specified by the operation code on the target.
`protected void`	`enabledRedrawing()`	Enables the redrawing of this text viewer.
`protected void`	`enabledRedrawing(int topIndex)`	Enables the redrawing of this text viewer.
`void`	`enableOperation(int operation, boolean enable)`	Enables/disabled the given text operation.
`protected IRegion`	`event2ModelRange(VerifyEvent event)`	Translates the widget region of the given verify event into the corresponding region of the viewer's document.
`protected int`	`findAndSelect(int startPosition, String findString, boolean forwardSearch, boolean caseSensitive, boolean wholeWord)`	Deprecated. as of 3.0 use `findAndSelect(int, String, boolean, boolean, boolean, boolean)`
`protected int`	`findAndSelect(int startPosition, String findString, boolean forwardSearch, boolean caseSensitive, boolean wholeWord, boolean regExSearch)`	Adheres to the contract of `IFindReplaceTargetExtension3.findAndSelect(int, String, boolean, boolean, boolean, boolean)`.
`protected int`	`findAndSelectInRange(int startPosition, String findString, boolean forwardSearch, boolean caseSensitive, boolean wholeWord, int rangeOffset, int rangeLength, boolean regExSearch)`	Adheres to the contract of `IFindReplaceTargetExtension3.findAndSelect(int, String, boolean, boolean, boolean, boolean)`.
`protected void`	`fireInputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)`	Informs all registered text input listeners about the forthcoming input change, This method does not use a robust iterator.
`protected void`	`fireInputDocumentChanged(IDocument oldInput, IDocument newInput)`	Informs all registered text input listeners about the successful input change, This method does not use a robust iterator.
`protected void`	`firePostSelectionChanged(int offset, int length)`	Sends out a text selection changed event to all registered post selection changed listeners.
`protected void`	`fireSelectionChanged(int offset, int length)`	Sends out a text selection changed event to all registered listeners.
`protected void`	`freeSlaveDocument(IDocument slave)`	Frees the given document if it is a slave document.
`protected int`	`getAverageCharWidth()`	Returns the average character width of this viewer's widget.
`int`	`getBottomIndex()`	Returns the visible line with the highest line number.
`int`	`getBottomIndexEndOffset()`	Returns the document offset of the lower right corner of this viewer's view port.
`protected int`	`getClosestWidgetLineForModelLine(int modelLine)`	Returns the line of the widget whose corresponding line in the viewer's document is closest to the given line in the viewer's document or `-1`.
`Control`	`getControl()`	Returns the primary control associated with this viewer.
`ITextHover`	`getCurrentTextHover()`	Returns the currently displayed text hover if any, `null` otherwise.
`IDocument`	`getDocument()`	Returns the text viewer's input document.
`protected String`	`getDocumentPartitioning()`	Returns the document partitioning for this viewer.
`protected int`	`getEmptySelectionChangedEventDelay()`	The delay in milliseconds before an empty selection changed event is sent by the cursor listener.
`protected IRegion`	`getExtent(int start, int end)`	Returns the region covered by the given start and end offset.
`protected FindReplaceDocumentAdapter`	`getFindReplaceDocumentAdapter()`	Returns the find/replace document adapter.
`IFindReplaceTarget`	`getFindReplaceTarget()`	Returns the find/replace operation target of this viewer.
`Point`	`getHoverEventLocation()`	Returns the location at which the most recent mouse hover event has occurred.
`Object`	`getInput()`	Returns the input.
`ITextSelection`	`getLastKnownSelection()`	Returns the last known selection from a cache, without polling widget.
`int`	`getMark()`	Returns the position of the mark, `-1` if the mark is not set.
`IRegion`	`getModelCoverage()`	Implements the contract of `ITextViewerExtension5.getModelCoverage()`.
`protected PaintManager`	`getPaintManager()`	Returns the paint manager of this viewer.
`IEditingSupport[]`	`getRegisteredSupports()`	Returns the current editor helpers.
`IRewriteTarget`	`getRewriteTarget()`	Returns the viewer's rewrite target.
`Point`	`getSelectedRange()`	Returns the range of the current selection in coordinates of this viewer's document.
`ISelection`	`getSelection()`	Returns the current selection for this provider.
`ISelectionProvider`	`getSelectionProvider()`	Returns a selection provider dedicated to this viewer.
`protected ISlaveDocumentManager`	`getSlaveDocumentManager()`	Returns the slave document manager
`protected ITextHover`	`getTextHover(int offset)`	Returns the text hover for a given offset.
`protected ITextHover`	`getTextHover(int offset, int stateMask)`	Returns the text hover for a given offset and a given state mask.
`protected AbstractInformationControlManager`	`getTextHoveringController()`	Returns the text hovering controller of this viewer.
`ITextOperationTarget`	`getTextOperationTarget()`	Returns the text operation target of this viewer.
`StyledText`	`getTextWidget()`	Returns this viewer's SWT control, `null` if the control is disposed.
`int`	`getTopIndex()`	Returns the visible line with the smallest line number.
`int`	`getTopIndexStartOffset()`	Returns the document offset of the upper left corner of this viewer's view port.
`int`	`getTopInset()`	Returns the vertical offset of the first visible line.
`IUndoManager`	`getUndoManager()`	Returns this viewer's undo manager.
`protected IDocument`	`getVisibleDocument()`	Returns the viewer's visible document.
`protected int`	`getVisibleLinesInViewport()`	Deprecated. as of 3.2
`IRegion`	`getVisibleRegion()`	Returns the current visible region of this viewer's document.
`protected int`	`getWidthInPixels(int offset, int length)`	Returns the width of the representation of a text range in the visible region of the viewer's document as drawn in this viewer's widget.
`protected int`	`getWidthInPixels(String text)`	Deprecated. use `getWidthInPixels(int, int)` instead
`protected void`	`handleDispose()`	Frees all resources allocated by this viewer.
`protected void`	`handleVerifyEvent(VerifyEvent e)`	Handles the verify event issued by the viewer's text widget.
`protected void`	`handleVisibleDocumentAboutToBeChanged(DocumentEvent event)`	Hook method called when the visible document is about to be changed.
`protected void`	`handleVisibleDocumentChanged(DocumentEvent event)`	Hook method called when the visible document has been changed.
`protected void`	`ignoreAutoEditStrategies(boolean ignore)`	Tells this viewer whether the registered auto edit strategies should be ignored.
`protected void`	`initializeDocumentInformationMapping(IDocument visibleDocument)`	Initializes the document information mapping between the given slave document and its master document.
`protected void`	`inputChanged(Object newInput, Object oldInput)`	Internal hook method called when the input to this viewer is initially set or subsequently changed.
`protected void`	`internalRevealRange(int start, int end)`	Reveals the given range of the visible document.
`void`	`invalidateTextPresentation()`	Marks the currently applied text presentation as invalid.
`void`	`invalidateTextPresentation(int offset, int length)`	Invalidates the given range of the text presentation.
`protected boolean`	`isBlockSelected()`	A block is selected if the character preceding the start of the selection is a new line character.
`boolean`	`isEditable()`	Returns whether the shown text can be manipulated.
`protected boolean`	`isIgnoringAutoEditStrategies()`	Returns whether this viewer ignores the registered auto edit strategies.
`protected boolean`	`isPrintable()`	Returns whether the shown text can be printed.
`protected void`	`markChanged(int offset, int length)`	Sends out a mark selection changed event to all registered listeners.
`int`	`modelLine2WidgetLine(int modelLine)`	Implements the contract of `ITextViewerExtension5.modelLine2WidgetLine(int)`.
`int`	`modelOffset2WidgetOffset(int modelOffset)`	Implements the contract of `ITextViewerExtension5.modelOffset2WidgetOffset(int)`.
`protected IRegion`	`modelRange2ClosestWidgetRange(IRegion modelRange)`	Similar to `modelRange2WidgetRange(IRegion)`, but more forgiving: if `modelRange` describes a region entirely hidden in the image, then this method returns the zero-length region at the offset of the folded region.
`IRegion`	`modelRange2WidgetRange(IRegion modelRange)`	Implements the contract of `ITextViewerExtension5.modelRange2WidgetRange(IRegion)`.
`protected IRegion`	`modelRange2WidgetRange(Position modelPosition)`	Same as `modelRange2WidgetRange(IRegion)` just for a `Position`.
`protected Point`	`modelSelection2WidgetSelection(Point modelSelection)`	Translates the given selection range of the viewer's document into the corresponding widget range or returns `null` of this fails.
`protected StyleRange`	`modelStyleRange2WidgetStyleRange(StyleRange range)`	Translates a style range given relative to the viewer's document into style ranges relative to the viewer's widget or `null`.
`boolean`	`moveFocusToWidgetToken()`	Instructs the receiver to request the `IWidgetTokenKeeper` currently holding the widget token to take the keyboard focus.
`boolean`	`overlapsWithVisibleRegion(int start, int length)`	Returns whether a given range overlaps with the visible region of this viewer's document.
`void`	`prependAutoEditStrategy(IAutoEditStrategy strategy, String contentType)`	Prepends the given auto edit strategy to the existing list of strategies for the specified content type.
`void`	`prependVerifyKeyListener(VerifyKeyListener listener)`	Inserts the verify key listener at the beginning of the viewer's list of verify key listeners.
`protected void`	`print()`	Brings up a print dialog and calls `printContents(Printer)` which performs the actual print.
`void`	`print(StyledTextPrintOptions options)`	Print the text viewer contents using the given options.
`protected boolean`	`redraws()`	Returns whether this viewer redraws itself.
`void`	`refresh()`	Refreshes this viewer completely with information freshly obtained from this viewer's model.
`void`	`register(IEditingSupport helper)`	Register a support with the registry.
`void`	`releaseWidgetToken(IWidgetTokenKeeper tokenKeeper)`	The given token keeper releases the token to this token owner.
`void`	`removeAutoEditStrategy(IAutoEditStrategy strategy, String contentType)`	Removes the first occurrence of the given auto edit strategy in the list of strategies registered under the specified content type.
`void`	`removePainter(IPainter painter)`	Removes the given painter from this viewer.
`void`	`removePostSelectionChangedListener(ISelectionChangedListener listener)`	Removes the given listener for post selection changes from this selection provider.
`void`	`removeTextHovers(String contentType)`	Removes all text hovers for the given content type independent from their state mask.
`void`	`removeTextInputListener(ITextInputListener listener)`	Removes the given listener from this viewer's set of text input listeners.
`void`	`removeTextListener(ITextListener listener)`	Removes the given listener from this viewer's set of text listeners.
`void`	`removeTextPresentationListener(ITextPresentationListener listener)`	Removes the given text presentation listener from this text viewer.
`void`	`removeVerifyKeyListener(VerifyKeyListener listener)`	Removes the verify key listener from the viewer's list of verify key listeners.
`void`	`removeViewportListener(IViewportListener listener)`	Removes the given listener from this viewer's set of view port listeners.
`boolean`	`requestWidgetToken(IWidgetTokenKeeper requester)`	Requests the widget token from this token owner.
`boolean`	`requestWidgetToken(IWidgetTokenKeeper requester, int priority)`	Requests the widget token from this token owner.
`void`	`resetPlugins()`	Resets the installed plug-ins.
`void`	`resetVisibleRegion()`	Resets the region of this viewer's document which is visible in the presentation.
`void`	`revealRange(int start, int length)`	Ensures that the given range is visible.
`protected Object`	`selectContentTypePlugin(int offset, Map<String,?> plugins)`	Selects from the given map the one which is registered under the content type of the partition in which the given offset is located.
`protected void`	`selectionChanged(int offset, int length)`	Sends out a text selection changed event to all registered listeners and registers the selection changed event to be sent out to all post selection listeners.
`protected void`	`setAutoEditStrategies(IAutoEditStrategy[] strategies, String contentType)`	Sets the given edit strategy as the only strategy for the given content type.
`void`	`setAutoIndentStrategy(IAutoIndentStrategy strategy, String contentType)`	Deprecated. since 3.1, use `ITextViewerExtension2.prependAutoEditStrategy(IAutoEditStrategy, String)` and `ITextViewerExtension2.removeAutoEditStrategy(IAutoEditStrategy, String)` instead
`void`	`setDefaultPrefixes(String[] defaultPrefixes, String contentType)`	Sets the strings that are used as prefixes when lines of the given content type are prefixed using the prefix text operation.
`void`	`setDocument(IDocument document)`	Sets the given document as the text viewer's model and updates the presentation accordingly.
`void`	`setDocument(IDocument document, int modelRangeOffset, int modelRangeLength)`	Sets the given document as this viewer's model and exposes the specified region.
`void`	`setDocumentPartitioning(String partitioning)`	Sets the document partitioning of this viewer.
`void`	`setEditable(boolean editable)`	Sets the editable state.
`void`	`setEventConsumer(IEventConsumer consumer)`	Registers an event consumer with this viewer.
`void`	`setHoverControlCreator(IInformationControlCreator creator)`	Sets the creator for the hover controls.
`void`	`setHoverEnrichMode(ITextViewerExtension8.EnrichMode mode)`	Sets the hover enrich mode.
`void`	`setHyperlinkDetectors(IHyperlinkDetector[] hyperlinkDetectors, int eventStateMask)`	Sets this viewer's hyperlink detectors for the given state mask.
`void`	`setHyperlinkPresenter(IHyperlinkPresenter hyperlinkPresenter)`	Sets the hyperlink presenter.
`void`	`setIndentPrefixes(String[] indentPrefixes, String contentType)`	Sets the strings that are used as prefixes when lines of the given content type are shifted using the shift text operation.
`void`	`setInput(Object input)`	Sets or clears the input for this viewer.
`void`	`setMark(int offset)`	Sets a mark at the given offset or clears the mark if the specified offset is `-1`.
`void`	`setRedraw(boolean redraw)`	Enables/disables the redrawing of this text viewer.
`protected void`	`setRedraw(boolean redraw, int topIndex)`	Basically same functionality as `ITextViewerExtension.setRedraw(boolean)`.
`void`	`setSelectedRange(int selectionOffset, int selectionLength)`	Sets the selection to the specified range.
`void`	`setSelection(ISelection selection, boolean reveal)`	Sets a new selection for this viewer and optionally makes it visible.
`void`	`setTabsToSpacesConverter(IAutoEditStrategy converter)`	Sets an auto edit strategy can converts tabs to spaces.
`void`	`setTextColor(Color color)`	Applies the given color as text foreground color to this viewer's selection.
`void`	`setTextColor(Color color, int start, int length, boolean controlRedraw)`	Applies the given color as text foreground color to the specified section of this viewer.
`void`	`setTextDoubleClickStrategy(ITextDoubleClickStrategy strategy, String contentType)`	Sets this viewer's text double click strategy for the given content type.
`void`	`setTextHover(ITextHover hover, String contentType)`	Sets this viewer's text hover for the given content type.
`void`	`setTextHover(ITextHover hover, String contentType, int stateMask)`	Sets this viewer's text hover for the given content type and the given state mask.
`void`	`setTopIndex(int index)`	Scrolls the widget so that the given index is the line with the smallest line number of all visible lines.
`void`	`setUndoManager(IUndoManager undoManager)`	Sets this viewer's undo manager.
`protected void`	`setVisibleDocument(IDocument document)`	Sets this viewer's visible document.
`void`	`setVisibleRegion(int start, int length)`	Defines and sets the region of this viewer's document which will be visible in the presentation.
`protected void`	`shift(boolean useDefaultPrefixes, boolean right)`	Deprecated. use shift(boolean, boolean, boolean) instead
`protected void`	`shift(boolean useDefaultPrefixes, boolean right, boolean ignoreWhitespace)`	Shifts a text block to the right or left using the specified set of prefix characters.
`protected void`	`startSequentialRewriteMode(boolean normalized)`	Deprecated. since 3.1 use `IDocumentExtension4.startRewriteSession(DocumentRewriteSessionType)` instead
`protected void`	`stopSequentialRewriteMode()`	Deprecated. since 3.1 use `IDocumentExtension4.stopRewriteSession(DocumentRewriteSession)` instead
`void`	`unregister(IEditingSupport helper)`	Deregister a support with the registry.
`protected boolean`	`updateSlaveDocument(IDocument slaveDocument, int modelRangeOffset, int modelRangeLength)`	Updates the given slave document to show the specified range of its master document.
`protected void`	`updateTextListeners(TextViewer.WidgetCommand cmd)`	Informs all registered text listeners about the change specified by the widget command.
`protected void`	`updateViewportListeners(int origin)`	Checks whether the view port changed and if so informs all registered listeners about the change.
`protected boolean`	`updateVisibleDocument(IDocument visibleDocument, int visibleRegionOffset, int visibleRegionLength)`	Deprecated. use `updateSlaveDocument` instead
`protected void`	`validateSelectionRange(int[] selectionRange)`	Validates and adapts the given selection range if it is not a valid widget selection.
`int`	`widgetLine2ModelLine(int widgetLine)`	Implements the contract of `ITextViewerExtension5.widgetLine2ModelLine(int)`.
`int`	`widgetLineOfWidgetOffset(int widgetOffset)`	Implements the contract of `ITextViewerExtension5.widgetLineOfWidgetOffset(int)`.
`int`	`widgetlLine2ModelLine(int widgetLine)`	Implements the contract of `ITextViewerExtension5.widgetLine2ModelLine(int)`.
`int`	`widgetOffset2ModelOffset(int widgetOffset)`	Implements the contract of `ITextViewerExtension5.widgetOffset2ModelOffset(int)`.
`IRegion`	`widgetRange2ModelRange(IRegion widgetRange)`	Implements the contract of `ITextViewerExtension5.widgetRange2ModelRange(IRegion)`.
`protected Point`	`widgetSelection2ModelSelection(Point widgetSelection)`	Translates the given widget selection into the corresponding region of the viewer's document or returns `null` if this fails.

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

- Field Detail
  - TRACE_ERRORS
```
public static final boolean TRACE_ERRORS
```
    Internal flag to indicate the debug state.
    
    See Also:
    
    Constant Field Values
  - SCROLLER
```
protected static final int SCROLLER
```
    Identifies the scrollbars as originators of a view port change.
    
    See Also:
    
    Constant Field Values
  - MOUSE
```
protected static final int MOUSE
```
    Identifies mouse moves as originators of a view port change.
    
    See Also:
    
    Constant Field Values
  - MOUSE_END
```
protected static final int MOUSE_END
```
    Identifies mouse button up as originator of a view port change.
    
    See Also:
    
    Constant Field Values
  - KEY
```
protected static final int KEY
```
    Identifies key strokes as originators of a view port change.
    
    See Also:
    
    Constant Field Values
  - RESIZE
```
protected static final int RESIZE
```
    Identifies window resizing as originator of a view port change.
    
    See Also:
    
    Constant Field Values
  - INTERNAL
```
protected static final int INTERNAL
```
    Identifies internal reasons as originators of a view port change.
    
    See Also:
    
    Constant Field Values
  - SHIFTING
```
protected static final String SHIFTING
```
    Internal name of the position category used selection preservation during shift.
    
    See Also:
    
    Constant Field Values
  - fMarkPosition
```
protected Position fMarkPosition
```
    The mark position.
    
    Since:
    
    2.0
  - fIgnoreAutoIndent
```
protected boolean fIgnoreAutoIndent
```
    Should the auto indent strategies ignore the next edit operation
  - fIndentChars
```
protected Map<String,String[]> fIndentChars
```
    The strings a line is prefixed with on SHIFT_RIGHT and removed from each line on SHIFT_LEFT
  - fDefaultPrefixChars
```
protected Map<String,String[]> fDefaultPrefixChars
```
    The string a line is prefixed with on PREFIX and removed from each line on STRIP_PREFIX
  - fDoubleClickStrategies
```
protected Map<String,ITextDoubleClickStrategy> fDoubleClickStrategies
```
    The text viewer's text double click strategies
  - fUndoManager
```
protected IUndoManager fUndoManager
```
    The text viewer's undo manager
  - fAutoIndentStrategies
```
protected Map<String,List<IAutoEditStrategy>> fAutoIndentStrategies
```
    The text viewer's auto indent strategies
  - fTextHovers
```
protected Map<TextViewer.TextHoverKey,ITextHover> fTextHovers
```
    The text viewer's text hovers
  - fViewportListeners
```
protected List<IViewportListener> fViewportListeners
```
    All registered view port listeners
  - fLastTopPixel
```
protected int fLastTopPixel
```
    The last visible vertical position of the top line
  - fTextListeners
```
protected List<ITextListener> fTextListeners
```
    All registered text listeners
  - fTextInputListeners
```
protected List<ITextInputListener> fTextInputListeners
```
    All registered text input listeners
  - fEventConsumer
```
protected IEventConsumer fEventConsumer
```
    The text viewer's event consumer
  - fReplaceTextPresentation
```
protected boolean fReplaceTextPresentation
```
    Indicates whether the viewer's text presentation should be replaced are modified.
  - fHoverControlCreator
```
protected IInformationControlCreator fHoverControlCreator
```
    The creator of the text hover control
    
    Since:
    
    2.0
  - fInformationMapping
```
protected IDocumentInformationMapping fInformationMapping
```
    The mapping between model and visible document.
    
    Since:
    
    2.1
  - fPaintManager
```
protected PaintManager fPaintManager
```
    The viewer's paint manager.
    
    Since:
    
    2.1
  - fPartitioning
```
protected String fPartitioning
```
    The viewers partitioning. I.e. the partitioning name the viewer uses to access partitioning information of its input document.
    
    Since:
    
    3.0
  - fTextPresentationListeners
```
protected List<ITextPresentationListener> fTextPresentationListeners
```
    All registered text presentation listeners. since 3.0
  - fFindReplaceDocumentAdapter
```
protected FindReplaceDocumentAdapter fFindReplaceDocumentAdapter
```
    The find/replace document adapter.
    
    Since:
    
    3.0
  - fHyperlinkDetectors
```
protected IHyperlinkDetector[] fHyperlinkDetectors
```
    The text viewer's hyperlink detectors.
    
    Since:
    
    3.1
  - fHyperlinkPresenter
```
protected IHyperlinkPresenter fHyperlinkPresenter
```
    The text viewer's hyperlink presenter.
    
    Since:
    
    3.1
  - fHyperlinkManager
```
protected HyperlinkManager fHyperlinkManager
```
    The text viewer's hyperlink manager.
    
    Since:
    
    3.1
  - fHyperlinkStateMask
```
protected int fHyperlinkStateMask
```
    The SWT key modifier mask which in combination with the left mouse button triggers the hyperlink mode.
    
    Since:
    
    3.1
- Constructor Detail
  - TextViewer
```
protected TextViewer()
```
    Internal use only
  - TextViewer
```
public TextViewer(Composite parent,
                  int styles)
```
    Create a new text viewer with the given SWT style bits. The viewer is ready to use but does not have any plug-in installed.
    
    Parameters:
    
    parent - the parent of the viewer's control
    
    styles - the SWT style bits for the viewer's control, if SWT.WRAP is set then a custom document adapter needs to be provided, see createDocumentAdapter()
- Method Detail
  - createTextWidget
```
protected StyledText createTextWidget(Composite parent,
                                      int styles)
```
    Factory method to create the text widget to be used as the viewer's text widget.
    
    Parameters:
    
    parent - the parent of the styled text
    
    styles - the styles for the styled text
    
    Returns:
    
    the text widget to be used
  - createDocumentAdapter
```
protected IDocumentAdapter createDocumentAdapter()
```
    Factory method to create the document adapter to be used by this viewer.
    
    Returns:
    
    the document adapter to be used
  - createControl
```
protected void createControl(Composite parent,
                             int styles)
```
    Creates the viewer's SWT control. The viewer's text widget either is the control or is a child of the control.
    
    Parameters:
    
    parent - the parent of the viewer's control
    
    styles - the SWT style bits for the viewer's control
  - getControl
```
public Control getControl()
```
    Description copied from class: Viewer
    
    Returns the primary control associated with this viewer.
    
    Specified by:
    
    getControl in interface ITextViewerExtension
    
    Specified by:
    
    getControl in class Viewer
    
    Returns:
    
    the SWT control which displays this viewer's content
  - 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 interface ITextViewer
  - resetPlugins
```
public void resetPlugins()
```
    Description copied from interface: ITextViewer
    
    Resets the installed plug-ins. If plug-ins change their state or behavior over the course of time, this method causes them to be set back to their initial state and behavior. E.g., if an IUndoManager has been installed on this text viewer, the manager's list of remembered text editing operations is removed.
    
    Specified by:
    
    resetPlugins in interface ITextViewer
  - handleDispose
```
protected void handleDispose()
```
    Frees all resources allocated by this viewer. Internally called when the viewer's control has been disposed.
  - getTextWidget
```
public StyledText getTextWidget()
```
    Description copied from interface: ITextViewer
    
    Returns this viewer's SWT control, null if the control is disposed.
    Calling API directly on the widget can interfere with features provided by a text viewer. Clients who call API directly on the widget are responsible to resolve such conflicts on their side.
    
    Specified by:
    
    getTextWidget in interface ITextViewer
    
    Returns:
    
    the SWT control or null
  - getEmptySelectionChangedEventDelay
```
protected int getEmptySelectionChangedEventDelay()
```
    The delay in milliseconds before an empty selection changed event is sent by the cursor listener.
    Note: The return value is used to initialize the cursor listener. To return a non-constant value has no effect.
    
    This implementation returns OpenStrategy.getPostSelectionDelay().
    
    Returns:
    
    delay in milliseconds
    
    Since:
    
    3.0
    
    See Also:
    
    OpenStrategy
  - setAutoIndentStrategy
```
@Deprecated
public void setAutoIndentStrategy(IAutoIndentStrategy strategy,
                                  String contentType)
```
    Deprecated.
    since 3.1, use ITextViewerExtension2.prependAutoEditStrategy(IAutoEditStrategy, String) and ITextViewerExtension2.removeAutoEditStrategy(IAutoEditStrategy, String) instead
    Sets this viewer's auto indent strategy for the given content type. If the given strategy is null any installed strategy for the content type is removed. This method has been replaced by ITextViewerExtension2.prependAutoEditStrategy(IAutoEditStrategy, String) and ITextViewerExtension2.removeAutoEditStrategy(IAutoEditStrategy, String). It is now equivalent to
    ITextViewerExtension2 extension= (ITextViewerExtension2) viewer; extension.removeAutoEditStrategy(oldStrategy, contentType); extension.prependAutoEditStrategy(strategy, contentType);
    Specified by:
    
    setAutoIndentStrategy in interface ITextViewer
    
    Parameters:
    
    strategy - the new auto indent strategy. null is a valid argument.
    
    contentType - the type for which the strategy is registered
  - setAutoEditStrategies
```
protected final void setAutoEditStrategies(IAutoEditStrategy[] strategies,
                                           String contentType)
```
    Sets the given edit strategy as the only strategy for the given content type.
    
    Parameters:
    
    strategies - the auto edit strategies
    
    contentType - the content type
    
    Since:
    
    3.1
  - prependAutoEditStrategy
```
public void prependAutoEditStrategy(IAutoEditStrategy strategy,
                                    String contentType)
```
    Description copied from interface: ITextViewerExtension2
    
    Prepends the given auto edit strategy to the existing list of strategies for the specified content type. The strategies are called in the order in which they appear in the list of strategies.
    
    Specified by:
    
    prependAutoEditStrategy in interface ITextViewerExtension2
    
    Parameters:
    
    strategy - the auto edit strategy
    
    contentType - the content type
  - removeAutoEditStrategy
```
public void removeAutoEditStrategy(IAutoEditStrategy strategy,
                                   String contentType)
```
    Description copied from interface: ITextViewerExtension2
    
    Removes the first occurrence of the given auto edit strategy in the list of strategies registered under the specified content type.
    
    Specified by:
    
    removeAutoEditStrategy in interface ITextViewerExtension2
    
    Parameters:
    
    strategy - the auto edit strategy
    
    contentType - the content type
  - setEventConsumer
```
public void setEventConsumer(IEventConsumer consumer)
```
    Description copied from interface: ITextViewer
    
    Registers an event consumer with this viewer. This method has been replaces with the VerifyKeyListener management methods in ITextViewerExtension.
    
    Specified by:
    
    setEventConsumer in interface ITextViewer
    
    Parameters:
    
    consumer - the viewer's event consumer. null is a valid argument.
  - setIndentPrefixes
```
public void setIndentPrefixes(String[] indentPrefixes,
                              String contentType)
```
    Description copied from interface: ITextViewer
    
    Sets the strings that are used as prefixes when lines of the given content type are shifted using the shift text operation. The prefixes are considered equivalent. Thus "\t" and " " can both be used as prefix characters. Shift right always inserts the indentPrefixes[0]. Shift left removes all of the specified prefixes.
    
    Specified by:
    
    setIndentPrefixes in interface ITextViewer
    
    Parameters:
    
    indentPrefixes - the prefixes to be used
    
    contentType - the content type for which the prefixes are specified
  - getTopInset
```
public int getTopInset()
```
    Description copied from interface: ITextViewer
    
    Returns the vertical offset of the first visible line.
    
    Specified by:
    
    getTopInset in interface ITextViewer
    
    Returns:
    
    the vertical offset of the first visible line
  - isEditable
```
public boolean isEditable()
```
    Description copied from interface: ITextViewer
    
    Returns whether the shown text can be manipulated.
    
    Specified by:
    
    isEditable in interface ITextViewer
    
    Returns:
    
    the viewer's editable state
  - setEditable
```
public void setEditable(boolean editable)
```
    Description copied from interface: ITextViewer
    
    Sets the editable state.
    
    Specified by:
    
    setEditable in interface ITextViewer
    
    Parameters:
    
    editable - the editable state
  - setDefaultPrefixes
```
public void setDefaultPrefixes(String[] defaultPrefixes,
                               String contentType)
```
    Description copied from interface: ITextViewer
    
    Sets the strings that are used as prefixes when lines of the given content type are prefixed using the prefix text operation. The prefixes are considered equivalent. Inserting a prefix always inserts the defaultPrefixes[0]. Removing a prefix removes all of the specified prefixes.
    
    Specified by:
    
    setDefaultPrefixes in interface ITextViewer
    
    Parameters:
    
    defaultPrefixes - the prefixes to be used
    
    contentType - the content type for which the prefixes are specified
  - setUndoManager
```
public void setUndoManager(IUndoManager undoManager)
```
    Description copied from interface: ITextViewer
    
    Sets this viewer's undo manager.
    
    Specified by:
    
    setUndoManager in interface ITextViewer
    
    Parameters:
    
    undoManager - the new undo manager. null is a valid argument.
  - getUndoManager
```
public IUndoManager getUndoManager()
```
    Description copied from interface: ITextViewerExtension6
    
    Returns this viewer's undo manager.
    
    Specified by:
    
    getUndoManager in interface ITextViewerExtension6
    
    Returns:
    
    the undo manager or null if it has not been plugged-in
  - setTextHover
```
public void setTextHover(ITextHover hover,
                         String contentType)
```
    Description copied from interface: ITextViewer
    Sets this viewer's text hover for the given content type.
    This method has been replaced by ITextViewerExtension2.setTextHover(ITextHover, String, int). It is now equivalent to
    ITextViewerExtension2 extension= (ITextViewerExtension2) document; extension.setTextHover(textViewerHover, contentType, ITextViewerExtension2#DEFAULT_HOVER_STATE_MASK);
    Specified by:
    
    setTextHover in interface ITextViewer
    
    Parameters:
    
    hover - the new hover. null is a valid argument.
    
    contentType - the type for which the hover is registered
  - setTextHover
```
public void setTextHover(ITextHover hover,
                         String contentType,
                         int stateMask)
```
    Description copied from interface: ITextViewerExtension2
    
    Sets this viewer's text hover for the given content type and the given state mask. If the given text hover is null, any hover installed for the given content type and state mask is removed.
    
    Specified by:
    
    setTextHover in interface ITextViewerExtension2
    
    Parameters:
    
    hover - the new hover or null
    
    contentType - the type for which the hover is to be registered or unregistered
    
    stateMask - the SWT event state mask; DEFAULT_HOVER_STATE_MASK indicates that the hover is installed as the default hover.
  - removeTextHovers
```
public void removeTextHovers(String contentType)
```
    Description copied from interface: ITextViewerExtension2
    
    Removes all text hovers for the given content type independent from their state mask.
    Note: To remove a hover for a given content type and state mask use ITextViewerExtension2.setTextHover(ITextHover, String, int) with null as parameter for the text hover.
    
    Specified by:
    
    removeTextHovers in interface ITextViewerExtension2
    
    Parameters:
    
    contentType - the type for which all text hovers are to be unregistered
  - getTextHover
```
protected ITextHover getTextHover(int offset)
```
    Returns the text hover for a given offset.
    
    Parameters:
    
    offset - the offset for which to return the text hover
    
    Returns:
    
    the text hover for the given offset
  - getTextHover
```
protected ITextHover getTextHover(int offset,
                                  int stateMask)
```
    Returns the text hover for a given offset and a given state mask.
    
    Parameters:
    
    offset - the offset for which to return the text hover
    
    stateMask - the SWT event state mask
    
    Returns:
    
    the text hover for the given offset and state mask
    
    Since:
    
    2.1
  - getTextHoveringController
```
protected AbstractInformationControlManager getTextHoveringController()
```
    Returns the text hovering controller of this viewer.
    
    Returns:
    
    the text hovering controller of this viewer
    
    Since:
    
    2.0
  - setHoverControlCreator
```
public void setHoverControlCreator(IInformationControlCreator creator)
```
    Sets the creator for the hover controls.
    
    Parameters:
    
    creator - the hover control creator
    
    Since:
    
    2.0
  - setHoverEnrichMode
```
public void setHoverEnrichMode(ITextViewerExtension8.EnrichMode mode)
```
    Sets the hover enrich mode. A non-null mode defines when hovers should be enriched once the mouse is moved into them. If mode is null, hovers are automatically closed when the mouse is moved out of the hover region.
    Note that a hover can only be enriched if its IInformationControlExtension5.getInformationPresenterControlCreator() is not null.
    
    Specified by:
    
    setHoverEnrichMode in interface ITextViewerExtension8
    
    Parameters:
    
    mode - the enrich mode, or null
    
    Since:
    
    3.4
  - requestWidgetToken
```
public boolean requestWidgetToken(IWidgetTokenKeeper requester)
```
    Description copied from interface: IWidgetTokenOwner
    
    Requests the widget token from this token owner. Returns true if the token has been acquired or is already owned by the requester. This method is non-blocking.
    Replaced by IWidgetTokenOwnerExtension.requestWidgetToken(IWidgetTokenKeeper, int).
    
    Specified by:
    
    requestWidgetToken in interface IWidgetTokenOwner
    
    Parameters:
    
    requester - the token requester
    
    Returns:
    
    true if requester acquires the token, false otherwise
  - requestWidgetToken
```
public boolean requestWidgetToken(IWidgetTokenKeeper requester,
                                  int priority)
```
    Description copied from interface: IWidgetTokenOwnerExtension
    
    Requests the widget token from this token owner. Returns true if the token has been acquired or is already owned by the requester. This method is non-blocking.
    priority is forwarded to any existing token keeper to give it an estimate on whether the request has higher priority than the current keeper's. There is, however, no guarantee that another keeper will release the token even if it has a high priority.
    
    Specified by:
    
    requestWidgetToken in interface IWidgetTokenOwnerExtension
    
    Parameters:
    
    requester - the token requester
    
    priority - the priority of the request
    
    Returns:
    
    true if requester acquires the token, false otherwise
  - releaseWidgetToken
```
public void releaseWidgetToken(IWidgetTokenKeeper tokenKeeper)
```
    Description copied from interface: IWidgetTokenOwner
    
    The given token keeper releases the token to this token owner. If the token has previously not been held by the given token keeper, nothing happens. This method is non-blocking.
    
    Specified by:
    
    releaseWidgetToken in interface IWidgetTokenOwner
    
    Parameters:
    
    tokenKeeper - the token keeper
  - getLastKnownSelection
```
public ITextSelection getLastKnownSelection()
```
    Description copied from interface: ITextViewerExtension9
    
    Returns the last known selection from a cache, without polling widget.
    This may not be the current selection. Indeed, operations that change the selection without sending related events may not refresh the returned value.
    
    As opposed to ISelectionProvider.getSelection() that usually requires UI Thread, this method can run from any thread.
    
    Specified by:
    
    getLastKnownSelection in interface ITextViewerExtension9
    
    Returns:
    
    the last known selection.
  - getSelectedRange
```
public Point getSelectedRange()
```
    Description copied from interface: ITextViewer
    
    Returns the range of the current selection in coordinates of this viewer's document.
    
    Specified by:
    
    getSelectedRange in interface ITextViewer
    
    Returns:
    
    a Point with x as the offset and y as the length of the current selection
  - setSelectedRange
```
public void setSelectedRange(int selectionOffset,
                             int selectionLength)
```
    Description copied from interface: ITextViewer
    
    Sets the selection to the specified range.
    
    Specified by:
    
    setSelectedRange in interface ITextViewer
    
    Parameters:
    
    selectionOffset - the offset of the selection range
    
    selectionLength - the length of the selection range. A negative length places the caret at the visual start of the selection.
  - validateSelectionRange
```
protected void validateSelectionRange(int[] selectionRange)
```
    Validates and adapts the given selection range if it is not a valid widget selection. The widget selection is invalid if it starts or ends inside a multi-character line delimiter. If so, the selection is adapted to start after the divided line delimiter and to end before the divided line delimiter. The parameter passed in is changed in-place when being adapted. An adaptation to [-1, -1] indicates that the selection range could not be validated. Subclasses may reimplement this method.
    
    Parameters:
    
    selectionRange - selectionRange[0] is the offset, selectionRange[1] the length of the selection to validate.
    
    Since:
    
    2.0
  - setSelection
```
public void setSelection(ISelection selection,
                         boolean reveal)
```
    Description copied from class: Viewer
    
    Sets a new selection for this viewer and optionally makes it visible.
    Subclasses must implement this method.
    
    Specified by:
    
    setSelection in class Viewer
    
    Parameters:
    
    selection - the new selection
    
    reveal - true if the selection is to be made visible, and false otherwise
  - getSelection
```
public ISelection getSelection()
```
    Description copied from interface: ISelectionProvider
    
    Returns the current selection for this provider.
    
    Specified by:
    
    getSelection in interface ISelectionProvider
    
    Specified by:
    
    getSelection in class Viewer
    
    Returns:
    
    the current selection
  - getSelectionProvider
```
public ISelectionProvider getSelectionProvider()
```
    Description copied from interface: ITextViewer
    
    Returns a selection provider dedicated to this viewer. Subsequent calls to this method return always the same selection provider.
    
    Specified by:
    
    getSelectionProvider in interface ITextViewer
    
    Returns:
    
    this viewer's selection provider
  - addPostSelectionChangedListener
```
public void addPostSelectionChangedListener(ISelectionChangedListener listener)
```
    Description copied from interface: IPostSelectionProvider
    
    Adds a listener for post selection changes in this selection provider. Has no effect if an identical listener is already registered.
    
    Specified by:
    
    addPostSelectionChangedListener in interface IPostSelectionProvider
    
    Parameters:
    
    listener - a selection changed listener
  - removePostSelectionChangedListener
```
public void removePostSelectionChangedListener(ISelectionChangedListener listener)
```
    Description copied from interface: IPostSelectionProvider
    
    Removes the given listener for post selection changes from this selection provider. Has no effect if an identical listener is not registered.
    
    Specified by:
    
    removePostSelectionChangedListener in interface IPostSelectionProvider
    
    Parameters:
    
    listener - a selection changed listener
  - firePostSelectionChanged
```
protected void firePostSelectionChanged(int offset,
                                        int length)
```
    Sends out a text selection changed event to all registered post selection changed listeners.
    
    Parameters:
    
    offset - the offset of the newly selected range in the visible document
    
    length - the length of the newly selected range in the visible document
    
    Since:
    
    3.0
  - selectionChanged
```
protected void selectionChanged(int offset,
                                int length)
```
    Sends out a text selection changed event to all registered listeners and registers the selection changed event to be sent out to all post selection listeners.
    
    Parameters:
    
    offset - the offset of the newly selected range in the visible document
    
    length - the length of the newly selected range in the visible document
  - fireSelectionChanged
```
protected void fireSelectionChanged(int offset,
                                    int length)
```
    Sends out a text selection changed event to all registered listeners.
    
    Parameters:
    
    offset - the offset of the newly selected range in the visible document
    
    length - the length of the newly selected range in the visible document
    
    Since:
    
    3.0
  - markChanged
```
protected void markChanged(int offset,
                           int length)
```
    Sends out a mark selection changed event to all registered listeners.
    
    Parameters:
    
    offset - the offset of the mark selection in the visible document, the offset is -1 if the mark was cleared
    
    length - the length of the mark selection, may be negative if the caret is before the mark.
    
    Since:
    
    2.0
  - addTextListener
```
public void addTextListener(ITextListener listener)
```
    Description copied from interface: ITextViewer
    
    Adds a text listener to this viewer. If the listener is already registered with this viewer, this call has no effect.
    
    Specified by:
    
    addTextListener in interface ITextViewer
    
    Parameters:
    
    listener - the listener to be added
  - removeTextListener
```
public void removeTextListener(ITextListener listener)
```
    Description copied from interface: ITextViewer
    
    Removes the given listener from this viewer's set of text listeners. If the listener is not registered with this viewer, this call has no effect.
    
    Specified by:
    
    removeTextListener in interface ITextViewer
    
    Parameters:
    
    listener - the listener to be removed
  - updateTextListeners
```
protected void updateTextListeners(TextViewer.WidgetCommand cmd)
```
    Informs all registered text listeners about the change specified by the widget command. This method does not use a robust iterator.
    
    Parameters:
    
    cmd - the widget command translated into a text event sent to all text listeners
  - addTextInputListener
```
public void addTextInputListener(ITextInputListener listener)
```
    Description copied from interface: ITextViewer
    
    Adds a text input listener to this viewer. If the listener is already registered with this viewer, this call has no effect.
    
    Specified by:
    
    addTextInputListener in interface ITextViewer
    
    Parameters:
    
    listener - the listener to be added
  - removeTextInputListener
```
public void removeTextInputListener(ITextInputListener listener)
```
    Description copied from interface: ITextViewer
    
    Removes the given listener from this viewer's set of text input listeners. If the listener is not registered with this viewer, this call has no effect.
    
    Specified by:
    
    removeTextInputListener in interface ITextViewer
    
    Parameters:
    
    listener - the listener to be removed
  - fireInputDocumentAboutToBeChanged
```
protected void fireInputDocumentAboutToBeChanged(IDocument oldInput,
                                                 IDocument newInput)
```
    Informs all registered text input listeners about the forthcoming input change, This method does not use a robust iterator.
    
    Parameters:
    
    oldInput - the old input document
    
    newInput - the new input document
  - fireInputDocumentChanged
```
protected void fireInputDocumentChanged(IDocument oldInput,
                                        IDocument newInput)
```
    Informs all registered text input listeners about the successful input change, This method does not use a robust iterator.
    
    Parameters:
    
    oldInput - the old input document
    
    newInput - the new input document
  - getInput
```
public Object getInput()
```
    Description copied from interface: IInputProvider
    
    Returns the input.
    
    Specified by:
    
    getInput in interface IInputProvider
    
    Specified by:
    
    getInput in class Viewer
    
    Returns:
    
    the input object
  - getDocument
```
public IDocument getDocument()
```
    Description copied from interface: ITextViewer
    
    Returns the text viewer's input document.
    
    Specified by:
    
    getDocument in interface ITextViewer
    
    Returns:
    
    the viewer's input document or null if none
  - setInput
```
public void setInput(Object input)
```
    Description copied from class: Viewer
    
    Sets or clears the input for this viewer.
    
    Specified by:
    
    setInput in class Viewer
    
    Parameters:
    
    input - the input of this viewer, or null if none
  - setDocument
```
public void setDocument(IDocument document)
```
    Description copied from interface: ITextViewer
    
    Sets the given document as the text viewer's model and updates the presentation accordingly. An appropriate TextEvent is issued. This text event does not carry a related document event.
    
    Specified by:
    
    setDocument in interface ITextViewer
    
    Parameters:
    
    document - the viewer's new input document null if none
  - setDocument
```
public void setDocument(IDocument document,
                        int modelRangeOffset,
                        int modelRangeLength)
```
    Description copied from interface: ITextViewer
    
    Sets the given document as this viewer's model and exposes the specified region. An appropriate TextEvent is issued. The text event does not carry a related document event. This method is a convenience method for setDocument(document);setVisibleRegion(offset, length).
    
    Specified by:
    
    setDocument in interface ITextViewer
    
    Parameters:
    
    document - the new input document or null if none
    
    modelRangeOffset - the offset of the model range
    
    modelRangeLength - the length of the model range
  - createSlaveDocument
```
protected IDocument createSlaveDocument(IDocument document)
```
    Creates a slave document for the given document if there is a slave document manager associated with this viewer.
    
    Parameters:
    
    document - the master document
    
    Returns:
    
    the newly created slave document
    
    Since:
    
    2.1
  - updateVisibleDocument
```
@Deprecated
protected boolean updateVisibleDocument(IDocument visibleDocument,
                                        int visibleRegionOffset,
                                        int visibleRegionLength)
                                 throws BadLocationException
```
    Deprecated.
    use updateSlaveDocument instead
    
    Sets the given slave document to the specified range of its master document.
    
    Parameters:
    
    visibleDocument - the slave document
    
    visibleRegionOffset - the offset of the master document range
    
    visibleRegionLength - the length of the master document range
    
    Returns:
    
    true if the slave has been adapted successfully
    
    Throws:
    
    BadLocationException - in case the specified range is not valid in the master document
    
    Since:
    
    2.1
  - updateSlaveDocument
```
protected boolean updateSlaveDocument(IDocument slaveDocument,
                                      int modelRangeOffset,
                                      int modelRangeLength)
                               throws BadLocationException
```
    Updates the given slave document to show the specified range of its master document.
    
    Parameters:
    
    slaveDocument - the slave document
    
    modelRangeOffset - the offset of the master document range
    
    modelRangeLength - the length of the master document range
    
    Returns:
    
    true if the slave has been adapted successfully
    
    Throws:
    
    BadLocationException - in case the specified range is not valid in the master document
    
    Since:
    
    3.0
  - addViewportListener
```
public void addViewportListener(IViewportListener listener)
```
    Description copied from interface: ITextViewer
    
    Adds the given view port listener to this viewer. If the listener is already registered with this viewer, this call has no effect.
    
    Specified by:
    
    addViewportListener in interface ITextViewer
    
    Parameters:
    
    listener - the listener to be added
  - removeViewportListener
```
public void removeViewportListener(IViewportListener listener)
```
    Description copied from interface: ITextViewer
    
    Removes the given listener from this viewer's set of view port listeners. If the listener is not registered with this viewer, this call has no effect.
    
    Specified by:
    
    removeViewportListener in interface ITextViewer
    
    Parameters:
    
    listener - the listener to be removed
  - updateViewportListeners
```
protected void updateViewportListeners(int origin)
```
    Checks whether the view port changed and if so informs all registered listeners about the change.
    
    Parameters:
    
    origin - describes under which circumstances this method has been called.
    
    See Also:
    
    IViewportListener
  - getTopIndex
```
public int getTopIndex()
```
    Description copied from interface: ITextViewer
    
    Returns the visible line with the smallest line number.
    
    Specified by:
    
    getTopIndex in interface ITextViewer
    
    Returns:
    
    the number of the top most visible line
  - setTopIndex
```
public void setTopIndex(int index)
```
    Description copied from interface: ITextViewer
    
    Scrolls the widget so that the given index is the line with the smallest line number of all visible lines.
    
    Specified by:
    
    setTopIndex in interface ITextViewer
    
    Parameters:
    
    index - the line which should become the top most line
  - getVisibleLinesInViewport
```
@Deprecated
protected int getVisibleLinesInViewport()
```
    Deprecated.
    as of 3.2
    
    Returns the number of lines that can fully fit into the viewport. This is computed by dividing the widget's client area height by the widget's line height. The result is only accurate if the widget does not use variable line heights - for that reason, clients should not use this method any longer and use the client area height of the text widget to find out how much content fits into it.
    
    Returns:
    
    the view port height in lines
  - getBottomIndex
```
public int getBottomIndex()
```
    Description copied from interface: ITextViewer
    
    Returns the visible line with the highest line number.
    
    Specified by:
    
    getBottomIndex in interface ITextViewer
    
    Returns:
    
    the number of the bottom most line
  - getTopIndexStartOffset
```
public int getTopIndexStartOffset()
```
    Description copied from interface: ITextViewer
    
    Returns the document offset of the upper left corner of this viewer's view port.
    
    Specified by:
    
    getTopIndexStartOffset in interface ITextViewer
    
    Returns:
    
    the upper left corner offset
  - getBottomIndexEndOffset
```
public int getBottomIndexEndOffset()
```
    Description copied from interface: ITextViewer
    
    Returns the document offset of the lower right corner of this viewer's view port. This is the visible character with the highest character position. If the content of this viewer is shorter, the position of the last character of the content is returned.
    
    Specified by:
    
    getBottomIndexEndOffset in interface ITextViewer
    
    Returns:
    
    the lower right corner offset
  - revealRange
```
public void revealRange(int start,
                        int length)
```
    Description copied from interface: ITextViewer
    
    Ensures that the given range is visible.
    
    Specified by:
    
    revealRange in interface ITextViewer
    
    Parameters:
    
    start - the offset of the range to be revealed
    
    length - the length of the range to be revealed
  - internalRevealRange
```
protected void internalRevealRange(int start,
                                   int end)
```
    Reveals the given range of the visible document.
    
    Parameters:
    
    start - the start offset of the range
    
    end - the end offset of the range
  - getWidthInPixels
```
@Deprecated
protected final int getWidthInPixels(String text)
```
    Deprecated.
    use getWidthInPixels(int, int) instead
    
    Returns the width of the text when being drawn into this viewer's widget.
    
    Parameters:
    
    text - the string to measure
    
    Returns:
    
    the width of the presentation of the given string
  - getExtent
```
protected final IRegion getExtent(int start,
                                  int end)
```
    Returns the region covered by the given start and end offset. The result is relative to the upper left corner of the widget client area.
    
    Parameters:
    
    start - offset relative to the start of this viewer's view port 0 <= offset <= getCharCount()
    
    end - offset relative to the start of this viewer's view port 0 <= offset <= getCharCount()
    
    Returns:
    
    the region covered by start and end offset
  - getWidthInPixels
```
protected final int getWidthInPixels(int offset,
                                     int length)
```
    Returns the width of the representation of a text range in the visible region of the viewer's document as drawn in this viewer's widget.
    
    Parameters:
    
    offset - the offset of the text range in the visible region
    
    length - the length of the text range in the visible region
    
    Returns:
    
    the width of the presentation of the specified text range
    
    Since:
    
    2.0
  - getAverageCharWidth
```
protected final int getAverageCharWidth()
```
    Returns the average character width of this viewer's widget.
    
    Returns:
    
    the average character width of this viewer's widget
  - refresh
```
public void refresh()
```
    Description copied from class: Viewer
    
    Refreshes this viewer completely with information freshly obtained from this viewer's model.
    
    Specified by:
    
    refresh in class Viewer
  - getSlaveDocumentManager
```
protected ISlaveDocumentManager getSlaveDocumentManager()
```
    Returns the slave document manager
    
    Returns:
    
    the slave document manager
    
    Since:
    
    2.1
  - createSlaveDocumentManager
```
protected ISlaveDocumentManager createSlaveDocumentManager()
```
    Creates a new slave document manager. This implementation always returns a ChildDocumentManager.
    
    Returns:
    
    ISlaveDocumentManager
    
    Since:
    
    2.1
  - invalidateTextPresentation
```
public final void invalidateTextPresentation()
```
    Description copied from interface: ITextViewer
    
    Marks the currently applied text presentation as invalid. It is the viewer's responsibility to take any action it can to repair the text presentation.
    See ITextViewerExtension2.invalidateTextPresentation(int, int) for a way to invalidate specific regions rather than the presentation as a whole.
    
    Specified by:
    
    invalidateTextPresentation in interface ITextViewer
  - invalidateTextPresentation
```
public final void invalidateTextPresentation(int offset,
                                             int length)
```
    Invalidates the given range of the text presentation.
    
    Specified by:
    
    invalidateTextPresentation in interface ITextViewerExtension2
    
    Parameters:
    
    offset - the offset of the range to be invalidated
    
    length - the length of the range to be invalidated
    
    Since:
    
    2.1
  - freeSlaveDocument
```
protected void freeSlaveDocument(IDocument slave)
```
    Frees the given document if it is a slave document.
    
    Parameters:
    
    slave - the potential slave document
    
    Since:
    
    3.0
  - setVisibleDocument
```
protected void setVisibleDocument(IDocument document)
```
    Sets this viewer's visible document. The visible document represents the visible region of the viewer's input document.
    
    Parameters:
    
    document - the visible document
  - handleVisibleDocumentAboutToBeChanged
```
protected void handleVisibleDocumentAboutToBeChanged(DocumentEvent event)
```
    Hook method called when the visible document is about to be changed.
    Subclasses may override.
    
    Parameters:
    
    event - the document event
    
    Since:
    
    3.0
  - handleVisibleDocumentChanged
```
protected void handleVisibleDocumentChanged(DocumentEvent event)
```
    Hook method called when the visible document has been changed.
    Subclasses may override.
    
    Parameters:
    
    event - the document event
    
    Since:
    
    3.0
  - initializeDocumentInformationMapping
```
protected void initializeDocumentInformationMapping(IDocument visibleDocument)
```
    Initializes the document information mapping between the given slave document and its master document.
    
    Parameters:
    
    visibleDocument - the slave document
    
    Since:
    
    2.1
  - getVisibleDocument
```
protected IDocument getVisibleDocument()
```
    Returns the viewer's visible document.
    
    Returns:
    
    the viewer's visible document
  - _getVisibleRegionOffset
```
protected int _getVisibleRegionOffset()
```
    Returns the offset of the visible region.
    
    Returns:
    
    the offset of the visible region
  - getVisibleRegion
```
public IRegion getVisibleRegion()
```
    Description copied from interface: ITextViewer
    
    Returns the current visible region of this viewer's document. The result may differ from the argument passed to setVisibleRegion if the document has been modified since then. The visible region is supposed to be a consecutive region in viewer's input document and every character inside that region is supposed to visible in the viewer's widget.
    Viewers implementing ITextViewerExtension5 may be forced to change the fractions of the input document that are shown, in order to fulfill this contract.
    
    Specified by:
    
    getVisibleRegion in interface ITextViewer
    
    Returns:
    
    this viewer's current visible region
  - overlapsWithVisibleRegion
```
public boolean overlapsWithVisibleRegion(int start,
                                         int length)
```
    Description copied from interface: ITextViewer
    
    Returns whether a given range overlaps with the visible region of this viewer's document.
    Viewers implementing ITextViewerExtension5may be forced to change the fractions of the input document that are shown in order to fulfill this request. This is because the overlap is supposed to be without gaps.
    
    Specified by:
    
    overlapsWithVisibleRegion in interface ITextViewer
    
    Parameters:
    
    start - the offset
    
    length - the length
    
    Returns:
    
    true if the specified range overlaps with the visible region
  - setVisibleRegion
```
public void setVisibleRegion(int start,
                             int length)
```
    Description copied from interface: ITextViewer
    
    Defines and sets the region of this viewer's document which will be visible in the presentation. Every character inside the specified region is supposed to be visible in the viewer's widget after that call.
    
    Specified by:
    
    setVisibleRegion in interface ITextViewer
    
    Parameters:
    
    start - the offset of the visible region
    
    length - the length of the visible region
  - resetVisibleRegion
```
public void resetVisibleRegion()
```
    Description copied from interface: ITextViewer
    
    Resets the region of this viewer's document which is visible in the presentation. Afterwards, the whole input document is visible.
    
    Specified by:
    
    resetVisibleRegion in interface ITextViewer
  - setTextDoubleClickStrategy
```
public void setTextDoubleClickStrategy(ITextDoubleClickStrategy strategy,
                                       String contentType)
```
    Description copied from interface: ITextViewer
    
    Sets this viewer's text double click strategy for the given content type.
    
    Specified by:
    
    setTextDoubleClickStrategy in interface ITextViewer
    
    Parameters:
    
    strategy - the new double click strategy. null is a valid argument.
    
    contentType - the type for which the strategy is registered
  - selectContentTypePlugin
```
protected Object selectContentTypePlugin(int offset,
                                         Map<String,?> plugins)
```
    Selects from the given map the one which is registered under the content type of the partition in which the given offset is located.
    
    Parameters:
    
    offset - the offset for which to find the plug-in
    
    plugins - the map from which to choose
    
    Returns:
    
    the plug-in registered under the offset's content type or null if none
  - customizeDocumentCommand
```
protected void customizeDocumentCommand(DocumentCommand command)
```
    Hook called on receipt of a VerifyEvent. The event has been translated into a DocumentCommand which can now be manipulated by interested parties. By default, the hook forwards the command to the installed instances of IAutoEditStrategy.
    
    Parameters:
    
    command - the document command representing the verify event
  - handleVerifyEvent
```
protected void handleVerifyEvent(VerifyEvent e)
```
    Handles the verify event issued by the viewer's text widget.
    
    Parameters:
    
    e - the verify event
    
    See Also:
    
    VerifyListener.verifyText(VerifyEvent)
  - 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 interface ITextOperationTarget
    
    Parameters:
    
    operation - the operation code
    
    Returns:
    
    true if the specified operation can be performed
  - 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 if canDoOperation returns true.
    
    Specified by:
    
    doOperation in interface ITextOperationTarget
    
    Parameters:
    
    operation - the operation code
  - ignoreAutoEditStrategies
```
protected void ignoreAutoEditStrategies(boolean ignore)
```
    Tells this viewer whether the registered auto edit strategies should be ignored.
    
    Parameters:
    
    ignore - true if the strategies should be ignored.
    
    Since:
    
    2.1
  - isIgnoringAutoEditStrategies
```
protected boolean isIgnoringAutoEditStrategies()
```
    Returns whether this viewer ignores the registered auto edit strategies.
    
    Returns:
    
    true if the strategies are ignored
    
    Since:
    
    2.1
  - enableOperation
```
public void enableOperation(int operation,
                            boolean enable)
```
    Description copied from interface: ITextOperationTargetExtension
    
    Enables/disabled the given text operation.
    
    Specified by:
    
    enableOperation in interface ITextOperationTargetExtension
    
    Parameters:
    
    operation - the operation to enable/disable
    
    enable - true to enable the operation otherwise false
  - copyMarkedRegion
```
protected void copyMarkedRegion(boolean delete)
```
    Copies/cuts the marked region.
    
    Parameters:
    
    delete - true if the region should be deleted rather than copied.
    
    Since:
    
    2.0
  - deleteText
```
@Deprecated
protected void deleteText()
```
    Deprecated.
    use StyledText.invokeAction instead
    
    Deletes the current selection. If the selection has the length 0 the selection is automatically extended to the right - either by 1 or by the length of line delimiter if at the end of a line.
  - isBlockSelected
```
protected boolean isBlockSelected()
```
    A block is selected if the character preceding the start of the selection is a new line character.
    
    Returns:
    
    true if a block is selected
  - areMultipleLinesSelected
```
protected boolean areMultipleLinesSelected()
```
    Returns true if one line is completely selected or if multiple lines are selected. Being completely selected means that all characters except the new line characters are selected.
    
    Returns:
    
    true if one or multiple lines are selected
    
    Since:
    
    2.0
  - shift
```
@Deprecated
protected void shift(boolean useDefaultPrefixes,
                     boolean right)
```
    Deprecated.
    use shift(boolean, boolean, boolean) instead
    
    Shifts a text block to the right or left using the specified set of prefix characters. The prefixes must start at the beginning of the line.
    
    Parameters:
    
    useDefaultPrefixes - says whether the configured default or indent prefixes should be used
    
    right - says whether to shift to the right or the left
  - shift
```
protected void shift(boolean useDefaultPrefixes,
                     boolean right,
                     boolean ignoreWhitespace)
```
    Shifts a text block to the right or left using the specified set of prefix characters. If white space should be ignored the prefix characters must not be at the beginning of the line when shifting to the left. There may be whitespace in front of the prefixes.
    
    Parameters:
    
    useDefaultPrefixes - says whether the configured default or indent prefixes should be used
    
    right - says whether to shift to the right or the left
    
    ignoreWhitespace - says whether whitespace in front of prefixes is allowed
    
    Since:
    
    2.0
  - isPrintable
```
protected boolean isPrintable()
```
    Returns whether the shown text can be printed.
    
    Returns:
    
    the viewer's printable mode
  - print
```
public void print(StyledTextPrintOptions options)
```
    Print the text viewer contents using the given options.
    
    Specified by:
    
    print in interface ITextViewerExtension8
    
    Parameters:
    
    options - the print options
    
    Since:
    
    3.4
  - print
```
protected void print()
```
    Brings up a print dialog and calls printContents(Printer) which performs the actual print.
  - canPerformFind
```
protected boolean canPerformFind()
```
    Adheres to the contract of IFindReplaceTarget.canPerformFind().
    
    Returns:
    
    true if find can be performed, false otherwise
  - findAndSelect
```
@Deprecated
protected int findAndSelect(int startPosition,
                            String findString,
                            boolean forwardSearch,
                            boolean caseSensitive,
                            boolean wholeWord)
```
    Deprecated.
    as of 3.0 use findAndSelect(int, String, boolean, boolean, boolean, boolean)
    
    Adheres to the contract of IFindReplaceTarget.findAndSelect(int, String, boolean, boolean, boolean).
    
    Parameters:
    
    startPosition - the start position
    
    findString - the find string specification
    
    forwardSearch - the search direction
    
    caseSensitive - true if case sensitive, false otherwise
    
    wholeWord - true if match must be whole words, false otherwise
    
    Returns:
    
    the model offset of the first match
  - findAndSelect
```
protected int findAndSelect(int startPosition,
                            String findString,
                            boolean forwardSearch,
                            boolean caseSensitive,
                            boolean wholeWord,
                            boolean regExSearch)
```
    Adheres to the contract of IFindReplaceTargetExtension3.findAndSelect(int, String, boolean, boolean, boolean, boolean).
    
    Parameters:
    
    startPosition - the start position
    
    findString - the find string specification
    
    forwardSearch - the search direction
    
    caseSensitive - true if case sensitive, false otherwise
    
    wholeWord - true if matches must be whole words, false otherwise
    
    regExSearch - true if findString is a regular expression, false otherwise
    
    Returns:
    
    the model offset of the first match
  - findAndSelectInRange
```
protected int findAndSelectInRange(int startPosition,
                                   String findString,
                                   boolean forwardSearch,
                                   boolean caseSensitive,
                                   boolean wholeWord,
                                   int rangeOffset,
                                   int rangeLength,
                                   boolean regExSearch)
```
    Adheres to the contract of IFindReplaceTargetExtension3.findAndSelect(int, String, boolean, boolean, boolean, boolean).
    
    Parameters:
    
    startPosition - the start position
    
    findString - the find string specification
    
    forwardSearch - the search direction
    
    caseSensitive - true if case sensitive, false otherwise
    
    wholeWord - true if matches must be whole words, false otherwise
    
    rangeOffset - the search scope offset
    
    rangeLength - the search scope length
    
    regExSearch - true if findString is a regular expression, false otherwise
    
    Returns:
    
    the model offset of the first match
    
    Since:
    
    3.0
  - setTextColor
```
public void setTextColor(Color color)
```
    Description copied from interface: ITextViewer
    
    Applies the given color as text foreground color to this viewer's selection.
    
    Specified by:
    
    setTextColor in interface ITextViewer
    
    Parameters:
    
    color - the color to be applied
  - setTextColor
```
public void setTextColor(Color color,
                         int start,
                         int length,
                         boolean controlRedraw)
```
    Description copied from interface: ITextViewer
    
    Applies the given color as text foreground color to the specified section of this viewer. controlRedraw tells this viewer whether it should take care of redraw management or not.
    
    Specified by:
    
    setTextColor in interface ITextViewer
    
    Parameters:
    
    color - the color to be applied
    
    start - the offset of the range to be changed
    
    length - the length of the range to be changed
    
    controlRedraw - indicates whether this viewer should manage redraws
  - _internalGetVisibleRegion
```
protected IRegion _internalGetVisibleRegion()
```
    Returns the visible region if it is not equal to the whole document. Otherwise returns null.
    
    Returns:
    
    the viewer's visible region if smaller than input document, otherwise null
  - changeTextPresentation
```
public void changeTextPresentation(TextPresentation presentation,
                                   boolean controlRedraw)
```
    Description copied from interface: ITextViewer
    
    Applies the color information encoded in the given text presentation. controlRedraw tells this viewer whether it should take care of redraw management or not. If, e.g., this call is one in a sequence of multiple presentation calls, it is more appropriate to explicitly control redrawing at the beginning and the end of the sequence.
    
    Specified by:
    
    changeTextPresentation in interface ITextViewer
    
    Parameters:
    
    presentation - the presentation to be applied to this viewer
    
    controlRedraw - indicates whether this viewer should manage redraws
  - getFindReplaceTarget
```
public IFindReplaceTarget getFindReplaceTarget()
```
    Description copied from interface: ITextViewer
    
    Returns the find/replace operation target of this viewer.
    
    Specified by:
    
    getFindReplaceTarget in interface ITextViewer
    
    Returns:
    
    the find/replace operation target of this viewer
  - getFindReplaceDocumentAdapter
```
protected FindReplaceDocumentAdapter getFindReplaceDocumentAdapter()
```
    Returns the find/replace document adapter.
    
    Returns:
    
    the find/replace document adapter.
    
    Since:
    
    3.0
  - getTextOperationTarget
```
public ITextOperationTarget getTextOperationTarget()
```
    Description copied from interface: ITextViewer
    
    Returns the text operation target of this viewer.
    
    Specified by:
    
    getTextOperationTarget in interface ITextViewer
    
    Returns:
    
    the text operation target of this viewer
  - appendVerifyKeyListener
```
public void appendVerifyKeyListener(VerifyKeyListener listener)
```
    Description copied from interface: ITextViewerExtension
    
    Appends a verify key listener to the viewer's list of verify key listeners. If the listener is already registered with the viewer this call moves the listener to the end of the list.
    
    Specified by:
    
    appendVerifyKeyListener in interface ITextViewerExtension
    
    Parameters:
    
    listener - the listener to be added
  - prependVerifyKeyListener
```
public void prependVerifyKeyListener(VerifyKeyListener listener)
```
    Description copied from interface: ITextViewerExtension
    
    Inserts the verify key listener at the beginning of the viewer's list of verify key listeners. If the listener is already registered with the viewer this call moves the listener to the beginning of the list.
    
    Specified by:
    
    prependVerifyKeyListener in interface ITextViewerExtension
    
    Parameters:
    
    listener - the listener to be inserted
  - removeVerifyKeyListener
```
public void removeVerifyKeyListener(VerifyKeyListener listener)
```
    Description copied from interface: ITextViewerExtension
    
    Removes the verify key listener from the viewer's list of verify key listeners. If the listener is not registered with this viewer, this call has no effect.
    
    Specified by:
    
    removeVerifyKeyListener in interface ITextViewerExtension
    
    Parameters:
    
    listener - the listener to be removed
  - getMark
```
public int getMark()
```
    Description copied from interface: ITextViewerExtension
    
    Returns the position of the mark, -1 if the mark is not set.
    
    Specified by:
    
    getMark in interface ITextViewerExtension
    
    Returns:
    
    the position of the mark or -1 if no mark is set
  - setMark
```
public void setMark(int offset)
```
    Description copied from interface: ITextViewerExtension
    
    Sets a mark at the given offset or clears the mark if the specified offset is -1. If a mark is set and the selection is empty, cut and copy actions performed on this text viewer work on the region described by the positions of the mark and the cursor.
    
    Specified by:
    
    setMark in interface ITextViewerExtension
    
    Parameters:
    
    offset - the offset of the mark
  - inputChanged
```
protected void inputChanged(Object newInput,
                            Object oldInput)
```
    Description copied from class: Viewer
    
    Internal hook method called when the input to this viewer is initially set or subsequently changed.
    The default implementation does nothing. Subclassers may override this method to do something when a viewer's input is set. A typical use is populate the viewer.
    
    Overrides:
    
    inputChanged in class Viewer
    
    Parameters:
    
    newInput - the new input of this viewer, or null if none
    
    oldInput - the old input element or null if there was previously no input
  - enabledRedrawing
```
protected void enabledRedrawing()
```
    Enables the redrawing of this text viewer.
    
    Since:
    
    2.0
  - enabledRedrawing
```
protected void enabledRedrawing(int topIndex)
```
    Enables the redrawing of this text viewer.
    
    Parameters:
    
    topIndex - the top index to be set or -1
    
    Since:
    
    3.0
  - disableRedrawing
```
protected void disableRedrawing()
```
    Disables the redrawing of this text viewer. Subclasses may extend.
    
    Since:
    
    2.0
  - setRedraw
```
public final void setRedraw(boolean redraw)
```
    Description copied from interface: ITextViewerExtension
    
    Enables/disables the redrawing of this text viewer. This temporarily disconnects the viewer from its underlying StyledTextwidget. While being disconnected only the viewer's selection may be changed using setSelectedRange. Any direct manipulation of the widget as well as calls to methods that change the viewer's presentation state (such as enabling the segmented view) are not allowed. When redrawing is disabled the viewer does not send out any selection or view port change notification. When redrawing is enabled again, a selection change notification is sent out for the selected range and this range is revealed causing a view port changed notification.
    
    Specified by:
    
    setRedraw in interface ITextViewerExtension
    
    Parameters:
    
    redraw - true to enable redrawing, false otherwise
  - setRedraw
```
protected final void setRedraw(boolean redraw,
                               int topIndex)
```
    Basically same functionality as ITextViewerExtension.setRedraw(boolean). Adds a way for subclasses to pass in a desired top index that should be used when redraw is true. If topIndex is -1, this method is identical to ITextViewerExtension.setRedraw(boolean).
    
    Parameters:
    
    redraw - true if redraw is enabled
    
    topIndex - the top index
    
    Since:
    
    3.0
    
    See Also:
    
    ITextViewerExtension.setRedraw(boolean)
  - redraws
```
protected final boolean redraws()
```
    Returns whether this viewer redraws itself.
    
    Returns:
    
    true if this viewer redraws itself
    
    Since:
    
    2.0
  - startSequentialRewriteMode
```
@Deprecated
protected final void startSequentialRewriteMode(boolean normalized)
```
    Deprecated.
    since 3.1 use IDocumentExtension4.startRewriteSession(DocumentRewriteSessionType) instead
    
    Starts the sequential rewrite mode of the viewer's document.
    
    Parameters:
    
    normalized - true if the rewrite is performed from the start to the end of the document
    
    Since:
    
    2.0
  - stopSequentialRewriteMode
```
@Deprecated
protected final void stopSequentialRewriteMode()
```
    Deprecated.
    since 3.1 use IDocumentExtension4.stopRewriteSession(DocumentRewriteSession) instead
    
    Sets the sequential rewrite mode of the viewer's document.
    
    Since:
    
    2.0
  - getRewriteTarget
```
public IRewriteTarget getRewriteTarget()
```
    Description copied from interface: ITextViewerExtension
    
    Returns the viewer's rewrite target.
    
    Specified by:
    
    getRewriteTarget in interface ITextViewerExtension
    
    Returns:
    
    the viewer's rewrite target
  - getCurrentTextHover
```
public ITextHover getCurrentTextHover()
```
    Description copied from interface: ITextViewerExtension2
    
    Returns the currently displayed text hover if any, null otherwise.
    
    Specified by:
    
    getCurrentTextHover in interface ITextViewerExtension2
    
    Returns:
    
    the currently displayed text hover or null
  - getHoverEventLocation
```
public Point getHoverEventLocation()
```
    Description copied from interface: ITextViewerExtension2
    
    Returns the location at which the most recent mouse hover event has occurred.
    
    Specified by:
    
    getHoverEventLocation in interface ITextViewerExtension2
    
    Returns:
    
    the location of the most recent mouse hover event
  - getPaintManager
```
protected PaintManager getPaintManager()
```
    Returns the paint manager of this viewer.
    
    Returns:
    
    the paint manager of this viewer
    
    Since:
    
    2.1
  - addPainter
```
public void addPainter(IPainter painter)
```
    Adds the given painter to this viewer. If the painter is already registered this method is without effect.
    
    Specified by:
    
    addPainter in interface ITextViewerExtension2
    
    Parameters:
    
    painter - the painter to be added
    
    Since:
    
    2.1
  - removePainter
```
public void removePainter(IPainter painter)
```
    Removes the given painter from this viewer. If the painter has previously not been added to this viewer this method is without effect.
    
    Specified by:
    
    removePainter in interface ITextViewerExtension2
    
    Parameters:
    
    painter - the painter to be removed
    
    Since:
    
    2.1
  - modelLine2WidgetLine
```
public int modelLine2WidgetLine(int modelLine)
```
    Implements the contract of ITextViewerExtension5.modelLine2WidgetLine(int).
    
    Parameters:
    
    modelLine - the model line
    
    Returns:
    
    the corresponding widget line or -1
    
    Since:
    
    2.1
  - modelOffset2WidgetOffset
```
public int modelOffset2WidgetOffset(int modelOffset)
```
    Implements the contract of ITextViewerExtension5.modelOffset2WidgetOffset(int).
    
    Parameters:
    
    modelOffset - the model offset
    
    Returns:
    
    the corresponding widget offset or -1
    
    Since:
    
    2.1
  - modelRange2WidgetRange
```
public IRegion modelRange2WidgetRange(IRegion modelRange)
```
    Implements the contract of ITextViewerExtension5.modelRange2WidgetRange(IRegion).
    
    Parameters:
    
    modelRange - the model range
    
    Returns:
    
    the corresponding widget range or null
    
    Since:
    
    2.1
  - modelRange2ClosestWidgetRange
```
protected IRegion modelRange2ClosestWidgetRange(IRegion modelRange)
```
    Similar to modelRange2WidgetRange(IRegion), but more forgiving: if modelRange describes a region entirely hidden in the image, then this method returns the zero-length region at the offset of the folded region.
    
    Parameters:
    
    modelRange - the model range
    
    Returns:
    
    the corresponding widget range, or null
    
    Since:
    
    3.1
  - widgetlLine2ModelLine
```
public int widgetlLine2ModelLine(int widgetLine)
```
    Implements the contract of ITextViewerExtension5.widgetLine2ModelLine(int).
    
    Parameters:
    
    widgetLine - the widget line
    
    Returns:
    
    the corresponding model line
    
    Since:
    
    2.1
  - widgetLine2ModelLine
```
public int widgetLine2ModelLine(int widgetLine)
```
    Implements the contract of ITextViewerExtension5.widgetLine2ModelLine(int).
    
    Parameters:
    
    widgetLine - the widget line
    
    Returns:
    
    the corresponding model line or -1
    
    Since:
    
    3.0
  - widgetOffset2ModelOffset
```
public int widgetOffset2ModelOffset(int widgetOffset)
```
    Implements the contract of ITextViewerExtension5.widgetOffset2ModelOffset(int).
    
    Parameters:
    
    widgetOffset - the widget offset
    
    Returns:
    
    the corresponding model offset or -1
    
    Since:
    
    2.1
  - widgetRange2ModelRange
```
public IRegion widgetRange2ModelRange(IRegion widgetRange)
```
    Implements the contract of ITextViewerExtension5.widgetRange2ModelRange(IRegion).
    
    Parameters:
    
    widgetRange - the widget range
    
    Returns:
    
    the corresponding model range or null
    
    Since:
    
    2.1
  - getModelCoverage
```
public IRegion getModelCoverage()
```
    Implements the contract of ITextViewerExtension5.getModelCoverage().
    
    Returns:
    
    the model coverage
    
    Since:
    
    2.1
  - getClosestWidgetLineForModelLine
```
protected int getClosestWidgetLineForModelLine(int modelLine)
```
    Returns the line of the widget whose corresponding line in the viewer's document is closest to the given line in the viewer's document or -1.
    
    Parameters:
    
    modelLine - the line in the viewer's document
    
    Returns:
    
    the line in the widget that corresponds best to the given line in the viewer's document or -1
    
    Since:
    
    2.1
  - modelStyleRange2WidgetStyleRange
```
protected StyleRange modelStyleRange2WidgetStyleRange(StyleRange range)
```
    Translates a style range given relative to the viewer's document into style ranges relative to the viewer's widget or null.
    
    Parameters:
    
    range - the style range in the coordinates of the viewer's document
    
    Returns:
    
    the style range in the coordinates of the viewer's widget or null
    
    Since:
    
    2.1
  - modelRange2WidgetRange
```
protected IRegion modelRange2WidgetRange(Position modelPosition)
```
    Same as modelRange2WidgetRange(IRegion) just for a Position.
    
    Parameters:
    
    modelPosition - the position describing a range in the viewer's document
    
    Returns:
    
    a region describing a range in the viewer's widget
    
    Since:
    
    2.1
  - event2ModelRange
```
protected IRegion event2ModelRange(VerifyEvent event)
```
    Translates the widget region of the given verify event into the corresponding region of the viewer's document.
    
    Parameters:
    
    event - the verify event
    
    Returns:
    
    the region of the viewer's document corresponding to the verify event
    
    Since:
    
    2.1
  - widgetSelection2ModelSelection
```
protected Point widgetSelection2ModelSelection(Point widgetSelection)
```
    Translates the given widget selection into the corresponding region of the viewer's document or returns null if this fails.
    
    Parameters:
    
    widgetSelection - the widget selection
    
    Returns:
    
    the region of the viewer's document corresponding to the widget selection or null
    
    Since:
    
    2.1
  - modelSelection2WidgetSelection
```
protected Point modelSelection2WidgetSelection(Point modelSelection)
```
    Translates the given selection range of the viewer's document into the corresponding widget range or returns null of this fails.
    
    Parameters:
    
    modelSelection - the selection range of the viewer's document
    
    Returns:
    
    the widget range corresponding to the selection range or null
    
    Since:
    
    2.1
  - widgetLineOfWidgetOffset
```
public int widgetLineOfWidgetOffset(int widgetOffset)
```
    Implements the contract of ITextViewerExtension5.widgetLineOfWidgetOffset(int).
    
    Parameters:
    
    widgetOffset - the widget offset
    
    Returns:
    
    the corresponding widget line or -1
    
    Since:
    
    2.1
  - moveFocusToWidgetToken
```
public boolean moveFocusToWidgetToken()
```
    Description copied from interface: ITextViewerExtension4
    
    Instructs the receiver to request the IWidgetTokenKeeper currently holding the widget token to take the keyboard focus.
    
    Specified by:
    
    moveFocusToWidgetToken in interface ITextViewerExtension4
    
    Returns:
    
    true if there was any IWidgetTokenKeeper that was asked to take the focus, false otherwise
  - setDocumentPartitioning
```
public void setDocumentPartitioning(String partitioning)
```
    Sets the document partitioning of this viewer. The partitioning is used by this viewer to access partitioning information of the viewers input document.
    
    Parameters:
    
    partitioning - the partitioning name
    
    Since:
    
    3.0
  - getDocumentPartitioning
```
protected String getDocumentPartitioning()
```
    Returns the document partitioning for this viewer.
    
    Returns:
    
    the document partitioning for this viewer
    
    Since:
    
    3.0
  - addTextPresentationListener
```
public void addTextPresentationListener(ITextPresentationListener listener)
```
    Description copied from interface: ITextViewerExtension4
    
    Adds the given text presentation listener to this text viewer. This call has no effect if the listener is already registered with this text viewer.
    
    Specified by:
    
    addTextPresentationListener in interface ITextViewerExtension4
    
    Parameters:
    
    listener - the text presentation listener
  - removeTextPresentationListener
```
public void removeTextPresentationListener(ITextPresentationListener listener)
```
    Description copied from interface: ITextViewerExtension4
    
    Removes the given text presentation listener from this text viewer. This call has no effect if the listener is not registered with this text viewer.
    
    Specified by:
    
    removeTextPresentationListener in interface ITextViewerExtension4
    
    Parameters:
    
    listener - the text presentation listener
  - register
```
public void register(IEditingSupport helper)
```
    Description copied from interface: IEditingSupportRegistry
    
    Register a support with the registry. If the support is already registered, nothing happens.
    
    Specified by:
    
    register in interface IEditingSupportRegistry
    
    Parameters:
    
    helper - an editor support
  - unregister
```
public void unregister(IEditingSupport helper)
```
    Description copied from interface: IEditingSupportRegistry
    
    Deregister a support with the registry. If the support is not registered, or support is null, nothing happens.
    
    Specified by:
    
    unregister in interface IEditingSupportRegistry
    
    Parameters:
    
    helper - the helper to deregister, or null
  - getRegisteredSupports
```
public IEditingSupport[] getRegisteredSupports()
```
    Description copied from interface: IEditingSupportRegistry
    
    Returns the current editor helpers.
    
    Specified by:
    
    getRegisteredSupports in interface IEditingSupportRegistry
    
    Returns:
    
    an non- null array of currently registered editor helpers
  - setHyperlinkDetectors
```
public void setHyperlinkDetectors(IHyperlinkDetector[] hyperlinkDetectors,
                                  int eventStateMask)
```
    Description copied from interface: ITextViewerExtension6
    
    Sets this viewer's hyperlink detectors for the given state mask.
    
    Specified by:
    
    setHyperlinkDetectors in interface ITextViewerExtension6
    
    Parameters:
    
    hyperlinkDetectors - the new array of hyperlink detectors, null or an empty array to disable hyperlinking
    
    eventStateMask - the SWT event state mask to activate hyperlink mode
  - setHyperlinkPresenter
```
public void setHyperlinkPresenter(IHyperlinkPresenter hyperlinkPresenter)
                           throws IllegalStateException
```
    Sets the hyperlink presenter.
    This is only valid as long as the hyperlink manager hasn't been created yet.
    
    Parameters:
    
    hyperlinkPresenter - the hyperlink presenter
    
    Throws:
    
    IllegalStateException - if the hyperlink manager has already been created
    
    Since:
    
    3.1
  - setTabsToSpacesConverter
```
public void setTabsToSpacesConverter(IAutoEditStrategy converter)
```
    Description copied from interface: ITextViewerExtension7
    
    Sets an auto edit strategy can converts tabs to spaces.
    
    Specified by:
    
    setTabsToSpacesConverter in interface ITextViewerExtension7
    
    Parameters:
    
    converter - the converter or null if none should be used

Class TextViewer

Nested Class Summary

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

Field Summary

Fields inherited from class org.eclipse.jface.viewers.Viewer

Fields inherited from interface org.eclipse.jface.text.ITextOperationTarget

Fields inherited from interface org.eclipse.jface.text.ITextViewerExtension2

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.jface.viewers.Viewer

Methods inherited from class java.lang.Object

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

Field Detail

TRACE_ERRORS

SCROLLER

MOUSE

MOUSE_END

KEY

RESIZE

INTERNAL

SHIFTING

fMarkPosition

fIgnoreAutoIndent

fIndentChars

fDefaultPrefixChars

fDoubleClickStrategies

fUndoManager

fAutoIndentStrategies

fTextHovers

fViewportListeners

fLastTopPixel

fTextListeners

fTextInputListeners

fEventConsumer

fReplaceTextPresentation

fHoverControlCreator

fInformationMapping

fPaintManager

fPartitioning

fTextPresentationListeners

fFindReplaceDocumentAdapter

fHyperlinkDetectors

fHyperlinkPresenter

fHyperlinkManager

fHyperlinkStateMask

Constructor Detail

TextViewer

TextViewer

Method Detail

createTextWidget

createDocumentAdapter

createControl

getControl

activatePlugins

resetPlugins

handleDispose

getTextWidget

getEmptySelectionChangedEventDelay

setAutoIndentStrategy

setAutoEditStrategies

prependAutoEditStrategy

removeAutoEditStrategy

setEventConsumer

setIndentPrefixes

getTopInset

isEditable

setEditable

setDefaultPrefixes

setUndoManager

getUndoManager

setTextHover

setTextHover

removeTextHovers

getTextHover

getTextHover

getTextHoveringController

setHoverControlCreator

setHoverEnrichMode

requestWidgetToken

requestWidgetToken