org.eclipse.gef
Interface EditDomain

All Known Implementing Classes:

DefaultEditDomain

public interface EditDomain

The collective state of a GEF "application", defined as its Tools, CommandStack, EditPartViewers, and their contents. An EditDomain is similar to an Eclipse Editor (IEditorPart). However, rather than specializing IEditorPart, EditDomain is a standalone Object. An Editor corresponds to one SWT Control and one IEditorInput.

An EditDomain can encompass other WorkbenchParts, such as Views, in addition to the Editor.

Although rare, a single Editor may have multiple EditDomains, or vice-versa.

Method Summary

void	addViewer(EditPartViewer viewer) Adds an EditPartViewer into the EditDomain.
void	focusGained(FocusEvent event, EditPartViewer viewer) Called when a viewer that the editor controls has gained focus.
void	focusLost(FocusEvent event, EditPartViewer viewer) Called when a viewer that the editor controls has lost focus.
Tool	getActiveTool() Returns the active Tool
CommandStack	getCommandStack() Returns the CommandStack.
void	keyDown(KeyEvent keyEvent, EditPartViewer viewer) Called when a key is pressed within a viewer of this Domain.
void	keyUp(KeyEvent keyEvent, EditPartViewer view) Called when a key is released within a viewer of this Domain.
void	loadDefaultTool() Unloads the current tool and loads the default tool for this Domain.
void	mouseDoubleClick(MouseEvent mouseEvent, EditPartViewer view) Called when the mouse button has been double-clicked on a viewer from this domain.
void	mouseDown(MouseEvent mouseEvent, EditPartViewer view) Called when the mouse button has been pressed over a viewer that the editor controls.
void	mouseDrag(MouseEvent mouseEvent, EditPartViewer view) Called when the mouse has been dragged within a viewer that the editor controls.
void	mouseHover(MouseEvent mouseEvent, EditPartViewer view) Called when the mouse has hovered within a viewer that the editor controls.
void	mouseMove(MouseEvent mouseEvent, EditPartViewer view) Called when the mouse has been moved within a viewer that the editor controls.
void	mouseUp(MouseEvent mouseEvent, EditPartViewer view) Called when the mouse button has been released over a viewer that the editor controls.
void	removeViewer(EditPartViewer view) Adds an already added viewer from the editor.
void	setTool(Tool tool) Sets the active Tool for this EditDomain.
void	viewerEntered(MouseEvent mouseEvent, EditPartViewer viewer) Called when the mouse Enters a viewer from this domain.
void	viewerExited(MouseEvent mouseEvent, EditPartViewer viewer) Called when the mouse Exits a viewer from this domain.

Method Detail

addViewer

public void addViewer(EditPartViewer viewer)

Adds an EditPartViewer into the EditDomain. A viewer is a UI component that Tools can work with. A viewer is most likely contained in a WorkbenchPart of some form, such as the EditorPart or a ViewPart.

Parameters:

viewer - The EditPartViewer

focusGained

public void focusGained(FocusEvent event,
                        EditPartViewer viewer)

Called when a viewer that the editor controls has gained focus.

Parameters:

event - The SWT focus event

viewer - The source of the event.

focusLost

public void focusLost(FocusEvent event,
                      EditPartViewer viewer)

Called when a viewer that the editor controls has lost focus.

Parameters:

event - The SWT focus event

viewer - The source of the event.

getActiveTool

public Tool getActiveTool()

Returns the active Tool

getCommandStack

public CommandStack getCommandStack()

Returns the CommandStack. Command stacks could potentially be shared across domains if this makes sense.

Returns:

The command stack for this edit domain.

keyDown

public void keyDown(KeyEvent keyEvent,
                    EditPartViewer viewer)

Called when a key is pressed within a viewer of this Domain.

Parameters:

keyEvent - The SWT keyboard event

viewer - The source of the event.

keyUp

public void keyUp(KeyEvent keyEvent,
                  EditPartViewer view)

Called when a key is released within a viewer of this Domain.

Parameters:

keyEvent - The SWT keyboard event

viewer - the source of the event.

loadDefaultTool

public void loadDefaultTool()

Unloads the current tool and loads the default tool for this Domain.

mouseDoubleClick

public void mouseDoubleClick(MouseEvent mouseEvent,
                             EditPartViewer view)

Called when the mouse button has been double-clicked on a viewer from this domain.

Parameters:

mouseEvent - The SWT mouse event

viewer - The source of the event.

mouseDown

public void mouseDown(MouseEvent mouseEvent,
                      EditPartViewer view)

Called when the mouse button has been pressed over a viewer that the editor controls.

Parameters:

mouseEvent - The SWT mouse event

viewer - The source of the event.

mouseDrag

public void mouseDrag(MouseEvent mouseEvent,
                      EditPartViewer view)

Called when the mouse has been dragged within a viewer that the editor controls.

Parameters:

mouseEvent - The SWT mouse event

viewer - The source of the event.

mouseHover

public void mouseHover(MouseEvent mouseEvent,
                       EditPartViewer view)

Called when the mouse has hovered within a viewer that the editor controls.

Parameters:

mouseEvent - The SWT mouse event

viewer - The source of the event.

mouseMove

public void mouseMove(MouseEvent mouseEvent,
                      EditPartViewer view)

Called when the mouse has been moved within a viewer that the editor controls.

Parameters:

mouseEvent - The SWT mouse event

viewer - The viewer that the mouse event is over.

mouseUp

public void mouseUp(MouseEvent mouseEvent,
                    EditPartViewer view)

Called when the mouse button has been released over a viewer that the editor controls.

Parameters:

mouseEvent - The SWT mouse event

viewer - The source of the event.

removeViewer

public void removeViewer(EditPartViewer view)

Adds an already added viewer from the editor. A viewer that is removed from the editor will no longer be manipulatable by the editor.

setTool

public void setTool(Tool tool)

Sets the active Tool for this EditDomain.

viewerEntered

public void viewerEntered(MouseEvent mouseEvent,
                          EditPartViewer viewer)

Called when the mouse Enters a viewer from this domain.

viewerExited

public void viewerExited(MouseEvent mouseEvent,
                         EditPartViewer viewer)

Called when the mouse Exits a viewer from this domain.