| org.eclipse.jface.text.ITextViewerExtension2
All known Subclasses: org.eclipse.jface.text.TextViewer,
| ITextViewerExtension2 | | public interface ITextViewerExtension2 (Code) | | Extension interface for
org.eclipse.jface.text.ITextViewer .
It provides
- text presentation invalidation enhancements
- text hover management enhancements
- a replacement for auto indent strategies
- support for custom painters
It extends the means for text presentation invalidation by allowing a
specific region of the presentation to get invalidated. It replaces
org.eclipse.jface.text.ITextViewer.setTextHover(ITextHoverString) with a new method that allows to specify state masks for a better control of
the hover behavior.
An
org.eclipse.jface.text.IAutoEditStrategy is a generalization of
the original
org.eclipse.jface.text.IAutoIndentStrategy . Auto edit
strategies can be arranged in a list that is executed like a pipeline when
the viewer content is changed.
A
org.eclipse.jface.text.IPainter is creating and managing visual
decorations on the viewer's text widget. Viewer's can have an open number of
painters. Painters are informed about changes to the viewer content and state
and can take the necessary action in responds to the notification.
since:
2.1 |
| DEFAULT_HOVER_STATE_MASK | | final int DEFAULT_HOVER_STATE_MASK(Code) | | The state mask of the default hover (value 0xff).
|
| addPainter | | void addPainter(IPainter painter)(Code) | | Adds the given painter to this viewer.
Parameters:
painter - the painter to be added |
| getCurrentTextHover | | ITextHover getCurrentTextHover()(Code) | | Returns the currently displayed text hover if any, null otherwise.
the currently displayed text hover or null |
| getHoverEventLocation | | Point getHoverEventLocation()(Code) | | Returns the location at which the most recent mouse hover event
has occurred.
the location of the most recent mouse hover event |
| invalidateTextPresentation | | void invalidateTextPresentation(int offset, int length)(Code) | | Invalidates the viewer's text presentation for the given range.
Parameters:
offset - the offset of the first character to be redrawn
Parameters:
length - the length of the range to be redrawn |
| prependAutoEditStrategy | | void prependAutoEditStrategy(IAutoEditStrategy strategy, String contentType)(Code) | | 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.
Parameters:
strategy - the auto edit strategy
Parameters:
contentType - the content type |
| removeAutoEditStrategy | | void removeAutoEditStrategy(IAutoEditStrategy strategy, String contentType)(Code) | | Removes the first occurrence of the given auto edit strategy in the list of strategies
registered under the specified content type.
Parameters:
strategy - the auto edit strategy
Parameters:
contentType - the content type |
| removePainter | | void removePainter(IPainter painter)(Code) | | Removes the given painter from this viewer. If the painter has not been
added to this viewer, this call is without effect.
Parameters:
painter - the painter to be removed |
| removeTextHovers | | void removeTextHovers(String contentType)(Code) | | 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.
Parameters:
contentType - the type for which all text hovers are to be unregistered |
| setTextHover | | void setTextHover(ITextHover textViewerHover, String contentType, int stateMask)(Code) | | 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.
Parameters:
textViewerHover - the new hover or null
Parameters:
contentType - the type for which the hover is to be registered or unregistered
Parameters:
stateMask - the SWT event state mask; DEFAULT_HOVER_STATE_MASK indicates thatthe hover is installed as the default hover. |
|
|