modalDialog

Before a modal dialog can be opened, an instance of the modalDialog class has to be created. Once start() has been executed all newly opened windows will be observed and the specified callback handler is called when a modal dialog has been opened.

Method overview

modalDialog(in func_ptr callback);
boolean getDialog();
setHandler(in func_ptr callback);
start(in number delay, in nsIObserver observer);

Methods

modalDialog()

Constructor of the modalDialog class.

modalDialog(
  in func_ptr callback
); 
Parameters
callback
Callback function which will be called once a new modal dialog has been opened.

getDialog()

Internally used function to check if a new top-most positioned window is a modal dialog. You do not have to call this function.

boolean getDialog();
Parameters

None.

Return value

true if the topmost window is a modal dialog.

setHandler()

If the callback handler has to be updated a handler can be assigned with this function.

setHandler(
  in func_ptr callback
); 
Parameters
callback
Callback function which will be called once a new modal dialog has been opened.

start()

Starts observing the currently open windows. Once a new top-most positioned modal dialog is present the assigned callback handler is called.

start(
  in number delay,
  in nsIObserver observer
); 
Parameters
delay
A delay has to be only specified if there is a top-most positioned modal dialog already open. If it will take a while to open the expected modal dialog the already open dialog would be returned instead. This parameter is optional.
observer
Internally used to specify the observer which will be used to wait for the modal dialog.  This parameter is optional.

Document Tags and Contributors

Contributors to this page: Whimboo, Sheppy
Last updated by: Whimboo,