skrueger/swing/TranslationAskJDialog.java

package skrueger.swing;

import java.awt.BorderLayout;
import java.awt.Dialog;
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.ArrayList;
import java.util.Locale;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.Box;
import javax.swing.JComponent;
import javax.swing.JDialog;
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 final JComponent[] translationEditJPanelsOrJustComponents;

        private boolean hasBeenCanceled;

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

        /**
         * 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.
         */
        public TranslationAskJDialog(Dialog owner,
                        final JComponent... translationEditJPanels) {
                super(owner);
                this.translationEditJPanelsOrJustComponents = translationEditJPanels;
                init();
        }

        /**
         * 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.
         */
        public TranslationAskJDialog(Window owner,
                        final JComponent... translationEditJPanels) {
                super(owner);
                this.translationEditJPanelsOrJustComponents = translationEditJPanels;
                init();

                // Rememebr backups for all the jtextpanels
                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();
                        }
                }
        }

        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) {
                        box.add(panel);
                }
                JPanel cp = new JPanel(new BorderLayout());
                cp.add(box, BorderLayout.CENTER);
                cp.add(getButtons(), BorderLayout.SOUTH);
                setContentPane(cp);

                // dialog.getRootPane().setDefaultButton(okButton);

                setTitle(RESOURCE.getString("translation_dialog_title")); // i8n
                setModal(true);
                pack();
        }

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

        private 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 (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);
                                        setVisible(false);
                                        dispose();
                                        System.out.println("OK button action performed");
                                }

                        });
                        // okButton.addKeyListener( new KeyListener() {
                        //
                        // public void keyTyped(KeyEvent e) {
                        // if ()
                        // okButton.action(new KEyPreEvent(), what)
                        // }
                        //                              
                        // });
                }
                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);
                                        setHasBeenCanceled(true);
                                        dispose();
                                }
                        });
                }
                jPanel.add(cancelButton);

                return jPanel;
        }

        public static void main(String[] args) {
                ArrayList<String> lang = new ArrayList<String>();
                lang.add("de");
                lang.add("en");
                lang.add("fr");

                Translation transe = new Translation();
                transe.put("de", "Terciopelo-Lanzenotter");
                TranslationEditJPanel p1 = new TranslationEditJPanel(
                                "Name von New Group", transe, lang);

                Translation transe2 = new Translation();
                transe2
                                .put(
                                                "de",
                                                "Terciopelo-Lanzenotter (Bothrops asper) ist eine in Mittelamerika und im Nordwesten Südamerikas weit verbreitete Schlangenart.");
                TranslationEditJPanel p2 = new TranslationEditJPanel(
                                "Description of Animal:", transe2, lang);

                // JFrame frame = new JFrame();
                // frame.setContentPane(p1);
                // frame.pack();
                // frame.setVisible(true);

                TranslationAskJDialog dialog = new TranslationAskJDialog(null, p1, p2);
                dialog.setVisible(true);
        }

        private void setHasBeenCanceled(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 isHasBeenCanceled() {
                return hasBeenCanceled;
        }

}
1	package skrueger.swing;
2
3	import java.awt.BorderLayout;
4	import java.awt.Dialog;
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.ArrayList;
13	import java.util.Locale;
14
15	import javax.swing.AbstractAction;
16	import javax.swing.Action;
17	import javax.swing.Box;
18	import javax.swing.JComponent;
19	import javax.swing.JDialog;
20	import javax.swing.JPanel;
21	import javax.swing.JRootPane;
22	import javax.swing.KeyStroke;
23
24	import schmitzm.lang.LangUtil;
25	import schmitzm.lang.ResourceProvider;
26	import schmitzm.swing.SwingUtil;
27	import skrueger.i8n.Translation;
28
29	public class TranslationAskJDialog extends JDialog {
30
31	/**
32	* {@link ResourceProvider}, der die Lokalisation fuer GUI-Komponenten des
33	* Package {@code skrueger.swing} zur Verfuegung stellt. Diese sind in
34	* properties-Datein unter {@code skrueger.swing.resource.locales}
35	* hinterlegt.
36	*/
37	public static ResourceProvider RESOURCE = new ResourceProvider(LangUtil
38	.extendPackagePath(TranslationAskJDialog.class,
39	"resource.locales.SwingResourceBundle"), Locale.ENGLISH);
40
41	private String[] backup = new String[50]; // Maximum 50 languages ;-)
42	private OkButton okButton;
43	private CancelButton cancelButton;
44
45	public static final String PROPERTY_CANCEL_AND_CLOSE = "CANCEL";
46	public static final String PROPERTY_APPLY_AND_CLOSE = "APPLY";
47
48	private final JComponent[] translationEditJPanelsOrJustComponents;
49
50	private boolean hasBeenCanceled;
51
52	/**
53	* Since the registerKeyboardAction() method is part of the JComponent class
54	* definition, you must define the Escape keystroke and register the
55	* keyboard action with a JComponent, not with a JDialog. The JRootPane for
56	* the JDialog serves as an excellent choice to associate the registration,
57	* as this will always be visible. If you override the protected
58	* createRootPane() method of JDialog, you can return your custom JRootPane
59	* with the keystroke enabled:
60	*/
61	@Override
62	protected JRootPane createRootPane() {
63	KeyStroke stroke = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);
64	JRootPane rootPane = new JRootPane();
65	rootPane.registerKeyboardAction(new ActionListener() {
66
67	public void actionPerformed(ActionEvent e) {
68	cancel();
69	}
70
71	}, stroke, JComponent.WHEN_IN_FOCUSED_WINDOW);
72
73	return rootPane;
74	}
75
76	/**
77	* This class handles the cancel button itself. You may still want to listen
78	* to PROPERTY_APPLY_AND_CLOSE events.
79	*
80	* This dialog is modal. The dialog has to be set visible afterwards.
81	*/
82	public TranslationAskJDialog(Dialog owner,
83	final JComponent... translationEditJPanels) {
84	super(owner);
85	this.translationEditJPanelsOrJustComponents = translationEditJPanels;
86	init();
87	}
88
89	/**
90	* This class handles the cancel button itself. You may still want to listen
91	* to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has
92	* to be set visible afterwards.
93	*/
94	public TranslationAskJDialog(Window owner,
95	final JComponent... translationEditJPanels) {
96	super(owner);
97	this.translationEditJPanelsOrJustComponents = translationEditJPanels;
98	init();
99
100	// Rememebr backups for all the jtextpanels
101	int count = 0;
102	for (JComponent component : translationEditJPanelsOrJustComponents) {
103	if (component instanceof TranslationEditJPanel) {
104	TranslationEditJPanel tep = (TranslationEditJPanel) component;
105	Translation orig = tep.getTranslation();
106
107	// We don't want to overwrite the Translation object on
108	// restore(). We just want to change its value.
109
110	backup[count++] = orig.toOneLine();
111	}
112	}
113	}
114
115	private void init() {
116	setDefaultCloseOperation(JDialog.DO_NOTHING_ON_CLOSE);
117	addWindowListener(new WindowAdapter() {
118
119	public void windowClosing(WindowEvent e) {
120	cancel();
121	}
122
123	});
124	SwingUtil.centerFrameOnScreen(this);
125	Box box = Box.createVerticalBox();
126	for (JComponent panel : translationEditJPanelsOrJustComponents) {
127	box.add(panel);
128	}
129	JPanel cp = new JPanel(new BorderLayout());
130	cp.add(box, BorderLayout.CENTER);
131	cp.add(getButtons(), BorderLayout.SOUTH);
132	setContentPane(cp);
133
134	// dialog.getRootPane().setDefaultButton(okButton);
135
136	setTitle(RESOURCE.getString("translation_dialog_title")); // i8n
137	setModal(true);
138	pack();
139	}
140
141	protected void cancel() {
142	firePropertyChange(PROPERTY_CANCEL_AND_CLOSE, null, null);
143	restore();
144	setVisible(false);
145	dispose();
146	}
147
148	private void restore() {
149	int count = 0;
150	for (JComponent component : translationEditJPanelsOrJustComponents) {
151	if (component instanceof TranslationEditJPanel) {
152	TranslationEditJPanel tep = (TranslationEditJPanel) component;
153	tep.getTranslation().fromOneLine(backup[count++]);
154	}
155	}
156	}
157
158	private JComponent getButtons() {
159	JPanel jPanel = new JPanel(new FlowLayout(FlowLayout.RIGHT));
160	if (okButton == null) {
161	okButton = new OkButton(new AbstractAction() {
162	{
163	// Set a mnemonic character. In most look and feels, this
164	// causes the
165	// specified character to be underlined This indicates that
166	// if the component
167	// using this action has the focus and In some look and
168	// feels, this causes
169	// the specified character in the label to be underlined and
170	putValue(Action.MNEMONIC_KEY, new Integer(
171	java.awt.event.KeyEvent.VK_E));
172
173	// Set tool tip text
174	putValue(Action.SHORT_DESCRIPTION,
175	"Accept the changes made to the translation.");
176
177	}
178
179	public void actionPerformed(ActionEvent evt) {
180	TranslationAskJDialog.this.firePropertyChange(
181	PROPERTY_APPLY_AND_CLOSE, null, null);
182	setVisible(false);
183	dispose();
184	System.out.println("OK button action performed");
185	}
186
187	});
188	// okButton.addKeyListener( new KeyListener() {
189	//
190	// public void keyTyped(KeyEvent e) {
191	// if ()
192	// okButton.action(new KEyPreEvent(), what)
193	// }
194	//
195	// });
196	}
197	jPanel.add(okButton);
198
199	if (cancelButton == null) {
200	cancelButton = new CancelButton(new AbstractAction("") {
201	public void actionPerformed(ActionEvent evt) {
202	// restore();
203	TranslationAskJDialog.this.firePropertyChange(
204	PROPERTY_CANCEL_AND_CLOSE, null, null);
205	setVisible(false);
206	setHasBeenCanceled(true);
207	dispose();
208	}
209	});
210	}
211	jPanel.add(cancelButton);
212
213	return jPanel;
214	}
215
216	public static void main(String[] args) {
217	ArrayList<String> lang = new ArrayList<String>();
218	lang.add("de");
219	lang.add("en");
220	lang.add("fr");
221
222	Translation transe = new Translation();
223	transe.put("de", "Terciopelo-Lanzenotter");
224	TranslationEditJPanel p1 = new TranslationEditJPanel(
225	"Name von New Group", transe, lang);
226
227	Translation transe2 = new Translation();
228	transe2
229	.put(
230	"de",
231	"Terciopelo-Lanzenotter (Bothrops asper) ist eine in Mittelamerika und im Nordwesten Südamerikas weit verbreitete Schlangenart.");
232	TranslationEditJPanel p2 = new TranslationEditJPanel(
233	"Description of Animal:", transe2, lang);
234
235	// JFrame frame = new JFrame();
236	// frame.setContentPane(p1);
237	// frame.pack();
238	// frame.setVisible(true);
239
240	TranslationAskJDialog dialog = new TranslationAskJDialog(null, p1, p2);
241	dialog.setVisible(true);
242	}
243
244	private void setHasBeenCanceled(boolean hasBeenCanceled) {
245	this.hasBeenCanceled = hasBeenCanceled;
246	}
247
248	/**
249	* After the modal dialog has been closed, this allows to find out, whether
250	* the dialog has been canceled.
251	*
252	* @return <code>true</code> if the {@link JDialog} has been canceled.
253	*/
254	public boolean isHasBeenCanceled() {
255	return hasBeenCanceled;
256	}
257
258	}