MsgBlasterPeer (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.client.MsgBlasterPeer

All Implemented Interfaces:

WindowSizeMoveListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.WindowListener, java.util.EventListener
```
public class MsgBlasterPeer
extends java.lang.Object
implements java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.WindowListener, WindowSizeMoveListener
```
Intercepts some low level (OS) messages and send them to server peer to be dispatched as ActiveX events.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CUSTOM_WM_1` A custom event found in customer's code.
`private int`	`hWndTarget` The target window whose messages will be intercepted.
`private long`	`id` My id.
`private java.util.Map<java.lang.Integer,java.lang.Integer>`	`indexedMessages` The indexed list of messages.
`private java.util.Map<java.lang.Integer,java.lang.Integer>`	`indexedPass` The indexed list of passages.
`private static java.util.Map<java.lang.Long,MsgBlasterPeer>`	`instances` The registry of instances of this class.
`static CentralLogger`	`LOG` Logger
`private java.util.Map<java.lang.Integer,java.lang.Integer>`	`messages` The map of messages to their indexes.
`static int`	`MK_CONTROL` The CTRL key is down.
`static int`	`MK_LBUTTON` The left mouse button is down.
`static int`	`MK_MBUTTON` The middle mouse button is down.
`static int`	`MK_RBUTTON` The right mouse button is down.
`static int`	`MK_SHIFT` The SHIFT key is down.
`static int`	`SC_CONTEXTHELP` Context help pressed.
`static int`	`SC_KEYMENU` Request to open window menu as with a keystroke
`private int`	`targetWinId` The id of target window.
`static int`	`WA_ACTIVE` Window activated by some method other than a mouse click.
`static int`	`WA_CLICKACTIVE` Window activated by a mouse click.
`static int`	`WA_INACTIVE` Window deactivated.
`private WidgetStateListener`	`widgetStateListener` The widget state listener instance registered with the target widget
`static int`	`WM_ACTIVATE` Sent to both the window being activated and the window being deactivated.
`static int`	`WM_EXITSIZEMOVE` Window move/size message.
`static int`	`WM_LBUTTONDOWN` Left mouse button pressed event.
`static int`	`WM_LBUTTONUP` Left mouse button released event.
`static int`	`WM_MENUCHAR` Sent when a menu is active and the user presses a key that does not correspond to any mnemonic or accelerator key.
`static int`	`WM_MOUSEMOVE` Mouse moved event (regardless whether a mouse button is down = includes drag events).
`static int`	`WM_MOVE` Window move/size message.
`static int`	`WM_RBUTTONDOWN` Right mouse button pressed event.
`static int`	`WM_RBUTTONUP` Right mouse button released event.
`static int`	`WM_SIZE` Window move/size message.
`static int`	`WM_SYSCOMMAND` A command was chosen from the Windows menu or when the user chooses the maximize button, minimize button, restore button, or close button.

Constructor Summary

Constructors
Constructor and Description

MsgBlasterPeer()

Constructors
Constructor and Description
`MsgBlasterPeer()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessage(int index, int message, int pass)` Adds a new Windows message to be intercepted.
`void`	`clearMessages()` Clears all listening messages.
`private static int`	`convertModifiers(int modifiersEx)` Converts the modifiers from Java style to Win32 style.
`static void`	`dropInstance(long id)` Remove the `MsgBlasterPeer` instance from the registry because its peer was destroyed or inactivated.
`static MsgBlasterPeer`	`getInstance(long id)` Obtain an instance with specified `id`.
`int`	`getTargetHwnd()` Obtain the id of the widget that this MessageBlaster is configured with.
`private void`	`install()` Installs the MsgBlaster instance with the target top level window and the target widget.
`private void`	`installTargetWindow()` Installs the MsgBlaster instance with the target top level window.
`void`	`keyPressed(java.awt.event.KeyEvent e)`
`void`	`keyReleased(java.awt.event.KeyEvent e)`
`void`	`keyTyped(java.awt.event.KeyEvent e)`
`void`	`mouseClicked(java.awt.event.MouseEvent e)`
`void`	`mouseDragged(java.awt.event.MouseEvent e)` Intercepts mouse move events with a mouse button down on target window.
`void`	`mouseEntered(java.awt.event.MouseEvent e)`
`void`	`mouseExited(java.awt.event.MouseEvent e)`
`void`	`mouseMoved(java.awt.event.MouseEvent e)` Intercepts mouse move events on target window.
`void`	`mousePressed(java.awt.event.MouseEvent e)` Intercepts mouse click events on target window.
`void`	`mouseReleased(java.awt.event.MouseEvent e)`
`void`	`onWindowMoved(TopLevelWindow wnd)` Called when the supplied window is moved.
`void`	`onWindowResized(TopLevelWindow wnd)` Called when the supplied window is resized.
`private int`	`processCoordinates(java.awt.Point p)` Combines the coordinate of a mouse event in a single integer.
`void`	`setTargetHwnd(int hWndTarget)` Set the target widget.
`private void`	`uninstall()` Uninstalls msg blaster from its top level window and the target widget.
`private void`	`uninstallTargetWindow()` Uninstalls the MsgBlaster instance from the target top level window.
`void`	`windowActivated(java.awt.event.WindowEvent e)`
`void`	`windowClosed(java.awt.event.WindowEvent e)`
`void`	`windowClosing(java.awt.event.WindowEvent e)`
`void`	`windowDeactivated(java.awt.event.WindowEvent e)`
`void`	`windowDeiconified(java.awt.event.WindowEvent e)`
`void`	`windowIconified(java.awt.event.WindowEvent e)`
`void`	`windowOpened(java.awt.event.WindowEvent e)`

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

- Field Detail
  - LOG
```
public static final CentralLogger LOG
```
    Logger
  - WM_SIZE
```
public static final int WM_SIZE
```
    Window move/size message.
    More info on:
    https://docs.microsoft.com/cs-cz/windows/win32/winmsg/wm-exitsizemove
    
    See Also:
    
    Constant Field Values
  - WM_MOVE
```
public static final int WM_MOVE
```
    Window move/size message.
    More info on:
    https://docs.microsoft.com/cs-cz/windows/win32/winmsg/wm-exitsizemove
    
    See Also:
    
    Constant Field Values
  - WM_EXITSIZEMOVE
```
public static final int WM_EXITSIZEMOVE
```
    Window move/size message.
    More info on:
    https://docs.microsoft.com/cs-cz/windows/win32/winmsg/wm-exitsizemove
    
    See Also:
    
    Constant Field Values
  - WM_ACTIVATE
```
public static final int WM_ACTIVATE
```
    Sent to both the window being activated and the window being deactivated.
    More info on:
    https://docs.microsoft.com/en-us/windows/desktop/inputdev/wm-activate
    
    See Also:
    
    Constant Field Values
  - WM_SYSCOMMAND
```
public static final int WM_SYSCOMMAND
```
    A command was chosen from the Windows menu or when the user chooses the maximize button, minimize button, restore button, or close button.
    More info on:
    https://docs.microsoft.com/en-us/windows/desktop/menurc/wm-syscommand
    
    See Also:
    
    Constant Field Values
  - WM_MENUCHAR
```
public static final int WM_MENUCHAR
```
    Sent when a menu is active and the user presses a key that does not correspond to any mnemonic or accelerator key.
    More info on:
    https://docs.microsoft.com/en-us/windows/desktop/menurc/wm-menuchar
    
    See Also:
    
    Constant Field Values
  - WM_MOUSEMOVE
```
public static final int WM_MOUSEMOVE
```
    Mouse moved event (regardless whether a mouse button is down = includes drag events).
    More info on:
    https://docs.microsoft.com/en-us/windows/desktop/inputdev/wm-mousemove
    
    See Also:
    
    Constant Field Values
  - WM_LBUTTONDOWN
```
public static final int WM_LBUTTONDOWN
```
    Left mouse button pressed event.
    More info on:
    https://docs.microsoft.com/en-us/windows/desktop/inputdev/wm-lbuttondown
    
    See Also:
    
    Constant Field Values
  - WM_LBUTTONUP
```
public static final int WM_LBUTTONUP
```
    Left mouse button released event.
    More info on:
    https://learn.microsoft.com/en-us/windows/win32/inputdev/wm-lbuttonup
    
    See Also:
    
    Constant Field Values
  - WM_RBUTTONDOWN
```
public static final int WM_RBUTTONDOWN
```
    Right mouse button pressed event.
    More info on:
    https://docs.microsoft.com/en-us/windows/desktop/inputdev/wm-rbuttondown
    
    See Also:
    
    Constant Field Values
  - WM_RBUTTONUP
```
public static final int WM_RBUTTONUP
```
    Right mouse button released event.
    More info on:
    https://learn.microsoft.com/en-us/windows/win32/inputdev/wm-rbuttonup
    
    See Also:
    
    Constant Field Values
  - CUSTOM_WM_1
```
public static final int CUSTOM_WM_1
```
    A custom event found in customer's code.
    
    See Also:
    
    Constant Field Values
  - MK_LBUTTON
```
public static final int MK_LBUTTON
```
    The left mouse button is down.
    
    See Also:
    
    Constant Field Values
  - MK_RBUTTON
```
public static final int MK_RBUTTON
```
    The right mouse button is down.
    
    See Also:
    
    Constant Field Values
  - MK_SHIFT
```
public static final int MK_SHIFT
```
    The SHIFT key is down.
    
    See Also:
    
    Constant Field Values
  - MK_CONTROL
```
public static final int MK_CONTROL
```
    The CTRL key is down.
    
    See Also:
    
    Constant Field Values
  - MK_MBUTTON
```
public static final int MK_MBUTTON
```
    The middle mouse button is down.
    
    See Also:
    
    Constant Field Values
  - SC_KEYMENU
```
public static final int SC_KEYMENU
```
    Request to open window menu as with a keystroke
    
    See Also:
    
    Constant Field Values
  - SC_CONTEXTHELP
```
public static final int SC_CONTEXTHELP
```
    Context help pressed.
    
    See Also:
    
    Constant Field Values
  - WA_INACTIVE
```
public static final int WA_INACTIVE
```
    Window deactivated.
    
    See Also:
    
    Constant Field Values
  - WA_ACTIVE
```
public static final int WA_ACTIVE
```
    Window activated by some method other than a mouse click.
    
    See Also:
    
    Constant Field Values
  - WA_CLICKACTIVE
```
public static final int WA_CLICKACTIVE
```
    Window activated by a mouse click.
    
    See Also:
    
    Constant Field Values
  - instances
```
private static java.util.Map<java.lang.Long,MsgBlasterPeer> instances
```
    The registry of instances of this class.
  - hWndTarget
```
private int hWndTarget
```
    The target window whose messages will be intercepted.
  - targetWinId
```
private int targetWinId
```
    The id of target window.
  - id
```
private long id
```
    My id. Used to associate with server-side peer.
  - indexedMessages
```
private final java.util.Map<java.lang.Integer,java.lang.Integer> indexedMessages
```
    The indexed list of messages.
  - indexedPass
```
private final java.util.Map<java.lang.Integer,java.lang.Integer> indexedPass
```
    The indexed list of passages.
  - messages
```
private final java.util.Map<java.lang.Integer,java.lang.Integer> messages
```
    The map of messages to their indexes. Also used for fast access.
  - widgetStateListener
```
private WidgetStateListener widgetStateListener
```
    The widget state listener instance registered with the target widget
- Constructor Detail
  - MsgBlasterPeer
```
public MsgBlasterPeer()
```
- Method Detail
  - getInstance
```
public static MsgBlasterPeer getInstance(long id)
```
    Obtain an instance with specified id. If it does not exist it is created and stored before returning it.
    
    Parameters:
    
    id - The id of the MsgBlaster
    
    Returns:
    
    The instance of MsgBlasterPeer with specified id.
  - dropInstance
```
public static void dropInstance(long id)
```
    Remove the MsgBlasterPeer instance from the registry because its peer was destroyed or inactivated.
    
    Parameters:
    
    id - The id of the MsgBlasterPeer to be removed.
  - setTargetHwnd
```
public void setTargetHwnd(int hWndTarget)
```
    Set the target widget. Some listeners will be installed for this window. If already configured, the old listeners are removed from that target.
    
    Parameters:
    
    hWndTarget - The hwnd of the target widget.
  - getTargetHwnd
```
public int getTargetHwnd()
```
    Obtain the id of the widget that this MessageBlaster is configured with.
    
    Returns:
    
    the id of the widget that this MessageBlaster is configured with.
  - addMessage
```
public void addMessage(int index,
                       int message,
                       int pass)
```
    Adds a new Windows message to be intercepted.
    Parameters:
    
    message - The id of the windows message to be intercepted.
    pass - Passage mode. Possible values (extracted from comments in customer's code):
    
    -1 = Windows has message digested first;
    0 = Windows does nothing with message.
  - clearMessages
```
public void clearMessages()
```
    Clears all listening messages.
  - keyTyped
```
public void keyTyped(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyTyped in interface java.awt.event.KeyListener
  - keyPressed
```
public void keyPressed(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyPressed in interface java.awt.event.KeyListener
  - keyReleased
```
public void keyReleased(java.awt.event.KeyEvent e)
```
    Specified by:
    
    keyReleased in interface java.awt.event.KeyListener
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Intercepts mouse click events on target window. If the event is currently in the list of listened events, sent the message to peer MsgBlaster.
    
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
    
    Parameters:
    
    e - The event that was generated by the mouse click gesture.
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Intercepts mouse move events with a mouse button down on target window. If the event is currently in the list of listened events, sent the message to peer MsgBlaster.
    
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
    
    Parameters:
    
    e - The event that was generated by the mouse drag gesture.
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Intercepts mouse move events on target window. If the event is currently in the list of listened events, sent the message to peer MsgBlaster.
    
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
    
    Parameters:
    
    e - The event that was generated by the mouse move gesture.
  - windowOpened
```
public void windowOpened(java.awt.event.WindowEvent e)
```
    Specified by:
    
    windowOpened in interface java.awt.event.WindowListener
  - windowClosing
```
public void windowClosing(java.awt.event.WindowEvent e)
```
    Specified by:
    
    windowClosing in interface java.awt.event.WindowListener
  - windowClosed
```
public void windowClosed(java.awt.event.WindowEvent e)
```
    Specified by:
    
    windowClosed in interface java.awt.event.WindowListener
  - windowIconified
```
public void windowIconified(java.awt.event.WindowEvent e)
```
    Specified by:
    
    windowIconified in interface java.awt.event.WindowListener
  - windowDeiconified
```
public void windowDeiconified(java.awt.event.WindowEvent e)
```
    Specified by:
    
    windowDeiconified in interface java.awt.event.WindowListener
  - windowActivated
```
public void windowActivated(java.awt.event.WindowEvent e)
```
    Specified by:
    
    windowActivated in interface java.awt.event.WindowListener
  - windowDeactivated
```
public void windowDeactivated(java.awt.event.WindowEvent e)
```
    Specified by:
    
    windowDeactivated in interface java.awt.event.WindowListener
  - onWindowMoved
```
public void onWindowMoved(TopLevelWindow wnd)
```
    Called when the supplied window is moved.
    
    Specified by:
    
    onWindowMoved in interface WindowSizeMoveListener
    
    Parameters:
    
    wnd - The subjected window.
  - onWindowResized
```
public void onWindowResized(TopLevelWindow wnd)
```
    Called when the supplied window is resized.
    
    Specified by:
    
    onWindowResized in interface WindowSizeMoveListener
    
    Parameters:
    
    wnd - The subjected window.
  - processCoordinates
```
private int processCoordinates(java.awt.Point p)
```
    Combines the coordinate of a mouse event in a single integer. Each of the coordinate takes two bytes.
    
    Parameters:
    
    p - The point where the event took place.
    
    Returns:
    
    The integer obtained by combining the two coordinates if the mouse cursor is in client area, or -1 otherwise.
  - install
```
private void install()
```
    Installs the MsgBlaster instance with the target top level window and the target widget.
  - uninstall
```
private void uninstall()
```
    Uninstalls msg blaster from its top level window and the target widget.
  - installTargetWindow
```
private void installTargetWindow()
```
    Installs the MsgBlaster instance with the target top level window.
  - uninstallTargetWindow
```
private void uninstallTargetWindow()
```
    Uninstalls the MsgBlaster instance from the target top level window.
  - convertModifiers
```
private static int convertModifiers(int modifiersEx)
```
    Converts the modifiers from Java style to Win32 style.
    
    Parameters:
    
    modifiersEx - The event modiers as capture by Java.
    
    Returns:
    
    the modifiers from Java style to Win32 style.

Class MsgBlasterPeer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

WM_SIZE

WM_MOVE

WM_EXITSIZEMOVE

WM_ACTIVATE

WM_SYSCOMMAND

WM_MENUCHAR

WM_MOUSEMOVE

WM_LBUTTONDOWN

WM_LBUTTONUP

WM_RBUTTONDOWN

WM_RBUTTONUP

CUSTOM_WM_1

MK_LBUTTON

MK_RBUTTON

MK_SHIFT

MK_CONTROL

MK_MBUTTON

SC_KEYMENU

SC_CONTEXTHELP

WA_INACTIVE

WA_ACTIVE

WA_CLICKACTIVE

instances

hWndTarget

targetWinId

id

indexedMessages

indexedPass

messages

widgetStateListener

Constructor Detail

MsgBlasterPeer

Method Detail

getInstance

dropInstance

setTargetHwnd

getTargetHwnd

addMessage

clearMessages

keyTyped

keyPressed

keyReleased

mouseClicked

mousePressed

mouseReleased

mouseEntered

mouseExited

mouseDragged

mouseMoved

windowOpened

windowClosing

windowClosed

windowIconified

windowDeiconified

windowActivated

windowDeactivated

onWindowMoved

onWindowResized

processCoordinates

install

uninstall

installTargetWindow

uninstallTargetWindow

convertModifiers