skrueger/swing/CancellableDialogAdapter.java

package skrueger.swing;

import java.awt.Component;
import java.awt.Dialog;

import javax.swing.JDialog;
import javax.swing.JOptionPane;

/**
 * An abstract {@link JDialog} that implements a basic structure of how
 * cancellable {@link JDialog}s work. The {@link JDialog} is designed to work on
 * the real object and restore it's state when the user cancels the
 * {@link JDialog}.
 * 
 * Pressing ESC or clicking the "Close X" results in asking the user whether to Save/Cancel/Abort .  
 */
public abstract class CancellableDialogAdapter extends AtlasDialog implements
                CancellableDialog {

        /** Has this dialog been canceled ?**/
        protected boolean cancelled = false;
        
        public CancellableDialogAdapter(Component parentWindow) {
                super(parentWindow);
        }

        public CancellableDialogAdapter(Component parentWindow, String title) {
                super(parentWindow, title);
        }

        @Override
        public boolean isCancelled() {
                return cancelled;
        }

        /**
         * Allows to close the {@link JDialog} from "outside". The user will be
         * asked and she may cancel the close process.
         */
        public boolean close() {
                int showConfirmDialog = JOptionPane.showConfirmDialog(
                                CancellableDialogAdapter.this, "Speichern?",
                                "Änderungen speichern?", JOptionPane.YES_NO_CANCEL_OPTION); // i8n

                if (showConfirmDialog == JOptionPane.YES_OPTION) {
                        return okClose();
                }
                else if (showConfirmDialog == JOptionPane.NO_OPTION) {
                        cancelClose();
                        return true;
                }
                
                return false;
        }
        

        /**
         * This method can be called from "outside" to force a close of this
         * {@link Dialog}. The user can't cancel the process. He may only decide to
         * save possible changes.
         */
        public void forceClose() {

                int res = JOptionPane.showConfirmDialog(
                                CancellableDialogAdapter.this, "Speichern?",
                                "Der Dialog muss nu gesclossen werden. Änderungen speichern?", JOptionPane.YES_NO_OPTION); // i8n
                
                if (res == JOptionPane.YES_OPTION) {
                        okClose();
                } else {
                        cancelClose();
                }
        }
        

        /**
         * Default implementation that calls {@link #cancel()} and
         * {@link #dispose()}.
         */
        @Override
        public void cancelClose() {
                cancel();
                dispose();
        }

        @Override
        public abstract void cancel();

        /**
         * This method is called when the dialog is closed and not canceled. Can be
         * overwritten to do anything when the dialog has been accepted. For example
         * checking for any {@link Checkable} components. <br/>
         * 
         * @Return <code>false</code>, if the ok has been vetoed.
         */
        public boolean okClose() {
                dispose();
                return true;
        }
        

}
1	alfonx	420	package skrueger.swing;
2
3	alfonx	422	import java.awt.Component;
4			import java.awt.Dialog;
5	alfonx	420
6			import javax.swing.JDialog;
7			import javax.swing.JOptionPane;
8
9	alfonx	422	/**
10			* An abstract {@link JDialog} that implements a basic structure of how
11			* cancellable {@link JDialog}s work. The {@link JDialog} is designed to work on
12			* the real object and restore it's state when the user cancels the
13			* {@link JDialog}.
14	alfonx	433	*
15			* Pressing ESC or clicking the "Close X" results in asking the user whether to Save/Cancel/Abort .
16	alfonx	422	*/
17	alfonx	461	public abstract class CancellableDialogAdapter extends AtlasDialog implements
18	alfonx	420	CancellableDialog {
19
20	alfonx	461	/ Has this dialog been canceled ?/
21	alfonx	420	protected boolean cancelled = false;
22	alfonx	461
23			public CancellableDialogAdapter(Component parentWindow) {
24			super(parentWindow);
25			}
26	alfonx	420
27	alfonx	461	public CancellableDialogAdapter(Component parentWindow, String title) {
28			super(parentWindow, title);
29			}
30
31	alfonx	420	@Override
32			public boolean isCancelled() {
33			return cancelled;
34			}
35
36	alfonx	422	/**
37			* Allows to close the {@link JDialog} from "outside". The user will be
38			* asked and she may cancel the close process.
39			*/
40			public boolean close() {
41			int showConfirmDialog = JOptionPane.showConfirmDialog(
42			CancellableDialogAdapter.this, "Speichern?",
43			"Änderungen speichern?", JOptionPane.YES_NO_CANCEL_OPTION); // i8n
44
45			if (showConfirmDialog == JOptionPane.YES_OPTION) {
46			return okClose();
47			}
48			else if (showConfirmDialog == JOptionPane.NO_OPTION) {
49			cancelClose();
50			return true;
51			}
52
53			return false;
54	alfonx	420	}
55	alfonx	422
56	alfonx	420
57	alfonx	422	/**
58			* This method can be called from "outside" to force a close of this
59			* {@link Dialog}. The user can't cancel the process. He may only decide to
60			* save possible changes.
61			*/
62			public void forceClose() {
63
64			int res = JOptionPane.showConfirmDialog(
65			CancellableDialogAdapter.this, "Speichern?",
66			"Der Dialog muss nu gesclossen werden. Änderungen speichern?", JOptionPane.YES_NO_OPTION); // i8n
67
68			if (res == JOptionPane.YES_OPTION) {
69			okClose();
70			} else {
71			cancelClose();
72			}
73			}
74
75
76			/**
77			* Default implementation that calls {@link #cancel()} and
78			* {@link #dispose()}.
79			*/
80	alfonx	420	@Override
81			public void cancelClose() {
82			cancel();
83			dispose();
84			}
85
86			@Override
87			public abstract void cancel();
88
89			/**
90			* This method is called when the dialog is closed and not canceled. Can be
91			* overwritten to do anything when the dialog has been accepted. For example
92	alfonx	422	* checking for any {@link Checkable} components. <br/>
93			*
94			* @Return <code>false</code>, if the ok has been vetoed.
95	alfonx	420	*/
96	alfonx	422	public boolean okClose() {
97			dispose();
98			return true;
99			}
100	alfonx	433
101	alfonx	420
102	alfonx	433
103	alfonx	420	}
Name	Value
svn:eol-style	native
svn:keywords	Id URL
svn:mime-type	text/plain