org.imajine.image.render

Class EditingTool

java.lang.Object

org.imajine.image.render.EditingTool

All Implemented Interfaces:

KeyListener, MouseListener, MouseMotionListener, EventListener, Overlay

public class EditingTool
extends Object
implements MouseListener, MouseMotionListener, KeyListener, Overlay

Version:

$Id: EditingTool.java,v 20e39e8c9fac 2012/02/02 16:35:02 fabrizio $

Author:

Fabrizio Giudici

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EditingTool.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGED_ATTRIBUTE
protected EditableImageRenderer	imageRenderer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EditingTool(EditableImageRenderer imageRenderer)

Method Summary

Methods

Modifier and Type	Method and Description
void	activate()
void	commitChanges() Programmatically commits the changes.
void	connectButton(JToggleButton button)
void	deactivate()
protected EditingTool.State	getCurrentState()
void	imageChanged() Invoked when the renderer changes the image being edited by this tool.
boolean	isActive()
boolean	isEnabled()
boolean	isVisible()
void	keyPressed(KeyEvent event)
void	keyReleased(KeyEvent event)
void	keyTyped(KeyEvent event)
protected Cursor	makeCursor(Icon icon, String name)
void	mouseClicked(MouseEvent event)
void	mouseDragged(MouseEvent event)
void	mouseEntered(MouseEvent event)
void	mouseExited(MouseEvent event)
void	mouseMoved(MouseEvent event)
void	mousePressed(MouseEvent event)
void	mouseReleased(MouseEvent event)
void	paint(Graphics2D g, EditableImageRenderer imageRenderer) As the Graphics2D object passed is a copy of the original, this method can change attributes (e.g.
protected void	registerState(EditingTool.State state)
protected void	repaint()
void	reset()
void	setEnabled(boolean enabled)
void	setIcon(Icon icon)
protected void	setInitialState(Class<? extends EditingTool.State> initialStateClass)
protected void	setState(Class<? extends EditingTool.State> newStateClass)

Methods inherited from class java.lang.Object

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

Field Detail

CHANGED_ATTRIBUTE

public static final String CHANGED_ATTRIBUTE

imageRenderer

protected final EditableImageRenderer imageRenderer

Constructor Detail

EditingTool

protected EditingTool(EditableImageRenderer imageRenderer)

Method Detail

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()

isActive

public boolean isActive()

commitChanges

public void commitChanges()

Programmatically commits the changes. E.g. called by the save of an image editor when a tools is currently on.

activate

public void activate()

deactivate

public void deactivate()

imageChanged

public void imageChanged()

Invoked when the renderer changes the image being edited by this tool. By default, the tool is deactivated (by invoking deactivate()), but you can change the default behaviour by overriding this method (for instance, committing changes).

reset

public void reset()

setIcon

public void setIcon(Icon icon)

isVisible

public final boolean isVisible()

Specified by:

isVisible in interface Overlay

connectButton

public void connectButton(JToggleButton button)

setInitialState

protected void setInitialState(Class<? extends EditingTool.State> initialStateClass)

setState

protected void setState(Class<? extends EditingTool.State> newStateClass)

getCurrentState

protected EditingTool.State getCurrentState()

registerState

protected void registerState(EditingTool.State state)

repaint

protected void repaint()

makeCursor

protected Cursor makeCursor(Icon icon,
                String name)

mouseClicked

public final void mouseClicked(MouseEvent event)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public final void mousePressed(MouseEvent event)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public final void mouseReleased(MouseEvent event)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public final void mouseEntered(MouseEvent event)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public final void mouseExited(MouseEvent event)

Specified by:

mouseExited in interface MouseListener

mouseDragged

public final void mouseDragged(MouseEvent event)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public final void mouseMoved(MouseEvent event)

Specified by:

mouseMoved in interface MouseMotionListener

keyTyped

public final void keyTyped(KeyEvent event)

Specified by:

keyTyped in interface KeyListener

keyPressed

public final void keyPressed(KeyEvent event)

Specified by:

keyPressed in interface KeyListener

keyReleased

public final void keyReleased(KeyEvent event)

Specified by:

keyReleased in interface KeyListener

paint

public final void paint(Graphics2D g,
         EditableImageRenderer imageRenderer)

Description copied from interface: Overlay

As the Graphics2D object passed is a copy of the original, this method can change attributes (e.g. color, clip) without worrying about restoring them to their original values.

Specified by:

paint in interface Overlay