skrueger/swing/TranslationAskJDialog.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Krüger - additional utility classes
 ******************************************************************************/
package skrueger.swing;

import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.FlowLayout;
import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JRootPane;
import javax.swing.KeyStroke;

import schmitzm.swing.SwingUtil;

public class TranslationAskJDialog extends CancellableDialogAdapter{

        private OkButton okButton;
        private CancelButton cancelButton;

        public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
        public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";

        private JComponent[] translationEditJPanelsOrJustComponents;

        private boolean hasBeenCanceled;

        private JButton[] optionalButtons;
        private TranslationsAskJPanel translationsAskPane;

        /**
         * Since the registerKeyboardAction() method is part of the JComponent class
         * definition, you must define the Escape keystroke and register the
         * keyboard action with a JComponent, not with a JDialog. The JRootPane for
         * the JDialog serves as an excellent choice to associate the registration,
         * as this will always be visible. If you override the protected
         * createRootPane() method of JDialog, you can return your custom JRootPane
         * with the keystroke enabled:
         */
        @Override
        protected JRootPane createRootPane() {
                KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
                JRootPane rootPane = new JRootPane();
                rootPane.registerKeyboardAction(new ActionListener() {

                        public void actionPerformed(ActionEvent e) {
                                cancel();
                        }

                }, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);

                return rootPane;
        }

        /**
         * The {@link TranslationAskJDialog} fills its content pane with an
         * arbitrary number of components. If these {@link Component}s are
         * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
         * values and restore them if the dialog is canceled. Other
         * {@link JComponent}s are just displayed.<br/>
         * This class handles the cancel button itself. You may still want to listen
         * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
         * to be set visible afterwards.<br/>
         * 
         * @param owner
         *            A component of the GUI that this dialog is related to. If no
         *            {@link Window} is passed, SwingUtil.getParentWindow(owner) is
         *            called.
         */
        public TranslationAskJDialog(Component owner,
                        final JComponent... translationEditJPanels) {
                super(SwingUtil.getParentWindow(owner));
                setComponents(translationEditJPanels);
        }

        /**
         * The {@link TranslationAskJDialog} fills its content pane with an
         * arbitrary number of components. If these {@link Component}s are
         * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
         * values and restore them if the dialog is canceled. Other
         * {@link JComponent}s are just displayed.<br/>
         * This class handles the cancel button itself. You may still want to listen
         * to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
         * to be set visible afterwards.<br/>
         * Using this constructor, you have to call setComponents afterwards.
         */
        public TranslationAskJDialog(Component owner) {
                super(SwingUtil.getParentWindow(owner));
        }

        /**
         * The {@link TranslationAskJDialog} fills its content pane with an
         * arbitrary number of components. If these {@link Component}s are
         * {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
         * values and restore them if the dialog is canceled. Other
         * {@link JComponent}s are just displayed.
         * 
         * @param translationEditJPanels
         *            Arbitrary list of {@link JComponent}s and
         *            {@link TranslationEditJPanel}s.
         */
        public void setComponents(final JComponent... translationEditJPanels) {
                this.translationEditJPanelsOrJustComponents = translationEditJPanels;

                init();
        }


        private void init() {
                setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
                addWindowListener(new WindowAdapter() {

                        public void windowClosing(WindowEvent e) {
                                cancel();
                        }

                });
                
                translationsAskPane = new TranslationsAskJPanel(translationEditJPanelsOrJustComponents);
                JPanel cp = new JPanel(new BorderLayout());
                cp.add(translationsAskPane, BorderLayout.WEST);
                cp.add(getButtons(), BorderLayout.SOUTH);
                setContentPane(cp);

                setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
                setModal(true);
                pack();
                SwingUtil.centerFrameOnScreen(this);
        }

        public void setOptionalButtons(JButton... optionalButtons) {
                this.optionalButtons = optionalButtons;
                init();
        }

        /**
         * Called when the dilaog is closed using the cancel button. When
         * overwriting this method, call super.cancel() after restoring your
         * properties.
         */
        @Override
        public void cancel() {
                translationsAskPane.cancel();
                firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
                hasBeenCanceled = true;
                setVisible(false);
                dispose();
        }


        private JComponent getButtons() {
                JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));

                if (optionalButtons != null)
                        for (JButton b : optionalButtons) {
                                jPanel.add(b);
                        }

                if (okButton == null) {
                        okButton = new OkButton(new AbstractAction() {
                                {
                                        // Set a mnemonic character. In most look and feels, this
                                        // causes the
                                        // specified character to be underlined This indicates that
                                        // if the component
                                        // using this action has the focus and In some look and
                                        // feels, this causes
                                        // the specified character in the label to be underlined and
                                        putValue(Action.MNEMONIC_KEY, new Integer(
                                                        java.awt.event.KeyEvent.VK_E));

                                        // // Set tool tip text
                                        // putValue(Action.SHORT_DESCRIPTION,
                                        // "Accept the changes made to the translation."); //i8n

                                }

                                public void actionPerformed(ActionEvent evt) {

                                        okClose();

                                }

                        });

                }
                jPanel.add(okButton);

                if (cancelButton == null) {
                        cancelButton = new CancelButton(new AbstractAction("") {
                                public void actionPerformed(ActionEvent evt) {
                                        cancel();
                                }
                        });
                }
                jPanel.add(cancelButton);

                return jPanel;
        }

        /**
         * This method is only called when the dialog is closed and not canceled.
         * Can be overwritten to do anything when the dialog has been accepted.
         */
        public boolean okClose() {

                if (!translationsAskPane.checkValidInputs())
                        return false;
                
                
                dispose();
                
                TranslationAskJDialog.this.firePropertyChange(
                                PROPERTY_APPLY_AND_CLOSE, null, null);
                return true;
        }


        /**
         * After the modal dialog has been closed, this allows to find out, whether
         * the {@link Component} has been canceled.
         * 
         * @return <code>true</code> if the {@link JDialog} has been canceled.
         */
        public boolean isCancelled() {
                return hasBeenCanceled;
        }

}
1	/*******************************************************************************
2	* Copyright (c) 2009 Martin O. J. Schmitz.
3	*
4	* This file is part of the SCHMITZM library - a collection of utility
5	* classes based on Java 1.6, focusing (not only) on Java Swing
6	* and the Geotools library.
7	*
8	* The SCHMITZM project is hosted at:
9	* http://wald.intevation.org/projects/schmitzm/
10	*
11	* This program is free software; you can redistribute it and/or
12	* modify it under the terms of the GNU Lesser General Public License
13	* as published by the Free Software Foundation; either version 3
14	* of the License, or (at your option) any later version.
15	*
16	* This program is distributed in the hope that it will be useful,
17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19	* GNU General Public License for more details.
20	*
21	* You should have received a copy of the GNU Lesser General Public License (license.txt)
22	* along with this program; if not, write to the Free Software
23	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24	* or try this link: http://www.gnu.org/licenses/lgpl.html
25	*
26	* Contributors:
27	* Martin O. J. Schmitz - initial API and implementation
28	* Stefan A. Krüger - additional utility classes
29	******************************************************************************/
30	package skrueger.swing;
31
32	import java.awt.BorderLayout;
33	import java.awt.Component;
34	import java.awt.FlowLayout;
35	import java.awt.Window;
36	import java.awt.event.ActionEvent;
37	import java.awt.event.ActionListener;
38	import java.awt.event.KeyEvent;
39	import java.awt.event.WindowAdapter;
40	import java.awt.event.WindowEvent;
41
42	import javax.swing.AbstractAction;
43	import javax.swing.Action;
44	import javax.swing.JButton;
45	import javax.swing.JComponent;
46	import javax.swing.JDialog;
47	import javax.swing.JOptionPane;
48	import javax.swing.JPanel;
49	import javax.swing.JRootPane;
50	import javax.swing.KeyStroke;
51
52	import schmitzm.swing.SwingUtil;
53
54	public class TranslationAskJDialog extends CancellableDialogAdapter{
55
56	private OkButton okButton;
57	private CancelButton cancelButton;
58
59	public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
60	public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";
61
62	private JComponent[] translationEditJPanelsOrJustComponents;
63
64	private boolean hasBeenCanceled;
65
66	private JButton[] optionalButtons;
67	private TranslationsAskJPanel translationsAskPane;
68
69	/**
70	* Since the registerKeyboardAction() method is part of the JComponent class
71	* definition, you must define the Escape keystroke and register the
72	* keyboard action with a JComponent, not with a JDialog. The JRootPane for
73	* the JDialog serves as an excellent choice to associate the registration,
74	* as this will always be visible. If you override the protected
75	* createRootPane() method of JDialog, you can return your custom JRootPane
76	* with the keystroke enabled:
77	*/
78	@Override
79	protected JRootPane createRootPane() {
80	KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
81	JRootPane rootPane = new JRootPane();
82	rootPane.registerKeyboardAction(new ActionListener() {
83
84	public void actionPerformed(ActionEvent e) {
85	cancel();
86	}
87
88	}, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
89
90	return rootPane;
91	}
92
93	/**
94	* The {@link TranslationAskJDialog} fills its content pane with an
95	* arbitrary number of components. If these {@link Component}s are
96	* {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
97	* values and restore them if the dialog is canceled. Other
98	* {@link JComponent}s are just displayed.<br/>
99	* This class handles the cancel button itself. You may still want to listen
100	* to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
101	* to be set visible afterwards.<br/>
102	*
103	* @param owner
104	* A component of the GUI that this dialog is related to. If no
105	* {@link Window} is passed, SwingUtil.getParentWindow(owner) is
106	* called.
107	*/
108	public TranslationAskJDialog(Component owner,
109	final JComponent... translationEditJPanels) {
110	super(SwingUtil.getParentWindow(owner));
111	setComponents(translationEditJPanels);
112	}
113
114	/**
115	* The {@link TranslationAskJDialog} fills its content pane with an
116	* arbitrary number of components. If these {@link Component}s are
117	* {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
118	* values and restore them if the dialog is canceled. Other
119	* {@link JComponent}s are just displayed.<br/>
120	* This class handles the cancel button itself. You may still want to listen
121	* to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
122	* to be set visible afterwards.<br/>
123	* Using this constructor, you have to call setComponents afterwards.
124	*/
125	public TranslationAskJDialog(Component owner) {
126	super(SwingUtil.getParentWindow(owner));
127	}
128
129	/**
130	* The {@link TranslationAskJDialog} fills its content pane with an
131	* arbitrary number of components. If these {@link Component}s are
132	* {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
133	* values and restore them if the dialog is canceled. Other
134	* {@link JComponent}s are just displayed.
135	*
136	* @param translationEditJPanels
137	* Arbitrary list of {@link JComponent}s and
138	* {@link TranslationEditJPanel}s.
139	*/
140	public void setComponents(final JComponent... translationEditJPanels) {
141	this.translationEditJPanelsOrJustComponents = translationEditJPanels;
142
143	init();
144	}
145
146
147	private void init() {
148	setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
149	addWindowListener(new WindowAdapter() {
150
151	public void windowClosing(WindowEvent e) {
152	cancel();
153	}
154
155	});
156
157	translationsAskPane = new TranslationsAskJPanel(translationEditJPanelsOrJustComponents);
158	JPanel cp = new JPanel(new BorderLayout());
159	cp.add(translationsAskPane, BorderLayout.WEST);
160	cp.add(getButtons(), BorderLayout.SOUTH);
161	setContentPane(cp);
162
163	setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
164	setModal(true);
165	pack();
166	SwingUtil.centerFrameOnScreen(this);
167	}
168
169	public void setOptionalButtons(JButton... optionalButtons) {
170	this.optionalButtons = optionalButtons;
171	init();
172	}
173
174	/**
175	* Called when the dilaog is closed using the cancel button. When
176	* overwriting this method, call super.cancel() after restoring your
177	* properties.
178	*/
179	@Override
180	public void cancel() {
181	translationsAskPane.cancel();
182	firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
183	hasBeenCanceled = true;
184	setVisible(false);
185	dispose();
186	}
187
188
189	private JComponent getButtons() {
190	JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
191
192	if (optionalButtons != null)
193	for (JButton b : optionalButtons) {
194	jPanel.add(b);
195	}
196
197	if (okButton == null) {
198	okButton = new OkButton(new AbstractAction() {
199	{
200	// Set a mnemonic character. In most look and feels, this
201	// causes the
202	// specified character to be underlined This indicates that
203	// if the component
204	// using this action has the focus and In some look and
205	// feels, this causes
206	// the specified character in the label to be underlined and
207	putValue(Action.MNEMONIC_KEY, new Integer(
208	java.awt.event.KeyEvent.VK_E));
209
210	// // Set tool tip text
211	// putValue(Action.SHORT_DESCRIPTION,
212	// "Accept the changes made to the translation."); //i8n
213
214	}
215
216	public void actionPerformed(ActionEvent evt) {
217
218	okClose();
219
220	}
221
222	});
223
224	}
225	jPanel.add(okButton);
226
227	if (cancelButton == null) {
228	cancelButton = new CancelButton(new AbstractAction("") {
229	public void actionPerformed(ActionEvent evt) {
230	cancel();
231	}
232	});
233	}
234	jPanel.add(cancelButton);
235
236	return jPanel;
237	}
238
239	/**
240	* This method is only called when the dialog is closed and not canceled.
241	* Can be overwritten to do anything when the dialog has been accepted.
242	*/
243	public boolean okClose() {
244
245	if (!translationsAskPane.checkValidInputs())
246	return false;
247
248
249	dispose();
250
251	TranslationAskJDialog.this.firePropertyChange(
252	PROPERTY_APPLY_AND_CLOSE, null, null);
253	return true;
254	}
255
256
257
258	/**
259	* After the modal dialog has been closed, this allows to find out, whether
260	* the {@link Component} has been canceled.
261	*
262	* @return <code>true</code> if the {@link JDialog} has been canceled.
263	*/
264	public boolean isCancelled() {
265	return hasBeenCanceled;
266	}
267
268	}