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.lang.LangUtil;
import schmitzm.lang.ResourceProvider;
import schmitzm.swing.SwingUtil;
import skrueger.i8n.Translation;

public class TranslationAskJDialog extends JDialog {

        /**
         * {@link ResourceProvider}, der die Lokalisation fuer GUI-Komponenten des
         * Package {@code skrueger.swing} zur Verfuegung stellt. Diese sind in
         * properties-Datein unter {@code skrueger.swing.resource.locales}
         * hinterlegt.
         */
        public static ResourceProvider RESOURCE = new ResourceProvider(LangUtil
                        .extendPackagePath(TranslationAskJDialog.class,
                                        "resource.locales.SwingResourceBundle"), Locale.ENGLISH);

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