skrueger/swing/CancellableDialogAdapter.java

package skrueger.swing;

import java.awt.Component;
import java.awt.Dialog;
import java.awt.event.ActionEvent;
import java.util.Locale;

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

import schmitzm.lang.LangUtil;
import schmitzm.lang.ResourceProvider;
import schmitzm.swing.SwingUtil;

/**
 * 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 {
        
        protected static ResourceProvider RESOURCE = new ResourceProvider(LangUtil
                        .extendPackagePath(SwingUtil.class,
                                        "resource.locales.SwingResourceBundle"), Locale.ENGLISH);


        /** Has this dialog been canceled ?**/
        protected boolean cancelled = false;

        private OkButton okButton;
        
        private CancelButton cancelButton;
        
        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, 
                                RESOURCE.getString("CancellableDialogAdapter.close.save.msg",getTitle()), RESOURCE.getString("CancellableDialogAdapter.close.save.title"), JOptionPane.YES_NO_CANCEL_OPTION);

                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,
                                RESOURCE.getString("CancellableDialogAdapter.forceClose.save.msg",getTitle()), RESOURCE.getString("CancellableDialogAdapter.close.save.title"), JOptionPane.YES_NO_OPTION); 
                
                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;
        }

        /**
         * @return a default OkButton that will call {@link #okClose()}
         */
        protected OkButton getOkButton() {
                if (okButton == null) {
                        okButton = new OkButton(new AbstractAction() {
                                
                                @Override
                                public void actionPerformed(ActionEvent e) {
                                        okClose();
                                }
                        });
                }
                return okButton;
        }
        

        /**
         * @return a default CancelButton that will call {@link #cancelClose()}
         */
        protected CancelButton getCancelButton() {
                if (cancelButton == null) {
                        cancelButton = new CancelButton(new AbstractAction() {
                                
                                @Override
                                public void actionPerformed(ActionEvent e) {
                                        cancelClose();
                                }
                        });
                }
                return cancelButton;
        }

}
1	package skrueger.swing;
2
3	import java.awt.Component;
4	import java.awt.Dialog;
5	import java.awt.event.ActionEvent;
6	import java.util.Locale;
7
8	import javax.swing.AbstractAction;
9	import javax.swing.JDialog;
10	import javax.swing.JOptionPane;
11
12	import schmitzm.lang.LangUtil;
13	import schmitzm.lang.ResourceProvider;
14	import schmitzm.swing.SwingUtil;
15
16	/**
17	* An abstract {@link JDialog} that implements a basic structure of how
18	* cancellable {@link JDialog}s work. The {@link JDialog} is designed to work on
19	* the real object and restore it's state when the user cancels the
20	* {@link JDialog}.
21	*
22	* Pressing ESC or clicking the "Close X" results in asking the user whether to Save/Cancel/Abort .
23	*/
24	public abstract class CancellableDialogAdapter extends AtlasDialog implements
25	CancellableDialog {
26
27	protected static ResourceProvider RESOURCE = new ResourceProvider(LangUtil
28	.extendPackagePath(SwingUtil.class,
29	"resource.locales.SwingResourceBundle"), Locale.ENGLISH);
30
31
32	/ Has this dialog been canceled ?/
33	protected boolean cancelled = false;
34
35	private OkButton okButton;
36
37	private CancelButton cancelButton;
38
39	public CancellableDialogAdapter(Component parentWindow) {
40	super(parentWindow);
41	}
42
43	public CancellableDialogAdapter(Component parentWindow, String title) {
44	super(parentWindow, title);
45	}
46
47	@Override
48	public boolean isCancelled() {
49	return cancelled;
50	}
51
52	/**
53	* Allows to close the {@link JDialog} from "outside". The user will be
54	* asked and she may cancel the close process.
55	*/
56	public boolean close() {
57	int showConfirmDialog = JOptionPane.showConfirmDialog(
58	CancellableDialogAdapter.this,
59	RESOURCE.getString("CancellableDialogAdapter.close.save.msg",getTitle()), RESOURCE.getString("CancellableDialogAdapter.close.save.title"), JOptionPane.YES_NO_CANCEL_OPTION);
60
61	if (showConfirmDialog == JOptionPane.YES_OPTION) {
62	return okClose();
63	}
64	else if (showConfirmDialog == JOptionPane.NO_OPTION) {
65	cancelClose();
66	return true;
67	}
68
69	return false;
70	}
71
72
73	/**
74	* This method can be called from "outside" to force a close of this
75	* {@link Dialog}. The user can't cancel the process. He may only decide to
76	* save possible changes.
77	*/
78	public void forceClose() {
79
80	int res = JOptionPane.showConfirmDialog(
81	CancellableDialogAdapter.this,
82	RESOURCE.getString("CancellableDialogAdapter.forceClose.save.msg",getTitle()), RESOURCE.getString("CancellableDialogAdapter.close.save.title"), JOptionPane.YES_NO_OPTION);
83
84	if (res == JOptionPane.YES_OPTION) {
85	okClose();
86	} else {
87	cancelClose();
88	}
89	}
90
91
92	/**
93	* Default implementation that calls {@link #cancel()} and
94	* {@link #dispose()}.
95	*/
96	@Override
97	public void cancelClose() {
98	cancel();
99	dispose();
100	}
101
102	@Override
103	public abstract void cancel();
104
105	/**
106	* This method is called when the dialog is closed and not canceled. Can be
107	* overwritten to do anything when the dialog has been accepted. For example
108	* checking for any {@link Checkable} components. <br/>
109	*
110	* @Return <code>false</code>, if the ok has been vetoed.
111	*/
112	public boolean okClose() {
113	dispose();
114	return true;
115	}
116
117	/**
118	* @return a default OkButton that will call {@link #okClose()}
119	*/
120	protected OkButton getOkButton() {
121	if (okButton == null) {
122	okButton = new OkButton(new AbstractAction() {
123
124	@Override
125	public void actionPerformed(ActionEvent e) {
126	okClose();
127	}
128	});
129	}
130	return okButton;
131	}
132
133
134	/**
135	* @return a default CancelButton that will call {@link #cancelClose()}
136	*/
137	protected CancelButton getCancelButton() {
138	if (cancelButton == null) {
139	cancelButton = new CancelButton(new AbstractAction() {
140
141	@Override
142	public void actionPerformed(ActionEvent e) {
143	cancelClose();
144	}
145	});
146	}
147	return cancelButton;
148	}
149
150	}
Name	Value
svn:eol-style	native
svn:keywords	Id URL
svn:mime-type	text/plain