source: josm/trunk/src/org/openstreetmap/josm/gui/preferences/advanced/PreferencesTable.java@ 6767

Last change on this file since 6767 was 6767, checked in by Don-vip, 10 years ago

javadoc for gui.preferences.advanced package
File size: 14.1 KB
Line 
1// License: GPL. See LICENSE file for details.
2package org.openstreetmap.josm.gui.preferences.advanced;
3
4import static org.openstreetmap.josm.tools.I18n.marktr;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.Color;
8import java.awt.Component;
9import java.awt.Font;
10import java.awt.GridBagLayout;
11import java.awt.event.MouseAdapter;
12import java.awt.event.MouseEvent;
13import java.util.ArrayList;
14import java.util.List;
15import java.util.Map;
16
17import javax.swing.ButtonGroup;
18import javax.swing.DefaultCellEditor;
19import javax.swing.JComponent;
20import javax.swing.JLabel;
21import javax.swing.JOptionPane;
22import javax.swing.JPanel;
23import javax.swing.JRadioButton;
24import javax.swing.JTable;
25import javax.swing.table.DefaultTableCellRenderer;
26import javax.swing.table.DefaultTableModel;
27
28import org.openstreetmap.josm.Main;
29import org.openstreetmap.josm.data.Preferences;
30import org.openstreetmap.josm.gui.ExtendedDialog;
31import org.openstreetmap.josm.gui.widgets.JosmTextField;
32import org.openstreetmap.josm.tools.GBC;
33import org.openstreetmap.josm.tools.Utils;
34
35/**
36 * Component for editing list of preferences as a table.
37 * @since 6021
38 */
39public class PreferencesTable extends JTable {
40 private AllSettingsTableModel model;
41 private final List<PrefEntry> displayData;
42
43 /**
44 * Constructs a new {@code PreferencesTable}.
45 * @param displayData The list of preferences entries to display
46 */
47 public PreferencesTable(List<PrefEntry> displayData) {
48 this.displayData = displayData;
49 model = new AllSettingsTableModel();
50 setModel(model);
51 putClientProperty("terminateEditOnFocusLost", true);
52 getColumnModel().getColumn(1).setCellRenderer(new SettingCellRenderer());
53 getColumnModel().getColumn(1).setCellEditor(new SettingCellEditor());
54
55 addMouseListener(new MouseAdapter() {
56 @Override public void mouseClicked(MouseEvent e) {
57 if (e.getClickCount() == 2) {
58 editPreference(PreferencesTable.this);
59 }
60 }
61 });
62 }
63
64 /**
65 * This method should be called when displayed data was changed form external code
66 */
67 public void fireDataChanged() {
68 model.fireTableDataChanged();
69 }
70
71 /**
72 * The list of currently selected rows
73 * @return newly created list of PrefEntry
74 */
75 public List<PrefEntry> getSelectedItems() {
76 List<PrefEntry> entries = new ArrayList<PrefEntry>();
77 for (int row : getSelectedRows()) {
78 PrefEntry p = (PrefEntry) model.getValueAt(row, -1);
79 entries.add(p);
80 }
81 return entries;
82 }
83
84 /**
85 * Call this to edit selected row in preferences table
86 * @param gui - parent component for messagebox
87 * @return true if editing was actually performed during this call
88 */
89 public boolean editPreference(final JComponent gui) {
90 if (getSelectedRowCount() != 1) {
91 JOptionPane.showMessageDialog(
92 gui,
93 tr("Please select the row to edit."),
94 tr("Warning"),
95 JOptionPane.WARNING_MESSAGE
96 );
97 return false;
98 }
99 final PrefEntry e = (PrefEntry) model.getValueAt(getSelectedRow(), 1);
100 Preferences.Setting stg = e.getValue();
101 if (stg instanceof Preferences.StringSetting) {
102 editCellAt(getSelectedRow(), 1);
103 Component editor = getEditorComponent();
104 if (editor != null) {
105 editor.requestFocus();
106 }
107 } else if (stg instanceof Preferences.ListSetting) {
108 Preferences.ListSetting lSetting = (Preferences.ListSetting) stg;
109 ListEditor lEditor = new ListEditor(gui, e, lSetting);
110 lEditor.showDialog();
111 if (lEditor.getValue() == 1) {
112 List<String> data = lEditor.getData();
113 if (!lSetting.equalVal(data)) {
114 e.setValue(new Preferences.ListSetting(data));
115 return true;
116 }
117 }
118 } else if (stg instanceof Preferences.ListListSetting) {
119 Preferences.ListListSetting llSetting = (Preferences.ListListSetting) stg;
120 ListListEditor llEditor = new ListListEditor(gui, e, llSetting);
121 llEditor.showDialog();
122 if (llEditor.getValue() == 1) {
123 List<List<String>> data = llEditor.getData();
124 if (!llSetting.equalVal(data)) {
125 e.setValue(new Preferences.ListListSetting(data));
126 return true;
127 }
128 }
129 } else if (stg instanceof Preferences.MapListSetting) {
130 Preferences.MapListSetting mlSetting = (Preferences.MapListSetting) stg;
131 MapListEditor mlEditor = new MapListEditor(gui, e, mlSetting);
132 mlEditor.showDialog();
133 if (mlEditor.getValue() == 1) {
134 List<Map<String, String>> data = mlEditor.getData();
135 if (!mlSetting.equalVal(data)) {
136 e.setValue(new Preferences.MapListSetting(data));
137 return true;
138 }
139 }
140 }
141 return false;
142 }
143
144 /**
145 * Add new preference to the table
146 * @param gui - parent component for asking dialogs
147 * @return newly created entry or null if adding was cancelled
148 */
149 public PrefEntry addPreference(final JComponent gui) {
150 JPanel p = new JPanel(new GridBagLayout());
151 p.add(new JLabel(tr("Key")), GBC.std().insets(0,0,5,0));
152 JosmTextField tkey = new JosmTextField("", 50);
153 p.add(tkey, GBC.eop().insets(5,0,0,0).fill(GBC.HORIZONTAL));
154
155 p.add(new JLabel(tr("Select Setting Type:")), GBC.eol().insets(5,15,5,0));
156
157 JRadioButton rbString = new JRadioButton(tr("Simple"));
158 JRadioButton rbList = new JRadioButton(tr("List"));
159 JRadioButton rbListList = new JRadioButton(tr("List of lists"));
160 JRadioButton rbMapList = new JRadioButton(tr("List of maps"));
161
162 ButtonGroup group = new ButtonGroup();
163 group.add(rbString);
164 group.add(rbList);
165 group.add(rbListList);
166 group.add(rbMapList);
167
168 p.add(rbString, GBC.eol());
169 p.add(rbList, GBC.eol());
170 p.add(rbListList, GBC.eol());
171 p.add(rbMapList, GBC.eol());
172
173 rbString.setSelected(true);
174
175 ExtendedDialog dlg = new ExtendedDialog(gui, tr("Add setting"), new String[] {tr("OK"), tr("Cancel")});
176 dlg.setButtonIcons(new String[] {"ok.png", "cancel.png"});
177 dlg.setContent(p);
178 dlg.showDialog();
179
180 PrefEntry pe = null;
181 boolean ok = false;
182 if (dlg.getValue() == 1) {
183 if (rbString.isSelected()) {
184 Preferences.StringSetting sSetting = new Preferences.StringSetting(null);
185 pe = new PrefEntry(tkey.getText(), sSetting, sSetting, false);
186 StringEditor sEditor = new StringEditor(gui, pe, sSetting);
187 sEditor.showDialog();
188 if (sEditor.getValue() == 1) {
189 String data = sEditor.getData();
190 if (!Utils.equal(sSetting.getValue(), data)) {
191 pe.setValue(new Preferences.StringSetting(data));
192 ok = true;
193 }
194 }
195 } else if (rbList.isSelected()) {
196 Preferences.ListSetting lSetting = new Preferences.ListSetting(null);
197 pe = new PrefEntry(tkey.getText(), lSetting, lSetting, false);
198 ListEditor lEditor = new ListEditor(gui, pe, lSetting);
199 lEditor.showDialog();
200 if (lEditor.getValue() == 1) {
201 List<String> data = lEditor.getData();
202 if (!lSetting.equalVal(data)) {
203 pe.setValue(new Preferences.ListSetting(data));
204 ok = true;
205 }
206 }
207 } else if (rbListList.isSelected()) {
208 Preferences.ListListSetting llSetting = new Preferences.ListListSetting(null);
209 pe = new PrefEntry(tkey.getText(), llSetting, llSetting, false);
210 ListListEditor llEditor = new ListListEditor(gui, pe, llSetting);
211 llEditor.showDialog();
212 if (llEditor.getValue() == 1) {
213 List<List<String>> data = llEditor.getData();
214 if (!llSetting.equalVal(data)) {
215 pe.setValue(new Preferences.ListListSetting(data));
216 ok = true;
217 }
218 }
219 } else if (rbMapList.isSelected()) {
220 Preferences.MapListSetting mlSetting = new Preferences.MapListSetting(null);
221 pe = new PrefEntry(tkey.getText(), mlSetting, mlSetting, false);
222 MapListEditor mlEditor = new MapListEditor(gui, pe, mlSetting);
223 mlEditor.showDialog();
224 if (mlEditor.getValue() == 1) {
225 List<Map<String, String>> data = mlEditor.getData();
226 if (!mlSetting.equalVal(data)) {
227 pe.setValue(new Preferences.MapListSetting(data));
228 ok = true;
229 }
230 }
231 }
232 }
233 if (ok)
234 return pe;
235 else
236 return null;
237 }
238
239 /**
240 * Reset selected preferences to their default values
241 * @param gui - parent component to display warning messages
242 */
243 public void resetPreferences(final JComponent gui) {
244 if (getSelectedRowCount() == 0) {
245 JOptionPane.showMessageDialog(
246 gui,
247 tr("Please select the row to delete."),
248 tr("Warning"),
249 JOptionPane.WARNING_MESSAGE
250 );
251 return;
252 }
253 for (int row : getSelectedRows()) {
254 PrefEntry e = displayData.get(row);
255 e.reset();
256 }
257 fireDataChanged();
258 }
259
260 private class AllSettingsTableModel extends DefaultTableModel {
261
262 public AllSettingsTableModel() {
263 setColumnIdentifiers(new String[]{tr("Key"), tr("Value")});
264 }
265
266 @Override
267 public boolean isCellEditable(int row, int column) {
268 return column == 1 && (displayData.get(row).getValue() instanceof Preferences.StringSetting);
269 }
270
271 @Override
272 public int getRowCount() {
273 return displayData.size();
274 }
275
276 @Override
277 public Object getValueAt(int row, int column) {
278 if (column == 0)
279 return displayData.get(row).getKey();
280 else
281 return displayData.get(row);
282 }
283
284 @Override
285 public void setValueAt(Object o, int row, int column) {
286 PrefEntry pe = displayData.get(row);
287 String s = (String) o;
288 if (!s.equals(pe.getValue().getValue())) {
289 pe.setValue(new Preferences.StringSetting(s));
290 fireTableCellUpdated(row, column);
291 }
292 }
293 }
294
295 private static class SettingCellRenderer extends DefaultTableCellRenderer {
296 private Color backgroundColor = Main.pref.getUIColor("Table.background");
297 private Color changedColor = Main.pref.getColor(
298 marktr("Advanced Background: Changed"),
299 new Color(200,255,200));
300 private Color foregroundColor = Main.pref.getUIColor("Table.foreground");
301 private Color nonDefaultColor = Main.pref.getColor(
302 marktr("Advanced Background: NonDefault"),
303 new Color(255,255,200));
304
305 @Override
306 public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
307 if (value == null)
308 return this;
309 PrefEntry pe = (PrefEntry) value;
310 Preferences.Setting setting = pe.getValue();
311 Object val = setting.getValue();
312 String display = val != null ? val.toString() : "<html><i>&lt;"+tr("unset")+"&gt;</i></html>";
313
314 JLabel label = (JLabel)super.getTableCellRendererComponent(table,
315 display, isSelected, hasFocus, row, column);
316
317 label.setBackground(backgroundColor);
318 if (isSelected) {
319 label.setForeground(foregroundColor);
320 }
321 if(pe.isChanged()) {
322 label.setBackground(changedColor);
323 } else if(!pe.isDefault()) {
324 label.setBackground(nonDefaultColor);
325 }
326
327 if (!pe.isDefault()) {
328 label.setFont(label.getFont().deriveFont(Font.BOLD));
329 }
330 val = pe.getDefaultValue().getValue();
331 if(val != null)
332 {
333 if(pe.isDefault()) {
334 label.setToolTipText(tr("Current value is default."));
335 } else {
336 label.setToolTipText(tr("Default value is ''{0}''.", val));
337 }
338 } else {
339 label.setToolTipText(tr("Default value currently unknown (setting has not been used yet)."));
340 }
341 return label;
342 }
343 }
344
345 private static class SettingCellEditor extends DefaultCellEditor {
346 public SettingCellEditor() {
347 super(new JosmTextField());
348 }
349
350 @Override
351 public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column) {
352 PrefEntry pe = (PrefEntry) value;
353 Preferences.StringSetting stg = (Preferences.StringSetting) pe.getValue();
354 String s = stg.getValue() == null ? "" : stg.getValue();
355 return super.getTableCellEditorComponent(table, s, isSelected, row, column);
356 }
357 }
358}
Note: See TracBrowser for help on using the repository browser.