GlobalScreen (jnativehook)

java.lang.Object
- org.jnativehook.GlobalScreen

```
public class GlobalScreen
extends Object
```
GlobalScreen is used to represent the native screen area that Java does not usually have access to. This class can be thought of as the source component for native input events.
This class also handles the loading, unpacking and communication with the native library. That includes registering and unregistering the native hook with the underlying operating system and adding global keyboard and mouse listeners.

Version:

1.1

Author:

Alexander Barker (alex@1stleg.com)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addNativeKeyListener(NativeKeyListener listener)` Adds the specified native key listener to receive key events from the native system.
`void`	`addNativeMouseListener(NativeMouseListener listener)` Adds the specified native mouse listener to receive mouse events from the native system.
`void`	`addNativeMouseMotionListener(NativeMouseMotionListener listener)` Adds the specified native mouse motion listener to receive mouse motion events from the native system.
`void`	`addNativeMouseWheelListener(NativeMouseWheelListener listener)` Adds the specified native mouse wheel listener to receive mouse wheel events from the native system.
`void`	`dispatchEvent(NativeInputEvent e)` Dispatches an event to the appropriate processor.
`protected void`	`finalize()` A destructor that will perform native cleanup by calling the `unregisterNativeHook()` method.
`static GlobalScreen`	`getInstance()` Returns the singleton instance of `GlobalScreen`.
`static boolean`	`isNativeHookRegistered()` Returns `true` if the native hook is currently registered.
`protected static void`	`loadNativeLibrary()` Perform procedures to interface with the native library.
`protected void`	`processKeyEvent(NativeKeyEvent e)` Processes native key events by dispatching them to all registered `NativeKeyListener` objects.
`protected void`	`processMouseEvent(NativeMouseEvent e)` Processes native mouse events by dispatching them to all registered `NativeMouseListener` objects.
`protected void`	`processMouseWheelEvent(NativeMouseWheelEvent e)` Processes native mouse wheel events by dispatching them to all registered `NativeMouseWheelListener` objects.
`static void`	`registerNativeHook()` Enable the native hook if it is not currently running.
`void`	`removeNativeKeyListener(NativeKeyListener listener)` Removes the specified native key listener so that it no longer receives key events from the native system.
`void`	`removeNativeMouseListener(NativeMouseListener listener)` Removes the specified native mouse listener so that it no longer receives mouse events from the native system.
`void`	`removeNativeMouseMotionListener(NativeMouseMotionListener listener)` Removes the specified native mouse motion listener so that it no longer receives mouse motion events from the native system.
`void`	`removeNativeMouseWheelListener(NativeMouseWheelListener listener)` Removes the specified native mouse wheel listener so that it no longer receives mouse wheel events from the native system.
`protected void`	`startEventDispatcher()` Initialize a local executor service for event delivery.
`protected void`	`stopEventDispatcher()` Shutdown the local executor service for event delivery.
`protected static void`	`unloadNativeLibrary()` Perform procedures to cleanup the native library.
`static void`	`unregisterNativeHook()` Disable the native hook if it is currently registered.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    A destructor that will perform native cleanup by calling the unregisterNativeHook() method. This method will not run until the class is garbage collected.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable - a NativeHookException raised by calling unloadNativeLibrary()
    See Also:
    Object.finalize()
  - getInstance
```
public static GlobalScreen getInstance()
```
    Returns the singleton instance of GlobalScreen.
    
    Returns:
    singleton instance of GlobalScreen
  - addNativeKeyListener
```
public void addNativeKeyListener(NativeKeyListener listener)
```
    Adds the specified native key listener to receive key events from the native system. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native key listener object
  - removeNativeKeyListener
```
public void removeNativeKeyListener(NativeKeyListener listener)
```
    Removes the specified native key listener so that it no longer receives key events from the native system. This method performs no function if the listener specified by the argument was not previously added. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native key listener object
  - addNativeMouseListener
```
public void addNativeMouseListener(NativeMouseListener listener)
```
    Adds the specified native mouse listener to receive mouse events from the native system. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native mouse listener object
  - removeNativeMouseListener
```
public void removeNativeMouseListener(NativeMouseListener listener)
```
    Removes the specified native mouse listener so that it no longer receives mouse events from the native system. This method performs no function if the listener specified by the argument was not previously added. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native mouse listener object
  - addNativeMouseMotionListener
```
public void addNativeMouseMotionListener(NativeMouseMotionListener listener)
```
    Adds the specified native mouse motion listener to receive mouse motion events from the native system. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native mouse motion listener object
  - removeNativeMouseMotionListener
```
public void removeNativeMouseMotionListener(NativeMouseMotionListener listener)
```
    Removes the specified native mouse motion listener so that it no longer receives mouse motion events from the native system. This method performs no function if the listener specified by the argument was not previously added. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native mouse motion listener object
  - addNativeMouseWheelListener
```
public void addNativeMouseWheelListener(NativeMouseWheelListener listener)
```
    Adds the specified native mouse wheel listener to receive mouse wheel events from the native system. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native mouse wheel listener object
    Since:
    
    1.1
  - removeNativeMouseWheelListener
```
public void removeNativeMouseWheelListener(NativeMouseWheelListener listener)
```
    Removes the specified native mouse wheel listener so that it no longer receives mouse wheel events from the native system. This method performs no function if the listener specified by the argument was not previously added. If listener is null, no exception is thrown and no action is performed.
    
    Parameters:
    listener - a native mouse wheel listener object
    Since:
    
    1.1
  - registerNativeHook
```
public static void registerNativeHook()
                               throws NativeHookException
```
    Enable the native hook if it is not currently running. If it is running the function has no effect.
    Note: This method will throw a NativeHookException if specific operating system features are unavailable or disabled. For example: Access for assistive devices is unchecked in the Universal Access section of the System Preferences on Apple's OS X platform or Load "record" is missing for the xorg.conf file on Unix/Linux/Solaris platforms.
    
    Throws:
    
    NativeHookException - problem registering the native hook with the underlying operating system.
    Since:
    
    1.1
  - unregisterNativeHook
```
public static void unregisterNativeHook()
```
    Disable the native hook if it is currently registered. If the native hook it is not registered the function has no effect.
    
    Since:
    
    1.1
  - isNativeHookRegistered
```
public static boolean isNativeHookRegistered()
```
    Returns true if the native hook is currently registered.
    
    Returns:
    true if the native hook is currently registered.
    Since:
    
    1.1
  - dispatchEvent
```
public final void dispatchEvent(NativeInputEvent e)
```
    Dispatches an event to the appropriate processor. This method is generally called by the native library but maybe used to synthesize native events from Java.
    
    Parameters:
    e - the NativeInputEvent to dispatch.
  - processKeyEvent
```
protected void processKeyEvent(NativeKeyEvent e)
```
    Processes native key events by dispatching them to all registered NativeKeyListener objects.
    
    Parameters:
    e - the NativeKeyEvent to dispatch.
    See Also:
    NativeKeyEvent, NativeKeyListener, addNativeKeyListener(NativeKeyListener)
  - processMouseEvent
```
protected void processMouseEvent(NativeMouseEvent e)
```
    Processes native mouse events by dispatching them to all registered NativeMouseListener objects.
    
    Parameters:
    e - the NativeMouseEvent to dispatch.
    See Also:
    NativeMouseEvent, NativeMouseListener, addNativeMouseListener(NativeMouseListener)
  - processMouseWheelEvent
```
protected void processMouseWheelEvent(NativeMouseWheelEvent e)
```
    Processes native mouse wheel events by dispatching them to all registered NativeMouseWheelListener objects.
    
    Parameters:
    e - The NativeMouseWheelEvent to dispatch.
    Since:
    
    1.1
    
    See Also:
    NativeMouseWheelEvent, NativeMouseWheelListener, addNativeMouseWheelListener(NativeMouseWheelListener)
  - startEventDispatcher
```
protected void startEventDispatcher()
```
    Initialize a local executor service for event delivery. This method should only be called by the native library during the hook registration process.
    
    Since:
    
    1.1
  - stopEventDispatcher
```
protected void stopEventDispatcher()
```
    Shutdown the local executor service for event delivery. Any events events pending delivery will be discarded. This method should only be called by the native library during the hook deregistration process.
    
    Since:
    
    1.1
  - loadNativeLibrary
```
protected static void loadNativeLibrary()
```
    Perform procedures to interface with the native library. These procedures include unpacking and loading the library into the Java Virtual Machine.
  - unloadNativeLibrary
```
protected static void unloadNativeLibrary()
```
    Perform procedures to cleanup the native library. This method is called on garbage collection to ensure proper native cleanup.

Class GlobalScreen

Method Summary

Methods inherited from class java.lang.Object

Method Detail

finalize

getInstance

addNativeKeyListener

removeNativeKeyListener

addNativeMouseListener

removeNativeMouseListener

addNativeMouseMotionListener

removeNativeMouseMotionListener

addNativeMouseWheelListener

removeNativeMouseWheelListener

registerNativeHook

unregisterNativeHook

isNativeHookRegistered

dispatchEvent

processKeyEvent

processMouseEvent

processMouseWheelEvent

startEventDispatcher

stopEventDispatcher

loadNativeLibrary

unloadNativeLibrary