Changeset 4431

Timestamp:

2003-05-30T14:36:38+12:00 (21 years ago)

Author:

kjdon

Message:

added a comment

File:

• trunk/gli/src/org/greenstone/gatherer/gui/ModalDialog.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/gui/ModalDialog.java

@@ -34 +34 @@
 import java.awt.*;
 import javax.swing.*;
-/** An extension of the JDialog that overrides the JVM's typical modal behaviour. This typical behaviour is that when a modal dialog is opened, all other windows cease to respond to user events until the modal dialog is disposed. However this prevents us opening the help documents property whenever a modal dialog is open. Thus we override the modal behaviour so that only the owner frame or dialog is blocked. */
+/** An extension of the JDialog that overrides the JVM's typical modal behaviour. This typical behaviour is that when a modal dialog is opened, all other windows cease to respond to user events until the modal dialog is disposed. However this prevents us opening the help documents property whenever a modal dialog is open. Thus we override the modal behaviour so that only the owner frame or dialog is blocked. 
+ * Note that because we always call the super constructor with modal set to false, this should be made visible with setVisible(true) rather than show() which will return straight away. */
 public class ModalDialog
     extends JDialog {