AbstractHook (SAFS API DOCUMENT)

java.lang.Object
- org.safs.natives.AbstractHook

Direct Known Subclasses:

KeyboardHook, LLKeyboardHook, LLMouseHook, MouseHook
```
public abstract class AbstractHook
extends java.lang.Object
```
AbstractHook is an abstract implementation of setting a callback(hook) procedure for Hook mechanism, by which an application can intercept events in OS, such as messages, mouse actions, and keystrokes.
Concrete implementation of specific hook types will extend this class.

Author:

JunwuMa
OCT 21, 2010 JunwuMa Initial Release

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.sun.jna.Pointer`	`hhk`
`protected int`	`hookId`
`protected java.lang.String`	`hookname`
`protected com.sun.jna.win32.StdCallLibrary.StdCallCallback`	`hookProc`
`protected boolean`	`isHooked`
`protected java.util.ArrayList<CallbackHookListener>`	`listeners`
`protected static User32`	`USER32INST`
`static int`	`WM_CHAR`
`static int`	`WM_KEYDOWN`
`static int`	`WM_KEYUP`
`static int`	`WM_KILLFOCUS`
`static int`	`WM_LBUTTONDBLCLK`
`static int`	`WM_LBUTTONDOWN`
`static int`	`WM_LBUTTONUP`
`static int`	`WM_MOUSEHOVER`
`static int`	`WM_MOUSEMOVE`
`static int`	`WM_RBUTTONDOWN`
`static int`	`WM_RBUTTONUP`
`static int`	`WM_SETFOCUS`
`static int`	`WM_SYSKEYDOWN`
`static int`	`WM_SYSKEYUP`
`static int`	`WM_UNICHAR`

Constructor Summary

Constructors
Constructor and Description

AbstractHook(java.lang.String name)

Constructors
Constructor and Description
`AbstractHook(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addListener(CallbackHookListener listener)` add a listener for current Hook, it should be overridden in its derived classes for setting a specific listener.
`com.sun.jna.Pointer`	`getHook()`
`boolean`	`isHooked()`
`boolean`	`removeListener(CallbackHookListener listener)` remove a listener from the listener list
`void`	`run()` start the hook
`protected void`	`setHook(int id, com.sun.jna.win32.StdCallLibrary.StdCallCallback proc)` set necessary information for a specific hook to be installed
`void`	`stop()` stop the hook

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

- Field Detail
  - WM_LBUTTONDOWN
```
public static final int WM_LBUTTONDOWN
```
    See Also:
    
    Constant Field Values
  - WM_LBUTTONUP
```
public static final int WM_LBUTTONUP
```
    See Also:
    
    Constant Field Values
  - WM_LBUTTONDBLCLK
```
public static final int WM_LBUTTONDBLCLK
```
    See Also:
    
    Constant Field Values
  - WM_RBUTTONDOWN
```
public static final int WM_RBUTTONDOWN
```
    See Also:
    
    Constant Field Values
  - WM_RBUTTONUP
```
public static final int WM_RBUTTONUP
```
    See Also:
    
    Constant Field Values
  - WM_MOUSEMOVE
```
public static final int WM_MOUSEMOVE
```
    See Also:
    
    Constant Field Values
  - WM_MOUSEHOVER
```
public static final int WM_MOUSEHOVER
```
    See Also:
    
    Constant Field Values
  - WM_KEYDOWN
```
public static final int WM_KEYDOWN
```
    See Also:
    
    Constant Field Values
  - WM_CHAR
```
public static final int WM_CHAR
```
    See Also:
    
    Constant Field Values
  - WM_SETFOCUS
```
public static final int WM_SETFOCUS
```
    See Also:
    
    Constant Field Values
  - WM_KILLFOCUS
```
public static final int WM_KILLFOCUS
```
    See Also:
    
    Constant Field Values
  - WM_KEYUP
```
public static final int WM_KEYUP
```
    See Also:
    
    Constant Field Values
  - WM_SYSKEYDOWN
```
public static final int WM_SYSKEYDOWN
```
    See Also:
    
    Constant Field Values
  - WM_SYSKEYUP
```
public static final int WM_SYSKEYUP
```
    See Also:
    
    Constant Field Values
  - WM_UNICHAR
```
public static final int WM_UNICHAR
```
    See Also:
    
    Constant Field Values
  - hookname
```
protected java.lang.String hookname
```
  - hhk
```
protected com.sun.jna.Pointer hhk
```
  - isHooked
```
protected boolean isHooked
```
  - hookId
```
protected int hookId
```
  - hookProc
```
protected com.sun.jna.win32.StdCallLibrary.StdCallCallback hookProc
```
  - USER32INST
```
protected static User32 USER32INST
```
  - listeners
```
protected java.util.ArrayList<CallbackHookListener> listeners
```
- Constructor Detail
  - AbstractHook
```
public AbstractHook(java.lang.String name)
```
- Method Detail
  - addListener
```
public boolean addListener(CallbackHookListener listener)
```
    add a listener for current Hook, it should be overridden in its derived classes for setting a specific listener.
    
    Parameters:
    
    listener - -- a CallbackHookListener
    
    Returns:
    
    true if succeeds; otherwise false
  - removeListener
```
public boolean removeListener(CallbackHookListener listener)
```
    remove a listener from the listener list
    
    Parameters:
    
    listener - -- a CallbackHookListener
    
    Returns:
    
    true if succeeds; otherwise false
  - setHook
```
protected void setHook(int id,
                       com.sun.jna.win32.StdCallLibrary.StdCallCallback proc)
```
    set necessary information for a specific hook to be installed
    
    Parameters:
    
    id - -- the type of hook
    
    proc - -- the callback procedure that should matched the first parameter
  - isHooked
```
public boolean isHooked()
```
  - getHook
```
public com.sun.jna.Pointer getHook()
```
  - run
```
public void run()
```
    start the hook
  - stop
```
public void stop()
```
    stop the hook

Class AbstractHook

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WM_LBUTTONDOWN

WM_LBUTTONUP

WM_LBUTTONDBLCLK

WM_RBUTTONDOWN

WM_RBUTTONUP

WM_MOUSEMOVE

WM_MOUSEHOVER

WM_KEYDOWN

WM_CHAR

WM_SETFOCUS

WM_KILLFOCUS

WM_KEYUP

WM_SYSKEYDOWN

WM_SYSKEYUP

WM_UNICHAR

hookname

hhk

isHooked

hookId

hookProc

USER32INST

listeners

Constructor Detail

AbstractHook

Method Detail

addListener

removeListener

setHook

isHooked

getHook

run

stop