Eclipse GEF
3.1

org.eclipse.gef
Class MouseWheelHandler.KeyGenerator

java.lang.Object
  extended byorg.eclipse.gef.MouseWheelHandler.KeyGenerator
Enclosing class:
MouseWheelHandler

public static class MouseWheelHandler.KeyGenerator
extends Object

A utility class used to generate keys from a given stateMask. A MouseWheelHandler registered with such a key would only be asked to handle mouse-wheel events that have the same stateMask as the one that was used to generate the key.

Since:
3.1

Constructor Summary
MouseWheelHandler.KeyGenerator()
           
 
Method Summary
static String getKey(int stateMask)
          The returned String is guaranteed to be equal for two different invocations with the same stateMask.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MouseWheelHandler.KeyGenerator

public MouseWheelHandler.KeyGenerator()
Method Detail

getKey

public static String getKey(int stateMask)
The returned String is guaranteed to be equal for two different invocations with the same stateMask.

Valid stateMasks are SWT.NONE, SWT.CTRL, SWT.COMMAND, SWT.ALT, SWT.SHIFT, SWT.MOD1, SWT.MOD2, SWT.MOD3, SWT.MOD4, SWT.BUTTON* or any combination thereof.

Parameters:
stateMask - the state indicating which buttons/modifiers are active
Returns:
key for the given stateMask
Throws:
IllegalArgumentException - if the given stateMask is not valid

Eclipse GEF
3.1

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