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

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

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