com.jniwrapper.win32.system
Class HookFunction

java.lang.Object
  extended by com.jniwrapper.Parameter
      extended by com.jniwrapper.Callback
          extended by com.jniwrapper.win32.system.HookFunction
All Implemented Interfaces:
com.jniwrapper.PointerParameter

public abstract class HookFunction
extends com.jniwrapper.Callback

HookFunction is a superclass for all classes representing callback functions used in WinEventHook class. Any class derived from HookFunction must override the callback() method. Use getters to access the function parameters in a callback() method implementation.


Field Summary
 
Fields inherited from class com.jniwrapper.Callback
m
 
Fields inherited from class com.jniwrapper.Parameter
LICENSE_TYPE, V
 
Constructor Summary
HookFunction()
          Creates instance of the HookFunction
 
Method Summary
 int getEvent()
          Specifies the event that occurred.
 long getEventThread()
          Identifies the thread that generated the event.
 long getEventTime()
          returns the time in milliseconds when the event was generated.
 long getIdChild()
          Identifies whether the event was triggered by a child element of the object.
 long getObject()
          Identifies the object associated with the event.
 long getWinEventHook()
          Returns the identifier of an event hook function.
 Wnd getWnd()
          Returns the handle to the window that generates the event.
 
Methods inherited from class com.jniwrapper.Callback
, a, callback, callback, clone, createReturnValueByFields, dispose, getCallingConvention, getDebugInfo, getLength, getParameters, getReturnValue, init, isNull, isUseFieldsForCallbackParameters, read, restoreState, saveState, setCallingConvention, setUseFieldsForCallbackParameters, toPointer, write
 
Methods inherited from class com.jniwrapper.Parameter
a, a, acceptIOPerformer, asReturnValue, b, dataBufferAssigned, equals, getAlignedLength, getAlignmentRequirement, getDataBuffer, getDataBufferOffset, hashCode, indent, pop, push, read, read, setDataBuffer, toByteArray, write
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HookFunction

public HookFunction()
Creates instance of the HookFunction

Method Detail

getWinEventHook

public long getWinEventHook()
Returns the identifier of an event hook function.

Returns:
the identifier of an event hook function.

getEvent

public int getEvent()
Specifies the event that occurred.

Returns:
the event constant.

getWnd

public Wnd getWnd()
Returns the handle to the window that generates the event.

Returns:
the handle to the window that generates the event.

getObject

public long getObject()
Identifies the object associated with the event.

Returns:
the object identifier.

getIdChild

public long getIdChild()
Identifies whether the event was triggered by a child element of the object.

Returns:
the identifier of the child element of the object, or 0 if the event was triggered by the object.

getEventThread

public long getEventThread()
Identifies the thread that generated the event.

Returns:
the thread identifier.

getEventTime

public long getEventTime()
returns the time in milliseconds when the event was generated.

Returns:
the time in milliseconds when the event was generated.