org.jeditor.gui

Interface GutterHandler

All Known Implementing Classes:

AbstractGutterHandler

public interface GutterHandler

The GutterHandler allows to draw custom elements or show custom Popup menus on the Gutter.

Method Summary

Modifier and Type	Method and Description
default void	handleChangeWidth(Gutter gutter, int gutterWidth) Called when the gutter width is changed.
boolean	handleClick(Gutter gutter, int mouseButton, int x, int y) Called for a click on the gutter.
void	handleMoved(Gutter gutter, int x, int y) Called for a mouse moved on the gutter.
boolean	isPainting(int lineNumber) Return true if the GutterHandler should paint a specific element on the gutter for a line number.
void	paint(java.awt.Graphics gfx, int lineNumber, int x, int y) Paint a specific element on the gutter for a line number.

Method Detail

isPainting

boolean isPainting(int lineNumber)

Return true if the GutterHandler should paint a specific element on the gutter for a line number.

Parameters:

lineNumber - the line number

Returns:

true if the GutterHandler should paint a specific element on the gutter for the line number

handleClick

boolean handleClick(Gutter gutter,
                    int mouseButton,
                    int x,
                    int y)

Called for a click on the gutter. The mouseButton argument specifies which button was used for the click:

• MouseEvent.BUTTON1 for left button click
• MouseEvent.BUTTON2 for middle button click
• MouseEvent.BUTTON3 for right button click

Parameters:

gutter - the gutter

mouseButton - the mouse button.

x - the x position

y - the y position

Returns:

true if the click was handled

handleMoved

void handleMoved(Gutter gutter,
                 int x,
                 int y)

Called for a mouse moved on the gutter.

Parameters:

gutter - the gutter

x - the x position

y - the y position

handleChangeWidth

default void handleChangeWidth(Gutter gutter,
                               int gutterWidth)

Called when the gutter width is changed.

Parameters:

gutter - the gutter

gutterWidth - the gutter width

paint

void paint(java.awt.Graphics gfx,
           int lineNumber,
           int x,
           int y)

Paint a specific element on the gutter for a line number.

Parameters:

gfx - the Graphics

lineNumber - the line number

x - the x position of the line number

y - the y position of the line number