|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.text.CursorLinePainter
public class CursorLinePainter
A painter the draws the background of the caret line in a configured color.
Clients usually instantiate and configure object of this class.
This class is not intended to be subclassed.
| Field Summary |
|---|
| Fields inherited from interface org.eclipse.jface.text.IPainter |
|---|
CONFIGURATION, INTERNAL, KEY_STROKE, MOUSE_BUTTON, SELECTION, TEXT_CHANGE |
| Constructor Summary | |
|---|---|
CursorLinePainter(ITextViewer textViewer)
Creates a new painter for the given source viewer. |
|
| Method Summary | |
|---|---|
void |
deactivate(boolean redraw)
Deactivates this painter. |
void |
dispose()
Disposes this painter. |
void |
lineGetBackground(LineBackgroundEvent event)
This method is called when a line is about to be drawn in order to get its background color. |
void |
paint(int reason)
Requests this painter to repaint because of the given reason. |
void |
setHighlightColor(Color highlightColor)
Sets the color in which to draw the background of the cursor line. |
void |
setPositionManager(IPaintPositionManager manager)
Sets the paint position manager that can be used by this painter or removes any previously set paint position manager. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public CursorLinePainter(ITextViewer textViewer)
textViewer - the source viewer for which to create a painter| Method Detail |
|---|
public void setHighlightColor(Color highlightColor)
highlightColor - the color in which to draw the background of the cursor linepublic void lineGetBackground(LineBackgroundEvent event)
LineBackgroundListenerThe following event fields are used:
lineGetBackground in interface LineBackgroundListenerevent - the given eventLineBackgroundEventpublic void deactivate(boolean redraw)
IPainterredraw indicates whether the painter
should remove any decoration it previously applied. A deactivated painter
can be reactivated by calling paint.
deactivate in interface IPainterredraw - true if any previously applied decoration
should be removedIPainter.paint(int)public void dispose()
IPainter
dispose in interface IPainterIPainter.deactivate(boolean)public void paint(int reason)
IPainter
paint in interface IPainterreason - the repaint reason, value is one of the constants defined
in this interfacepublic void setPositionManager(IPaintPositionManager manager)
IPainter
setPositionManager in interface IPaintermanager - the paint position manager or null
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.