ModeManager (GEF Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.tigris.gef.base
Class ModeManager

java.lang.Object
  org.tigris.gef.base.ModeManager

All Implemented Interfaces:: java.util.EventListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.io.Serializable

public class ModeManager
extends java.lang.Object
implements java.io.Serializable, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.KeyListener

ModeManager keeps track of all the Modes for a given Editor. Events are passed to the Modes for handling. The submodes are prioritized according to their order on a stack, i.e., the last Mode added gets the first chance to handle an Event. The Modes must be of type FigModifyingMode, because Editor can only deal with such Modes.

See Also:: Serialized Form

Field Summary
`protected javax.swing.event.EventListenerList`	`_listeners`
`Editor`	`editor` The Editor that owns this ModeManager.

Constructor Summary
`ModeManager(Editor ed)` Construct a ModeManager with no modes.

Method Summary
`void`	`addModeChangeListener(ModeChangeListener listener)`
`void`	`checkModeTransitions(java.awt.event.InputEvent ie)` Check for events that should cause transitions from one Mode to another or otherwise change the ModeManager.
`protected void`	`fireModeChanged()`
`Editor`	`getEditor()` Get the parent Editor of this ModeManager
`java.util.Vector`	`getModes()` Reply the stack of Mode's.
`boolean`	`includes(java.lang.Class modeClass)`
`void`	`keyPressed(java.awt.event.KeyEvent ke)` Pass events to all modes in order, until one consumes it.
`void`	`keyReleased(java.awt.event.KeyEvent ke)` Pass events to all modes in order, until one consumes it.
`void`	`keyTyped(java.awt.event.KeyEvent ke)` Pass events to all modes in order, until one consumes it.
`void`	`leaveAll()` Finish all modes immediately.
`void`	`mouseClicked(java.awt.event.MouseEvent me)` Pass events to all modes in order, until one consumes it.
`void`	`mouseDragged(java.awt.event.MouseEvent me)` Pass events to all modes in order, until one consumes it.
`void`	`mouseEntered(java.awt.event.MouseEvent me)` Pass events to all modes in order, until one consumes it.
`void`	`mouseExited(java.awt.event.MouseEvent me)` Pass events to all modes in order, until one consumes it.
`void`	`mouseMoved(java.awt.event.MouseEvent me)` Pass events to all modes in order, until one consumes it.
`void`	`mousePressed(java.awt.event.MouseEvent me)` Pass events to all modes in order, until one consumes it.
`void`	`mouseReleased(java.awt.event.MouseEvent me)` Pass events to all modes in order, until one consumes it.
`void`	`paint(java.awt.Graphics g)` Paint each mode in the stack: bottom to top.
`FigModifyingMode`	`pop()` Remove the topmost Mode if it can exit.
`void`	`popAll()` Remove all Modes that can exit.
`void`	`push(FigModifyingMode newMode)` Add the given Mode to the stack if another instance of the same class is not already on the stack.
`void`	`removeModeChangeListener(ModeChangeListener listener)`
`void`	`setEditor(Editor w)` Set the parent Editor of this ModeManager
`void`	`setModes(java.util.Vector newModes)` Set the entire stack of Mode's.
`FigModifyingMode`	`top()` Reply the top (first) Mode.

Methods inherited from class java.lang.Object

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

Field Detail

editor

public Editor editor

The Editor that owns this ModeManager.

_listeners

protected javax.swing.event.EventListenerList _listeners

Constructor Detail

ModeManager

public ModeManager(Editor ed)

Construct a ModeManager with no modes.

Method Detail

setEditor

public void setEditor(Editor w)

Set the parent Editor of this ModeManager

getEditor

public Editor getEditor()

Get the parent Editor of this ModeManager

getModes

public java.util.Vector getModes()

Reply the stack of Mode's.

setModes

public void setModes(java.util.Vector newModes)

Set the entire stack of Mode's.

top

public FigModifyingMode top()

Reply the top (first) Mode.

push

public void push(FigModifyingMode newMode)

Add the given Mode to the stack if another instance of the same class is not already on the stack.

pop

public FigModifyingMode pop()

Remove the topmost Mode if it can exit.

popAll

public void popAll()

Remove all Modes that can exit.

includes

public boolean includes(java.lang.Class modeClass)

leaveAll

public void leaveAll()

Finish all modes immediately.