org.eclipse.jface.text
Interface ITextViewerExtension2

All Known Implementing Classes:

TextViewer

public interface ITextViewerExtension2

Extension interface for ITextViewer. Extends ITextViewer with

• a replacement of the ITextViewer.invalidateTextPresentation method
• a replacement of the ITextViewer.setTextHover method now accepting state masks

Since:

2.1

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 been issued.
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.
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

DEFAULT_HOVER_STATE_MASK

public static final int DEFAULT_HOVER_STATE_MASK

The state mask of the default hover (value 0xff).

See Also:

Constant Field Values

Method Detail

invalidateTextPresentation

public void invalidateTextPresentation(int offset,
                                       int length)

Invalidates the viewer's text presentation for the given range.

Parameters:

offset - the offset of the first character to be redrawn

length - the length of the range to be redrawn

setTextHover

public void setTextHover(ITextHover textViewerHover,
                         String contentType,
                         int stateMask)

Sets this viewer's text hover for the given content type and the given state mask. If the given text hower is null, any hover installed for the given content type and state mask is uninstalled.

Parameters:

textViewerHover - 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)

Removes all text hovers for the given content type.

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.

Parameters:

contentType - the type for which all text hovers are to be unregistered

getCurrentTextHover

public ITextHover getCurrentTextHover()

Returns the currently displayed text hover if any, null otherwise.

getHoverEventLocation

public Point getHoverEventLocation()

Returns the location at which the most recent mouse hover event has been issued.

Returns:

the location of the most recent mouse hover event

prependAutoEditStrategy

public void prependAutoEditStrategy(IAutoEditStrategy strategy,
                                    String contentType)

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

contentType - the content type

removeAutoEditStrategy

public 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.

Parameters:

strategy - the auto edit strategy

contentType - the content type

addPainter

public void addPainter(IPainter painter)

Adds the given painter to this viewer.

Parameters:

painter - the painter to be added

removePainter

public void removePainter(IPainter painter)

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