skrueger/swing/TranslationAskJDialog.java

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 java.util.Locale;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.BorderFactory;
import javax.swing.Box;
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.geotools.styling.StylingUtil;
import schmitzm.lang.LangUtil;
import schmitzm.lang.ResourceProvider;
import schmitzm.swing.SwingUtil;
import skrueger.i8n.Translation;

public class TranslationAskJDialog extends JDialog {

        private String[] backup = new String[50]; // Maximum 50 languages ;-)
        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;

        /**
         * 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) {
                this(owner, new JComponent[] {});
        }

        /**
         * 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;

                // Remember backups for all the TranslationEditJPanel
                int count = 0;
                for (JComponent component : translationEditJPanelsOrJustComponents) {
                        if (component instanceof TranslationEditJPanel) {
                                TranslationEditJPanel tep = (TranslationEditJPanel) component;
                                Translation orig = tep.getTranslation();

                                // We don't want to overwrite the Translation object on
                                // restore(). We just want to change its value.
                                backup[count++] = orig.toOneLine();
                        }
                }

                init();
        }

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

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

                });
                SwingUtil.centerFrameOnScreen(this);
                Box box = Box.createVerticalBox();
                for (JComponent panel : translationEditJPanelsOrJustComponents) {
                        panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
                        panel.setBorder( BorderFactory.createEmptyBorder(5, 6, 5, 6));
                        box.add(panel);
                        
                }
                JPanel cp = new JPanel(new BorderLayout());
                cp.add(box, BorderLayout.WEST);
                cp.add(getButtons(), BorderLayout.SOUTH);
                setContentPane(cp);
                
                setTitle(SwingUtil.R("TranslationAskJDialog.Title")); 
                setModal(true);
                pack();
        }

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

        protected void cancel() {
                firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
                restore();
                setVisible(false);
                dispose();
        }

        protected void restore() {
                int count = 0;
                for (JComponent component : translationEditJPanelsOrJustComponents) {
                        if (component instanceof TranslationEditJPanel) {
                                TranslationEditJPanel tep = (TranslationEditJPanel) component;
                                tep.getTranslation().fromOneLine(backup[count++]);
                        }
                }
        }

        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.");

                                }

                                public void actionPerformed(ActionEvent evt) {
                                        TranslationAskJDialog.this.firePropertyChange(
                                                        PROPERTY_APPLY_AND_CLOSE, null, null);

                                        if (!checkValidInputs())
                                                return;

                                        setVisible(false);
                                        dispose();
                                }

                        });

                }
                jPanel.add(okButton);

                if (cancelButton == null) {
                        cancelButton = new CancelButton(new AbstractAction("") {
                                public void actionPerformed(ActionEvent evt) {
                                        restore();
                                        TranslationAskJDialog.this.firePropertyChange(
                                                        PROPERTY_CANCEL_AND_CLOSE, null, null);
                                        setVisible(false);
                                        setCancelled(true);
                                        dispose();
                                }
                        });
                }
                jPanel.add(cancelButton);

                return jPanel;
        }

        /**
         * @return <code>true</code> if none of the translations contains illegal
         *         characters.
         */
        protected boolean checkValidInputs() {

                for (JComponent component : translationEditJPanelsOrJustComponents) {
                        if (component instanceof TranslationEditJPanel) {
                                TranslationEditJPanel tep = (TranslationEditJPanel) component;

                                for (String l : tep.getTranslation().values()) {
                                        if (l.contains("{") || l.contains("}")) {
                                                JOptionPane
                                                                .showMessageDialog(
                                                                                this,
                                                                                SwingUtil.R("TranslationAskJDialog.ErrorMsg.InvalidCharacterInTranslation"));
                                                return false;
                                        }
                                }

                        }
                }

                return true;
        }

        private void setCancelled(boolean hasBeenCanceled) {
                this.hasBeenCanceled = hasBeenCanceled;
        }

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

}
1	package skrueger.swing;
2
3	import java.awt.BorderLayout;
4	import java.awt.Component;
5	import java.awt.FlowLayout;
6	import java.awt.Window;
7	import java.awt.event.ActionEvent;
8	import java.awt.event.ActionListener;
9	import java.awt.event.KeyEvent;
10	import java.awt.event.WindowAdapter;
11	import java.awt.event.WindowEvent;
12	import java.util.Locale;
13
14	import javax.swing.AbstractAction;
15	import javax.swing.Action;
16	import javax.swing.BorderFactory;
17	import javax.swing.Box;
18	import javax.swing.JButton;
19	import javax.swing.JComponent;
20	import javax.swing.JDialog;
21	import javax.swing.JOptionPane;
22	import javax.swing.JPanel;
23	import javax.swing.JRootPane;
24	import javax.swing.KeyStroke;
25
26	import schmitzm.geotools.styling.StylingUtil;
27	import schmitzm.lang.LangUtil;
28	import schmitzm.lang.ResourceProvider;
29	import schmitzm.swing.SwingUtil;
30	import skrueger.i8n.Translation;
31
32	public class TranslationAskJDialog extends JDialog {
33
34	private String[] backup = new String[50]; // Maximum 50 languages ;-)
35	private OkButton okButton;
36	private CancelButton cancelButton;
37
38	public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
39	public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";
40
41	private JComponent[] translationEditJPanelsOrJustComponents;
42
43	private boolean hasBeenCanceled;
44
45	private JButton[] optionalButtons;
46
47	/**
48	* Since the registerKeyboardAction() method is part of the JComponent class
49	* definition, you must define the Escape keystroke and register the
50	* keyboard action with a JComponent, not with a JDialog. The JRootPane for
51	* the JDialog serves as an excellent choice to associate the registration,
52	* as this will always be visible. If you override the protected
53	* createRootPane() method of JDialog, you can return your custom JRootPane
54	* with the keystroke enabled:
55	*/
56	@Override
57	protected JRootPane createRootPane() {
58	KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
59	JRootPane rootPane = new JRootPane();
60	rootPane.registerKeyboardAction(new ActionListener() {
61
62	public void actionPerformed(ActionEvent e) {
63	cancel();
64	}
65
66	}, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
67
68	return rootPane;
69	}
70
71	/**
72	* The {@link TranslationAskJDialog} fills its content pane with an
73	* arbitrary number of components. If these {@link Component}s are
74	* {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
75	* values and restore them if the dialog is canceled. Other
76	* {@link JComponent}s are just displayed.<br/>
77	* This class handles the cancel button itself. You may still want to listen
78	* to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
79	* to be set visible afterwards.<br/>
80	*
81	* @param owner
82	* A component of the GUI that this dialog is related to. If no
83	* {@link Window} is passed, SwingUtil.getParentWindow(owner) is
84	* called.
85	*/
86	public TranslationAskJDialog(Component owner,
87	final JComponent... translationEditJPanels) {
88	super(SwingUtil.getParentWindow(owner));
89	setComponents(translationEditJPanels);
90	}
91
92	/**
93	* The {@link TranslationAskJDialog} fills its content pane with an
94	* arbitrary number of components. If these {@link Component}s are
95	* {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
96	* values and restore them if the dialog is canceled. Other
97	* {@link JComponent}s are just displayed.<br/>
98	* This class handles the cancel button itself. You may still want to listen
99	* to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
100	* to be set visible afterwards.<br/>
101	* Using this constructor, you have to call setComponents afterwards.
102	*/
103	public TranslationAskJDialog(Component owner) {
104	this(owner, new JComponent[] {});
105	}
106
107	/**
108	* The {@link TranslationAskJDialog} fills its content pane with an
109	* arbitrary number of components. If these {@link Component}s are
110	* {@link TranslationEditJPanel}s, the {@link JDialog} manages to backup the
111	* values and restore them if the dialog is canceled. Other
112	* {@link JComponent}s are just displayed.
113	*
114	* @param translationEditJPanels
115	* Arbitrary list of {@link JComponent}s and
116	* {@link TranslationEditJPanel}s.
117	*/
118	public void setComponents(final JComponent... translationEditJPanels) {
119	this.translationEditJPanelsOrJustComponents = translationEditJPanels;
120
121	// Remember backups for all the TranslationEditJPanel
122	int count = 0;
123	for (JComponent component : translationEditJPanelsOrJustComponents) {
124	if (component instanceof TranslationEditJPanel) {
125	TranslationEditJPanel tep = (TranslationEditJPanel) component;
126	Translation orig = tep.getTranslation();
127
128	// We don't want to overwrite the Translation object on
129	// restore(). We just want to change its value.
130	backup[count++] = orig.toOneLine();
131	}
132	}
133
134	init();
135	}
136
137	private void init() {
138	setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
139	addWindowListener(new WindowAdapter() {
140
141	public void windowClosing(WindowEvent e) {
142	cancel();
143	}
144
145	});
146	SwingUtil.centerFrameOnScreen(this);
147	Box box = Box.createVerticalBox();
148	for (JComponent panel : translationEditJPanelsOrJustComponents) {
149	panel.setAlignmentX(java.awt.Component.LEFT_ALIGNMENT);
150	panel.setBorder( BorderFactory.createEmptyBorder(5, 6, 5, 6));
151	box.add(panel);
152
153	}
154	JPanel cp = new JPanel(new BorderLayout());
155	cp.add(box, BorderLayout.WEST);
156	cp.add(getButtons(), BorderLayout.SOUTH);
157	setContentPane(cp);
158
159	setTitle(SwingUtil.R("TranslationAskJDialog.Title"));
160	setModal(true);
161	pack();
162	}
163
164	public void setButtons(JButton... optionalButtons) {
165	this.optionalButtons = optionalButtons;
166	init();
167	}
168
169	protected void cancel() {
170	firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
171	restore();
172	setVisible(false);
173	dispose();
174	}
175
176	protected void restore() {
177	int count = 0;
178	for (JComponent component : translationEditJPanelsOrJustComponents) {
179	if (component instanceof TranslationEditJPanel) {
180	TranslationEditJPanel tep = (TranslationEditJPanel) component;
181	tep.getTranslation().fromOneLine(backup[count++]);
182	}
183	}
184	}
185
186	private JComponent getButtons() {
187	JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
188
189	if (optionalButtons != null)
190	for (JButton b : optionalButtons) {
191	jPanel.add(b);
192	}
193
194	if (okButton == null) {
195	okButton = new OkButton(new AbstractAction() {
196	{
197	// Set a mnemonic character. In most look and feels, this
198	// causes the
199	// specified character to be underlined This indicates that
200	// if the component
201	// using this action has the focus and In some look and
202	// feels, this causes
203	// the specified character in the label to be underlined and
204	putValue(Action.MNEMONIC_KEY, new Integer(
205	java.awt.event.KeyEvent.VK_E));
206
207	// Set tool tip text
208	putValue(Action.SHORT_DESCRIPTION,
209	"Accept the changes made to the translation.");
210
211	}
212
213	public void actionPerformed(ActionEvent evt) {
214	TranslationAskJDialog.this.firePropertyChange(
215	PROPERTY_APPLY_AND_CLOSE, null, null);
216
217	if (!checkValidInputs())
218	return;
219
220	setVisible(false);
221	dispose();
222	}
223
224	});
225
226	}
227	jPanel.add(okButton);
228
229	if (cancelButton == null) {
230	cancelButton = new CancelButton(new AbstractAction("") {
231	public void actionPerformed(ActionEvent evt) {
232	restore();
233	TranslationAskJDialog.this.firePropertyChange(
234	PROPERTY_CANCEL_AND_CLOSE, null, null);
235	setVisible(false);
236	setCancelled(true);
237	dispose();
238	}
239	});
240	}
241	jPanel.add(cancelButton);
242
243	return jPanel;
244	}
245
246	/**
247	* @return <code>true</code> if none of the translations contains illegal
248	* characters.
249	*/
250	protected boolean checkValidInputs() {
251
252	for (JComponent component : translationEditJPanelsOrJustComponents) {
253	if (component instanceof TranslationEditJPanel) {
254	TranslationEditJPanel tep = (TranslationEditJPanel) component;
255
256	for (String l : tep.getTranslation().values()) {
257	if (l.contains("{") \|\| l.contains("}")) {
258	JOptionPane
259	.showMessageDialog(
260	this,
261	SwingUtil.R("TranslationAskJDialog.ErrorMsg.InvalidCharacterInTranslation"));
262	return false;
263	}
264	}
265
266	}
267	}
268
269	return true;
270	}
271
272	private void setCancelled(boolean hasBeenCanceled) {
273	this.hasBeenCanceled = hasBeenCanceled;
274	}
275
276	/**
277	* After the modal dialog has been closed, this allows to find out, whether
278	* the dialog has been canceled.
279	*
280	* @return <code>true</code> if the {@link JDialog} has been canceled.
281	*/
282	public boolean isCancelled() {
283	return hasBeenCanceled;
284	}
285
286	}