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

Class CompositeSoftWrapPainter

java.lang.Object

com.intellij.openapi.editor.impl.softwrap.CompositeSoftWrapPainter

All Implemented Interfaces:

SoftWrapPainter

public class CompositeSoftWrapPainter
extends java.lang.Object
implements SoftWrapPainter

Encapsulates logic of wrapping multiple SoftWrapPainter implementations; chooses the one to use and delegates all processing to it.

Not thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM_AFTER_SOFT_WRAP_SIGN_KEY Defines a key to use for checking for code of the custom unicode symbol to use for 'after soft wrap' representation.
static java.lang.String	CUSTOM_BEFORE_SOFT_WRAP_SIGN_KEY Defines a key to use for checking for code of the custom unicode symbol to use for 'before soft wrap' representation.

Constructor Summary

Constructors

Constructor and Description
CompositeSoftWrapPainter(EditorEx editor)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CUSTOM_BEFORE_SOFT_WRAP_SIGN_KEY

public static final java.lang.String CUSTOM_BEFORE_SOFT_WRAP_SIGN_KEY

Defines a key to use for checking for code of the custom unicode symbol to use for 'before soft wrap' representation.

Target value (if any) is assumed to be in hex format.

See Also:

Constant Field Values

CUSTOM_AFTER_SOFT_WRAP_SIGN_KEY

public static final java.lang.String CUSTOM_AFTER_SOFT_WRAP_SIGN_KEY

Defines a key to use for checking for code of the custom unicode symbol to use for 'after soft wrap' representation.

Target value (if any) is assumed to be in hex format.

See Also:

Constant Field Values

Constructor Detail

CompositeSoftWrapPainter

public CompositeSoftWrapPainter(EditorEx editor)

Method Detail

paint

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

Description copied from interface: SoftWrapPainter

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

Specified by:

paint in interface SoftWrapPainter

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

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

Description copied from interface: SoftWrapPainter

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.

Specified by:

getDrawingHorizontalOffset in interface SoftWrapPainter

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

public int getMinDrawingWidth(SoftWrapDrawingType drawingType)

Description copied from interface: SoftWrapPainter

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

Specified by:

getMinDrawingWidth in interface SoftWrapPainter

Parameters:

drawingType - target drawing type

Returns:

width in pixels required for the painting of the given type

canUse

public boolean canUse()

Description copied from interface: SoftWrapPainter

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

Specified by:

canUse in interface SoftWrapPainter

Returns:

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

reinit

public void reinit()

Description copied from interface: SoftWrapPainter

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

Specified by:

reinit in interface SoftWrapPainter