javax.ide.view

Interface WaitCursor

public interface WaitCursor

WaitCursor interface. A wait cursor should be used by extension writers when an extension executes a time consuming task. To show the wait cursor call show. Once the time consuming task concludes, call hide to remove the wait cursor. These calls must happen on the event thread. To show a wait cursor:

 import javax.ide.view.WaitCursor;

 // ...

 void doSomethingTimeConsuming()
 {
   WaitCursor wc = Ide.getGUIUtilities().getWaitCursor();
   try
   {
      wc.show();

      //...
   } 
   finally
   {
      wc.hide();
   }
 }
 

Method Summary

Methods

Modifier and Type	Method and Description
void	hide() Hide the wait cursor.
void	show(int delay) Schedules the wait cursor to be shown after the specified number of milliseconds has elapsed.

Method Detail

show

void show(int delay)

Schedules the wait cursor to be shown after the specified number of milliseconds has elapsed. If hide() is called before the delay has elapsed, then the wait cursor is not shown.

Nested call to this method are acceptable. There must be a call to the hide method for every call to show. This method must be called from the event thread.

Parameters:

delay - the number of milliseconds to dealy before showing the wait cursor.

hide

void hide()

Hide the wait cursor.

Nested call to this method are acceptable. There must be a call to the hide method for every call to show. This method must be called from the event thread.