org.eclipse.jface.viewers.Viewer
org.eclipse.jface.text.TextViewer
|
Eclipse Platform Release 3.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
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.
Clients should not subclass this class as it is rather likely that subclasses will be broken by future releases.
| Nested Class Summary | |
| 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. |
| Field Summary | |
| protected Map | fAutoIndentStrategies
The text viewer's auto indent strategies |
| protected Map | fDefaultPrefixChars
The string a line is prefixed with on PREFIX and removed from each line on STRIP_PREFIX |
| protected Map | 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 boolean | fIgnoreAutoIndent
Should the auto indent strategies ignore the next edit operation |
| protected Map | 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 | fTextHovers
The text viewer's text hovers |
| protected List | fTextInputListeners
All registered text input listeners |
| protected List | fTextListeners
All registered text listeners |
| protected List | fTextPresentationListeners
All registered text presentation listeners. |
| protected IUndoManager | fUndoManager
The text viewer's undo manager |
| protected List | 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.ITextViewerExtension2 |
| DEFAULT_HOVER_STATE_MASK |
| Fields inherited from interface org.eclipse.jface.text.ITextOperationTarget |
| COPY, CUT, DELETE, PASTE, PREFIX, PRINT, REDO, SELECT_ALL, SHIFT_LEFT, SHIFT_RIGHT, STRIP_PREFIX, UNDO |
| Constructor Summary | |
| protected | TextViewer()
Internal use only |
| TextViewer(Composite parent,
int styles)
Create a new text viewer with the given SWT style bits. | |
| Method Summary | |
| 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 control of 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. |
| 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. |
| 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 viewer's text widget. |
| 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. |
| protected IDocument | getVisibleDocument()
Returns the viewer's visible document. |
| protected int | getVisibleLinesInViewport()
Returns the view port height in lines. |
| 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). |
| 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. |
| 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 | 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 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 send out to all post selection listeners. |
| void | setAutoIndentStrategy(IAutoIndentStrategy strategy,
String contentType)
Sets this viewer's auto indent strategy for the given content type. |
| void | setDefaultPrefixes(String[] defaultPrefixes,
String contentType)
Sets the string that is used as prefix when lines of the given content type are prefixed by 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 | 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 | 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 the 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)
Starts the sequential rewrite mode of the viewer's document. |
| protected void | stopSequentialRewriteMode()
Sets the sequential rewrite mode of the viewer's document. |
| 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 |
public static boolean TRACE_ERRORS
protected static final int SCROLLER
protected static final int MOUSE
protected static final int MOUSE_END
protected static final int KEY
protected static final int RESIZE
protected static final int INTERNAL
protected static final String SHIFTING
protected Position fMarkPosition
protected FindReplaceDocumentAdapter fFindReplaceDocumentAdapter
protected boolean fIgnoreAutoIndent
protected Map fIndentChars
protected Map fDefaultPrefixChars
protected Map fDoubleClickStrategies
protected IUndoManager fUndoManager
protected Map fAutoIndentStrategies
protected Map fTextHovers
protected IInformationControlCreator fHoverControlCreator
protected List fViewportListeners
protected int fLastTopPixel
protected List fTextListeners
protected List fTextInputListeners
protected IEventConsumer fEventConsumer
protected boolean fReplaceTextPresentation
protected IDocumentInformationMapping fInformationMapping
protected PaintManager fPaintManager
protected String fPartitioning
protected List fTextPresentationListeners
| Constructor Detail |
protected TextViewer()
public TextViewer(Composite parent,
int styles)
| Method Detail |
protected StyledText createTextWidget(Composite parent,
int styles)
protected IDocumentAdapter createDocumentAdapter()
protected void createControl(Composite parent,
int styles)
public Control getControl()
public void activatePlugins()
public void resetPlugins()
protected void handleDispose()
public StyledText getTextWidget()
protected int getEmptySelectionChangedEventDelay()
Note: The return value is used to initialize the cursor listener. To return a non-constant value has no effect.
The same value (500) is used in OpenStrategy.TIME.
public void setAutoIndentStrategy(IAutoIndentStrategy strategy,
String contentType)
ITextViewerExtension2 extension= (ITextViewerExtension2) viewer;
extension.removeAutoEditStrategy(oldStrategy, contentType);
extension.prependAutoEditStrategy(strategy, contentType);
public void prependAutoEditStrategy(IAutoEditStrategy strategy,
String contentType)
public void removeAutoEditStrategy(IAutoEditStrategy strategy,
String contentType)
public void setEventConsumer(IEventConsumer consumer)
public void setIndentPrefixes(String[] indentPrefixes,
String contentType)
public int getTopInset()
public boolean isEditable()
public void setEditable(boolean editable)
public void setDefaultPrefixes(String[] defaultPrefixes,
String contentType)
public void setUndoManager(IUndoManager undoManager)
public void setTextHover(ITextHover hover,
String contentType)
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);
public void setTextHover(ITextHover hover,
String contentType,
int stateMask)
public void removeTextHovers(String contentType)
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.
protected ITextHover getTextHover(int offset)
protected ITextHover getTextHover(int offset,
int stateMask)
protected AbstractInformationControlManager getTextHoveringController()
public void setHoverControlCreator(IInformationControlCreator creator)
public boolean requestWidgetToken(IWidgetTokenKeeper requester)
Replaced by IWidgetTokenOwnerExtension.requestWidgetToken(IWidgetTokenKeeper, int).
public boolean requestWidgetToken(IWidgetTokenKeeper requester,
int priority)
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.
public void releaseWidgetToken(IWidgetTokenKeeper tokenKeeper)
public Point getSelectedRange()
public void setSelectedRange(int selectionOffset,
int selectionLength)
protected void validateSelectionRange(int[] selectionRange)
public void setSelection(ISelection selection,
boolean reveal)
Subclasses must implement this method.
public ISelection getSelection()
public ISelectionProvider getSelectionProvider()
public void addPostSelectionChangedListener(ISelectionChangedListener listener)
public void removePostSelectionChangedListener(ISelectionChangedListener listener)
protected void firePostSelectionChanged(int offset,
int length)
protected void selectionChanged(int offset,
int length)
protected void fireSelectionChanged(int offset,
int length)
protected void markChanged(int offset,
int length)
public void addTextListener(ITextListener listener)
public void removeTextListener(ITextListener listener)
protected void updateTextListeners(TextViewer.WidgetCommand cmd)
public void addTextInputListener(ITextInputListener listener)
public void removeTextInputListener(ITextInputListener listener)
protected void fireInputDocumentAboutToBeChanged(IDocument oldInput,
IDocument newInput)
protected void fireInputDocumentChanged(IDocument oldInput,
IDocument newInput)
public Object getInput()
public IDocument getDocument()
public void setInput(Object input)
public void setDocument(IDocument document)
public void setDocument(IDocument document,
int modelRangeOffset,
int modelRangeLength)
protected IDocument createSlaveDocument(IDocument document)
protected boolean updateVisibleDocument(IDocument visibleDocument,
int visibleRegionOffset,
int visibleRegionLength)
throws BadLocationException
protected boolean updateSlaveDocument(IDocument slaveDocument,
int modelRangeOffset,
int modelRangeLength)
throws BadLocationException
public void addViewportListener(IViewportListener listener)
public void removeViewportListener(IViewportListener listener)
protected void updateViewportListeners(int origin)
public int getTopIndex()
public void setTopIndex(int index)
protected int getVisibleLinesInViewport()
public int getBottomIndex()
public int getTopIndexStartOffset()
public int getBottomIndexEndOffset()
public void revealRange(int start,
int length)
protected void internalRevealRange(int start,
int end)
protected final int getWidthInPixels(String text)
protected final IRegion getExtent(int start,
int end)
protected final int getWidthInPixels(int offset,
int length)
protected final int getAverageCharWidth()
public void refresh()
protected ISlaveDocumentManager getSlaveDocumentManager()
protected ISlaveDocumentManager createSlaveDocumentManager()
public final void invalidateTextPresentation()
See ITextViewerExtension2.invalidateTextPresentation(int, int) for a way to invalidate specific regions rather than the presentation as a whole.
public final void invalidateTextPresentation(int offset,
int length)
protected void freeSlaveDocument(IDocument slave)
protected void setVisibleDocument(IDocument document)
protected void handleVisibleDocumentAboutToBeChanged(DocumentEvent event)
Subclasses may override.
protected void handleVisibleDocumentChanged(DocumentEvent event)
Subclasses may override.
protected void initializeDocumentInformationMapping(IDocument visibleDocument)
protected IDocument getVisibleDocument()
protected int _getVisibleRegionOffset()
public IRegion getVisibleRegion()
Viewers implementing ITextViewerExtension5 may be forced to change the fractions of the input document that are shown, in order to fulfill this contract.
public boolean overlapsWithVisibleRegion(int start,
int length)
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.
public void setVisibleRegion(int start,
int length)
public void resetVisibleRegion()
public void setTextDoubleClickStrategy(ITextDoubleClickStrategy strategy,
String contentType)
protected Object selectContentTypePlugin(int offset,
Map plugins)
protected void customizeDocumentCommand(DocumentCommand command)
protected void handleVerifyEvent(VerifyEvent e)
public boolean canDoOperation(int operation)
public void doOperation(int operation)
protected void ignoreAutoEditStrategies(boolean ignore)
protected boolean isIgnoringAutoEditStrategies()
public void enableOperation(int operation,
boolean enable)
protected void copyMarkedRegion(boolean delete)
protected void deleteText()
protected boolean isBlockSelected()
protected boolean areMultipleLinesSelected()
protected void shift(boolean useDefaultPrefixes,
boolean right)
protected void shift(boolean useDefaultPrefixes,
boolean right,
boolean ignoreWhitespace)
protected boolean isPrintable()
protected void print()
protected boolean canPerformFind()
protected int findAndSelect(int startPosition,
String findString,
boolean forwardSearch,
boolean caseSensitive,
boolean wholeWord)
protected int findAndSelect(int startPosition,
String findString,
boolean forwardSearch,
boolean caseSensitive,
boolean wholeWord,
boolean regExSearch)
protected int findAndSelectInRange(int startPosition,
String findString,
boolean forwardSearch,
boolean caseSensitive,
boolean wholeWord,
int rangeOffset,
int rangeLength,
boolean regExSearch)
public void setTextColor(Color color)
public void setTextColor(Color color,
int start,
int length,
boolean controlRedraw)
protected IRegion _internalGetVisibleRegion()
public void changeTextPresentation(TextPresentation presentation,
boolean controlRedraw)
public IFindReplaceTarget getFindReplaceTarget()
protected FindReplaceDocumentAdapter getFindReplaceDocumentAdapter()
public ITextOperationTarget getTextOperationTarget()
public void appendVerifyKeyListener(VerifyKeyListener listener)
public void prependVerifyKeyListener(VerifyKeyListener listener)
public void removeVerifyKeyListener(VerifyKeyListener listener)
public int getMark()
public void setMark(int offset)
protected void inputChanged(Object newInput,
Object oldInput)
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.
protected void enabledRedrawing()
protected void enabledRedrawing(int topIndex)
protected void disableRedrawing()
public final void setRedraw(boolean redraw)
protected final void setRedraw(boolean redraw,
int topIndex)
protected final boolean redraws()
protected final void startSequentialRewriteMode(boolean normalized)
protected final void stopSequentialRewriteMode()
public IRewriteTarget getRewriteTarget()
public ITextHover getCurrentTextHover()
public Point getHoverEventLocation()
protected PaintManager getPaintManager()
public void addPainter(IPainter painter)
public void removePainter(IPainter painter)
public int modelLine2WidgetLine(int modelLine)
public int modelOffset2WidgetOffset(int modelOffset)
public IRegion modelRange2WidgetRange(IRegion modelRange)
public int widgetlLine2ModelLine(int widgetLine)
public int widgetLine2ModelLine(int widgetLine)
public int widgetOffset2ModelOffset(int widgetOffset)
public IRegion widgetRange2ModelRange(IRegion widgetRange)
public IRegion getModelCoverage()
protected int getClosestWidgetLineForModelLine(int modelLine)
protected StyleRange modelStyleRange2WidgetStyleRange(StyleRange range)
protected IRegion modelRange2WidgetRange(Position modelPosition)
protected IRegion event2ModelRange(VerifyEvent event)
protected Point widgetSelection2ModelSelection(Point widgetSelection)
protected Point modelSelection2WidgetSelection(Point modelSelection)
public int widgetLineOfWidgetOffset(int widgetOffset)
public boolean moveFocusToWidgetToken()
public void setDocumentPartitioning(String partitioning)
protected String getDocumentPartitioning()
public void addTextPresentationListener(ITextPresentationListener listener)
public void removeTextPresentationListener(ITextPresentationListener listener)
|
Eclipse Platform Release 3.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.