fr.ign.cogit.geoxygene.appli.mode

Class AbstractMode

Object

AbstractMode

All Implemented Interfaces:

Mode, KeyListener, MouseListener, MouseMotionListener, MouseWheelListener, EventListener

Direct Known Subclasses:

AbstractGeometryEditMode, BrowserMode, LensPaintListener, MoveMode, SelectionBoxMode, SelectionMode, ZoomBoxMode, ZoomMode

public abstract class AbstractMode
extends Object
implements Mode

Author:

Julien Perret

Field Summary

Fields

Modifier and Type	Field and Description
protected MainFrame	mainFrame MainFrame.

Constructor Summary

Constructors

Constructor and Description
AbstractMode(MainFrame theMainFrame, MainFrameToolBar theModeSelector) Constructor.

Method Summary

Modifier and Type	Method and Description
void	activated() Activate the mode.
protected abstract JButton	createButton() Create a button.
JButton	getButton()
Cursor	getCursor()
MainFrameToolBar	getModeSelector()
RenderingTypeMode	getRenderingType() Rendering type currently used for this mode (handle user interaction)
protected abstract String	getToolTipText()
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	leftMouseButtonClicked(MouseEvent e, ProjectFrame frame)
void	middleMouseButtonClicked(MouseEvent e, ProjectFrame frame)
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	mouseWheelMoved(MouseWheelEvent e)
void	rightMouseButtonClicked(MouseEvent e, ProjectFrame frame)
void	setModeSelector(MainFrameToolBar theModeSelector) Set the mode selector.
void	setRenderingType(RenderingTypeMode renderingType)

Methods inherited from class Object

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

Field Detail

mainFrame

protected MainFrame mainFrame

MainFrame.

Constructor Detail

AbstractMode

public AbstractMode(MainFrame theMainFrame,
                    MainFrameToolBar theModeSelector)

Constructor.

Parameters:

theMainFrame - the associated application

theModeSelector - the mode selector

Method Detail

setModeSelector

public final void setModeSelector(MainFrameToolBar theModeSelector)

Set the mode selector.

Parameters:

theModeSelector - the new mode selector

getModeSelector

public final MainFrameToolBar getModeSelector()

Returns:

the mode selector

getButton

public final JButton getButton()

Specified by:

getButton in interface Mode

Returns:

the button giving access to this mode

getRenderingType

public RenderingTypeMode getRenderingType()

Description copied from interface: Mode

Rendering type currently used for this mode (handle user interaction)

Specified by:

getRenderingType in interface Mode

Returns:

the renderingType

setRenderingType

public void setRenderingType(RenderingTypeMode renderingType)

Parameters:

renderingType - the renderingType to set

getToolTipText

protected abstract String getToolTipText()

Returns:

The ToolTipText associated with the button

createButton

protected abstract JButton createButton()

Create a button.

Returns:

the created button

keyPressed

public final void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

mouseClicked

public final void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

leftMouseButtonClicked

public void leftMouseButtonClicked(MouseEvent e,
                                   ProjectFrame frame)

Parameters:

e - mouse event

frame - the project frame

middleMouseButtonClicked

public final void middleMouseButtonClicked(MouseEvent e,
                                           ProjectFrame frame)

Parameters:

e - mouse event

frame - the project frame

rightMouseButtonClicked

public void rightMouseButtonClicked(MouseEvent e,
                                    ProjectFrame frame)

Parameters:

e - mouse event

frame - the project frame

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

mouseWheelMoved

public final void mouseWheelMoved(MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface MouseWheelListener

getCursor

public Cursor getCursor()

Specified by:

getCursor in interface Mode

Returns:

The cursor associated with this mode.

activated

public void activated()

Description copied from interface: Mode

Activate the mode. This is a hook in case a mode needs special initialization.

Specified by:

activated in interface Mode