Package com.nomagic.ui

Class ProgressWaitCursor

java.lang.Object

com.nomagic.ui.ProgressWaitCursor

@OpenApi
public class ProgressWaitCursor
extends Object

Mouse wait cursor handling helper for progress monitors.

Constructor Summary

Constructors

Constructor	Description
ProgressWaitCursor()	Creates a new progress wait cursor handling helper

Method Summary

Modifier and Type	Method	Description
static ProgressWaitCursor	createProgressWaitCursorIgnoringMouseAndKeyEvents()	Creates instance of ProgressWaitCursor which shows waiting mouse cursor and filters out all mouse and key events.
void	initializeWaitCursor()	Initializes mouse wait cursor for all application windows
void	removeWaitCursor()	Removes mouse wait cursor and restores the original cursors for all application windows
void	trackCursor(Component progressComponent, MouseEvent mouseEvent, boolean waitCursorExpected)	Tracks mouse cursor changes when mouse enters/leaves progress component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProgressWaitCursor

public ProgressWaitCursor()

Creates a new progress wait cursor handling helper

Method Details

createProgressWaitCursorIgnoringMouseAndKeyEvents

public static ProgressWaitCursor createProgressWaitCursorIgnoringMouseAndKeyEvents()

Creates instance of ProgressWaitCursor which shows waiting mouse cursor and filters out all mouse and key events. Therefore user will not be able to interact with any components while ProgressWaitCursor is not removed.

Returns:

instance of ProgressWaitCursor

initializeWaitCursor

public void initializeWaitCursor()

Initializes mouse wait cursor for all application windows

removeWaitCursor

public void removeWaitCursor()

Removes mouse wait cursor and restores the original cursors for all application windows

trackCursor

public void trackCursor(Component progressComponent,
 MouseEvent mouseEvent,
 boolean waitCursorExpected)

Tracks mouse cursor changes when mouse enters/leaves progress component. This method is typically invoked from EventQueueDispatcher.customDispatchMouseEvent() and ensures that cursor changes to default cursor when mouse is over progress component or to wait cursor when mouse is over rest of controls/windows.

Parameters:

progressComponent - the progress component over which mouse cursor changes to default cursor

mouseEvent - pending mouse event

waitCursorExpected - true indicates that mouse cursor should change to wait cursor, false indicates that mouse cursor should change to default cursor

See Also:

• EventQueueDispatcher.customDispatchMouseEvent(EventQueueDispatcher.Dispatcher, EventQueue, MouseEvent)