|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Extension interface for ITextViewer
.
It provides
ITextViewer.setTextHover(ITextHover, String)
with a new method that allows to specify state masks for a better control of
the hover behavior.
An IAutoEditStrategy
is a generalization of
the original IAutoIndentStrategy
. Auto edit
strategies can be arranged in a list that is executed like a pipeline when
the viewer content is changed.
A 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.
Field Summary | |
static int |
DEFAULT_HOVER_STATE_MASK
The state mask of the default hover (value 0xff ). |
Method Summary | |
void |
addPainter(IPainter painter)
Adds the given painter to this viewer. |
ITextHover |
getCurrentTextHover()
Returns the currently displayed text hover if any, null otherwise. |
Point |
getHoverEventLocation()
Returns the location at which the most recent mouse hover event has occurred. |
void |
invalidateTextPresentation(int offset,
int length)
Invalidates the viewer's text presentation for the given range. |
void |
prependAutoEditStrategy(IAutoEditStrategy strategy,
String contentType)
Prepends the given auto edit strategy to the existing list of strategies for the specified content type. |
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 |
removeTextHovers(String contentType)
Removes all text hovers for the given content type independent from their state mask. |
void |
setTextHover(ITextHover textViewerHover,
String contentType,
int stateMask)
Sets this viewer's text hover for the given content type and the given state mask. |
Field Detail |
public static final int DEFAULT_HOVER_STATE_MASK
0xff
).
Method Detail |
public void invalidateTextPresentation(int offset, int length)
offset
- the offset of the first character to be redrawnlength
- the length of the range to be redrawnpublic void setTextHover(ITextHover textViewerHover, String contentType, int stateMask)
null
, any hover installed for the given content type and state mask is removed.
textViewerHover
- the new hover or null
contentType
- the type for which the hover is to be registered or unregisteredstateMask
- the SWT event state mask; DEFAULT_HOVER_STATE_MASK
indicates that
the hover is installed as the default hover.public void removeTextHovers(String contentType)
Note: To remove a hover for a given content type and state mask
use setTextHover(ITextHover, String, int)
with null
as parameter for the text hover.
contentType
- the type for which all text hovers are to be unregisteredpublic ITextHover getCurrentTextHover()
null
otherwise.
null
public Point getHoverEventLocation()
public void prependAutoEditStrategy(IAutoEditStrategy strategy, String contentType)
strategy
- the auto edit strategycontentType
- the content typepublic void removeAutoEditStrategy(IAutoEditStrategy strategy, String contentType)
strategy
- the auto edit strategycontentType
- the content typepublic void addPainter(IPainter painter)
painter
- the painter to be addedpublic void removePainter(IPainter painter)
painter
- the painter to be removed
|
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.