GEF (MVC)
3.8.1.201211122107

org.eclipse.gef.ui.parts
Class GraphicalViewerKeyHandler

java.lang.Object
  extended by org.eclipse.gef.KeyHandler
      extended by org.eclipse.gef.ui.parts.GraphicalViewerKeyHandler
Direct Known Subclasses:
PaletteViewerKeyHandler

public class GraphicalViewerKeyHandler
extends KeyHandler

An extended KeyHandler which processes default keystrokes for common navigation in a GraphicalViewer. This class can be used as a KeyHandler too; Unrecognized keystrokes are sent to the super's implementation. This class will process key events containing the following:

All processed key events will do nothing other than change the selection and/or focus editpart for the viewer.


Constructor Summary
GraphicalViewerKeyHandler(GraphicalViewer viewer)
          Constructs a key handler for the given viewer.
 
Method Summary
protected  GraphicalEditPart getFocusEditPart()
           
protected  java.util.List getNavigationSiblings()
          Returns the list of editparts which are conceptually at the same level of navigation as the currently focused editpart.
protected  GraphicalViewer getViewer()
          Returns the viewer on which this key handler was created.
protected  boolean isViewerMirrored()
           
 boolean keyPressed(KeyEvent event)
          Extended to process key events described above.
protected  void navigateTo(EditPart part, KeyEvent event)
          Navigates to the given EditPart
protected  void processSelect(KeyEvent event)
          This method is invoked when the user presses the space bar.
 
Methods inherited from class org.eclipse.gef.KeyHandler
keyReleased, put, remove, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GraphicalViewerKeyHandler

public GraphicalViewerKeyHandler(GraphicalViewer viewer)
Constructs a key handler for the given viewer.

Parameters:
viewer - the viewer
Method Detail

getFocusEditPart

protected GraphicalEditPart getFocusEditPart()
Returns:
the EditPart that has focus

getNavigationSiblings

protected java.util.List getNavigationSiblings()
Returns the list of editparts which are conceptually at the same level of navigation as the currently focused editpart. By default, these are the siblings of the focused part.

This implementation returns a list that contains the EditPart that has focus.

Returns:
a list of navigation editparts
Since:
3.4

getViewer

protected GraphicalViewer getViewer()
Returns the viewer on which this key handler was created.

Returns:
the viewer

isViewerMirrored

protected boolean isViewerMirrored()
Returns:
true if the viewer is mirrored
Since:
3.4

keyPressed

public boolean keyPressed(KeyEvent event)
Extended to process key events described above.

Overrides:
keyPressed in class KeyHandler
Parameters:
event - the KeyEvent
Returns:
true if KeyEvent was handled in some way
See Also:
KeyHandler.keyPressed(org.eclipse.swt.events.KeyEvent)

navigateTo

protected void navigateTo(EditPart part,
                          KeyEvent event)
Navigates to the given EditPart

Parameters:
part - the EditPart to navigate to
event - the KeyEvent that triggered this traversal

processSelect

protected void processSelect(KeyEvent event)
This method is invoked when the user presses the space bar. It toggles the selection of the EditPart that currently has focus.

Parameters:
event - the key event received

GEF (MVC)
3.8.1.201211122107

Copyright (c) IBM Corp. and others 2000, 2011. All Rights Reserved.