org.jeditor.gui

Class AbstractGutterHandler

java.lang.Object

org.jeditor.gui.AbstractGutterHandler

All Implemented Interfaces:

GutterHandler

public abstract class AbstractGutterHandler
extends java.lang.Object
implements GutterHandler

The AbstractGutterHandler is a GutterHandler which allows to:

• Show a specific image on specific lines
• Have a custom behavior upon clicking on the Gutter
• Have a custom behavior upon hovering on a line the gutter, such as for example showing a tooltip

Example

The following handler:

• Handles a right-click on the gutter and shows a menu for each line
• Shows a tooltip on lines which paint an image

 private class MyGutterHandler extends AbstractGutterHandler {

   public boolean handleClick(Gutter gutter, int mouseButton, int x, int y) {
     if (mouseButton == MouseEvent.BUTTON3) {
       JPopupMenu menu = new JPopupMenu();
       int number = gutter.getLineNumber(y);
       menu.add(new JMenuItem("An Action on " + number));
       menu.show(gutter, x, y);
       return true;
     } else {
       return false;
     }
   }

   public void handleMoved(Gutter gutter, int x, int y) {
     int number = gutter.getLineNumber(y);
     if (isPainting(number)) {
       this.showTooltip("The tooltip on line" + number);
     } else {
       this.hideTooltip();
     }
   }
 }
 

Since:

0.4.19

Field Summary

Fields

Modifier and Type	Field and Description
protected Gutter	gutter The Gutter.

Constructor Summary

Constructors

Constructor and Description
AbstractGutterHandler()
AbstractGutterHandler(Gutter gutter) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addImage(int lineNumber, java.lang.String imageName) Add a binding between a line number and an image resource name.
boolean	addImageResource(java.lang.String name, java.net.URL url) Add an image resource.
boolean	addImageResource(java.lang.String name, java.net.URL url, int offsetX, int offsetY) Add an image resource.
void	clear() Clear the relationship between image names and line numbers.
Gutter	getGutter() Rturn the Gutter.
java.lang.String	getImageName(int lineNumber) Return the image resource name binding for a specified line number.
protected void	hideTooltip() Hide the tooltip.
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 line, int x, int y) Paint a specific image on the gutter for a line number.
void	setGutter(Gutter gutter) Set the Gutter.
protected void	showTooltip(java.lang.String text) Show the tooltip.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jeditor.gui.GutterHandler

handleChangeWidth, handleClick, handleMoved

Field Detail

gutter

protected Gutter gutter

The Gutter.

Constructor Detail

AbstractGutterHandler

public AbstractGutterHandler()

AbstractGutterHandler

public AbstractGutterHandler(Gutter gutter)

Constructor.

Parameters:

gutter - the Gutter

Method Detail

setGutter

public void setGutter(Gutter gutter)

Set the Gutter.

Parameters:

gutter - the Gutter

getGutter

public Gutter getGutter()

Rturn the Gutter.

Returns:

the Gutter

clear

public void clear()

Clear the relationship between image names and line numbers. This can be useful after setting a new Gutter.

addImage

public boolean addImage(int lineNumber,
                        java.lang.String imageName)

Add a binding between a line number and an image resource name.

Parameters:

lineNumber - the line number

imageName - the image resource name

Returns:

true if there was an image rsource with the specific name

isPainting

public boolean isPainting(int lineNumber)

Return true if the GutterHandler should paint a specific element on the gutter for a line number. It will return true if there is an image resource binding for the specific line number.

Specified by:

isPainting in interface GutterHandler

Parameters:

lineNumber - the line number

Returns:

true if there is an image resource binding for the specific line number

getImageName

public java.lang.String getImageName(int lineNumber)

Return the image resource name binding for a specified line number. It will return null if there is no binding for the line number.

Parameters:

lineNumber - the line number

Returns:

the image resource name binding

addImageResource

public boolean addImageResource(java.lang.String name,
                                java.net.URL url)

Add an image resource. Has the same behavior as the addImageResource(java.lang.String, java.net.URL, int, int) method with the following values for the offsetX and offsetY arguments:

• offsetX: the width of the image
• offsetY: half the height of the image

Parameters:

name - the binding name

url - the resource URL

Returns:

true if the image resource URL could be found

addImageResource

public boolean addImageResource(java.lang.String name,
                                java.net.URL url,
                                int offsetX,
                                int offsetY)

Add an image resource.

Parameters:

name - the binding name

url - the resource URL

offsetX - the X offset to use for the painting of the image

offsetY - the Y offset to use for the painting of the image

Returns:

true if the image resource URL could be found

hideTooltip

protected void hideTooltip()

Hide the tooltip. This can be called in the GutterHandler.handleMoved(org.jeditor.gui.Gutter, int, int) method.

showTooltip

protected void showTooltip(java.lang.String text)

Show the tooltip. This can be called in the GutterHandler.handleMoved(org.jeditor.gui.Gutter, int, int) method. For example:

   public void handleMoved(Gutter gutter, int x, int y) {
     int number = gutter.getLineNumber(y);
     if (isPainting(number)) {
       this.showTooltip("The tooltip on line" + number);
     } else {
       this.hideTooltip();
     }
   }
 }
 

Parameters:

text - the tooltip text

paint

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

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

Specified by:

paint in interface GutterHandler

Parameters:

gfx - the Graphics

line - the line number

x - the x position of the line number

y - the y position of the line number