Package com.intellij.openapi.editor.impl.softwrap

Interface SoftWrapPainter

All Known Implementing Classes:

ArrowSoftWrapPainter, CompositeSoftWrapPainter, TextBasedSoftWrapPainter

public interface SoftWrapPainter

Defines contract for the service that manages soft wrap-related graphical effects.

For example we may want to draw an arrow just before and after soft wrap-introduced line feed:

     This is a long text 
         that is soft-wrapped
 

Implementations of this interface are not obliged to be thread-safe.

Method Summary

Modifier and Type	Method and Description
boolean	canUse() Allows to answer if it's possible to use current painter implementation at local environment (e.g.
int	getDrawingHorizontalOffset(java.awt.Graphics g, SoftWrapDrawingType drawingType, int x, int y, int lineHeight) Allows to ask about horizontal offset to be applied to the given 'x' coordinate if drawing of the given type is performed at the given graphics buffer.
int	getMinDrawingWidth(SoftWrapDrawingType drawingType) Allows to ask for the minimal width in pixels required for painting of the given type.
int	paint(java.awt.Graphics g, SoftWrapDrawingType drawingType, int x, int y, int lineHeight) Asks to paint drawing of target type at the given graphics buffer at the given position.
void	reinit() Called after a change of font preferences in editor, so that a painter could reset any related internal caches.

Method Detail

paint

int paint(java.awt.Graphics g,
          SoftWrapDrawingType drawingType,
          int x,
          int y,
          int lineHeight)

Asks to paint drawing of target type at the given graphics buffer at the given position.

Parameters:

g - target graphics buffer to draw in

drawingType - target drawing type

x - target 'x' coordinate to use

y - target 'y' coordinate to use

lineHeight - line height used at editor

Returns:

horizontal offset introduced to the given 'x' coordinate after target drawing painting

getDrawingHorizontalOffset

int getDrawingHorizontalOffset(java.awt.Graphics g,
                               SoftWrapDrawingType drawingType,
                               int x,
                               int y,
                               int lineHeight)

Allows to ask about horizontal offset to be applied to the given 'x' coordinate if drawing of the given type is performed at the given graphics buffer.

Generally, this method is useful when we don't want to perform actual drawing for now but want to reserve a space necessary to do that in future. I.e. the aim is to avoid horizontal movement of already drawn content when the drawing is actually performed.

Parameters:

g - target graphics buffer to draw in

drawingType - target drawing type

x - target 'x' coordinate to use

y - target 'y' coordinate to use

lineHeight - line height used at editor

Returns:

horizontal offset that would be introduced if the drawing is performed

getMinDrawingWidth

int getMinDrawingWidth(SoftWrapDrawingType drawingType)

Allows to ask for the minimal width in pixels required for painting of the given type.

Parameters:

drawingType - target drawing type

Returns:

width in pixels required for the painting of the given type

canUse

boolean canUse()

Allows to answer if it's possible to use current painter implementation at local environment (e.g. there is a possible case that particular painter that exploits unicode symbols for drawing can't be used because there is no font at local environment that knows how to draw target symbols).

Returns:

true if current painter can be used at local environment; false otherwise

reinit

void reinit()

Called after a change of font preferences in editor, so that a painter could reset any related internal caches.