---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

org.eclipse.jface.text
Class WhitespaceCharacterPainter

java.lang.Object
  
org.eclipse.jface.text.WhitespaceCharacterPainter

All Implemented Interfaces:

EventListener, IPainter, PaintListener, org.eclipse.swt.internal.SWTEventListener

---

public class WhitespaceCharacterPainter
extends 
Object
implements 
IPainter, 
PaintListener

A painter for drawing visible characters for (invisible) whitespace characters.

Since:

3.3

---

Field Summary

 

Fields inherited from interface org.eclipse.jface.text. IPainter
CONFIGURATION, INTERNAL, KEY_STROKE, MOUSE_BUTTON, SELECTION, TEXT_CHANGE

 

Constructor Summary
WhitespaceCharacterPainter ( ITextViewer textViewer)           Creates a new painter for the given text viewer.

 

Method Summary
void	deactivate (boolean redraw)           Deactivates this painter.
void	dispose ()           Disposes this painter.
void	paint (int reason)           Requests this painter to repaint because of the given reason.
void	paintControl ( PaintEvent event)           Sent when a paint event occurs for the control.
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

WhitespaceCharacterPainter

public WhitespaceCharacterPainter(
ITextViewer textViewer)

Creates a new painter for the given text viewer.

Parameters:

textViewer - the text viewer the painter should be attached to

Method Detail

dispose

public void dispose()

Description copied from interface: IPainter

Disposes this painter. Prior to disposing, a painter should be deactivated. A disposed painter can not be reactivated.

Specified by:

dispose in interface IPainter

See Also:

IPainter.deactivate(boolean)

---

paint

public void paint(int reason)

Description copied from interface: IPainter

Requests this painter to repaint because of the given reason. Based on the given reason the painter can decide whether it will repaint or not. If it repaints and is inactive, it will activate itself.

Specified by:

paint in interface IPainter

Parameters:

reason - the repaint reason, value is one of the constants defined in this interface

---

deactivate

public void deactivate(boolean redraw)

Description copied from interface: IPainter

Deactivates this painter. If the painter is inactive, this call does not have any effect. redraw indicates whether the painter should remove any decoration it previously applied. A deactivated painter can be reactivated by calling paint.

Specified by:

deactivate in interface IPainter

Parameters:

redraw - true if any previously applied decoration should be removed

See Also:

IPainter.paint(int)

---

setPositionManager

public void setPositionManager(
IPaintPositionManager manager)

Description copied from interface: IPainter

Sets the paint position manager that can be used by this painter or removes any previously set paint position manager.

Specified by:

setPositionManager in interface IPainter

Parameters:

manager - the paint position manager or null

---

paintControl

public void paintControl(
PaintEvent event)

Description copied from interface: PaintListener

Sent when a paint event occurs for the control.

Specified by:

paintControl in interface PaintListener

Parameters:

event - an event containing information about the paint

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		Eclipse Platform Release 3.5
PREV CLASS   NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD |  CONSTR |  METHOD	DETAIL: FIELD |  CONSTR |  METHOD

---

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.