source: josm/trunk/src/org/openstreetmap/josm/gui/io/LayerNameAndFilePathTableCell.java@ 6087

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

see #8902 - string.equals("") => string.isEmpty() (patch by shinigami)
File size: 8.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.io;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Color;
7import java.awt.Component;
8import java.awt.Dimension;
9import java.awt.Font;
10import java.awt.GridBagLayout;
11import java.awt.event.ActionEvent;
12import java.awt.event.FocusAdapter;
13import java.awt.event.FocusEvent;
14import java.io.File;
15import java.util.EventObject;
16import java.util.concurrent.CopyOnWriteArrayList;
17
18import javax.swing.AbstractAction;
19import javax.swing.BorderFactory;
20import javax.swing.JButton;
21import javax.swing.JLabel;
22import javax.swing.JPanel;
23import javax.swing.JTable;
24import javax.swing.event.CellEditorListener;
25import javax.swing.event.ChangeEvent;
26import javax.swing.table.TableCellEditor;
27import javax.swing.table.TableCellRenderer;
28
29import org.openstreetmap.josm.actions.SaveActionBase;
30import org.openstreetmap.josm.tools.GBC;
31import org.openstreetmap.josm.gui.widgets.JosmTextField;
32
33class LayerNameAndFilePathTableCell extends JPanel implements TableCellRenderer, TableCellEditor {
34 private final static Color colorError = new Color(255,197,197);
35 private final static String separator = System.getProperty("file.separator");
36 private final static String ellipsis = "…" + separator;
37
38 private final JLabel lblLayerName = new JLabel();
39 private final JLabel lblFilename = new JLabel("");
40 private final JosmTextField tfFilename = new JosmTextField();
41 private final JButton btnFileChooser = new JButton(new LaunchFileChooserAction());
42
43 private final static GBC defaultCellStyle = GBC.eol().fill(GBC.HORIZONTAL).insets(2, 0, 2, 0);
44
45 private CopyOnWriteArrayList<CellEditorListener> listeners;
46 private File value;
47
48
49 /** constructor that sets the default on each element **/
50 public LayerNameAndFilePathTableCell() {
51 setLayout(new GridBagLayout());
52
53 lblLayerName.setPreferredSize(new Dimension(lblLayerName.getPreferredSize().width, 19));
54 lblLayerName.setFont(lblLayerName.getFont().deriveFont(Font.BOLD));
55
56 lblFilename.setPreferredSize(new Dimension(lblFilename.getPreferredSize().width, 19));
57 lblFilename.setOpaque(true);
58
59 tfFilename.setToolTipText(tr("Either edit the path manually in the text field or click the \"...\" button to open a file chooser."));
60 tfFilename.setPreferredSize(new Dimension(tfFilename.getPreferredSize().width, 19));
61 tfFilename.addFocusListener(
62 new FocusAdapter() {
63 @Override public void focusGained(FocusEvent e) {
64 tfFilename.selectAll();
65 }
66 }
67 );
68 // hide border
69 tfFilename.setBorder(BorderFactory.createLineBorder(getBackground()));
70
71 btnFileChooser.setPreferredSize(new Dimension(20, 19));
72 btnFileChooser.setOpaque(true);
73
74 listeners = new CopyOnWriteArrayList<CellEditorListener>();
75 }
76
77 /** renderer used while not editing the file path **/
78 @Override
79 public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected,
80 boolean hasFocus, int row, int column) {
81 removeAll();
82 SaveLayerInfo info = (SaveLayerInfo)value;
83 StringBuilder sb = new StringBuilder();
84 sb.append("<html>");
85 sb.append(addLblLayerName(info));
86 sb.append("<br>");
87 add(btnFileChooser, GBC.std());
88 sb.append(addLblFilename(info));
89
90 sb.append("</html>");
91 setToolTipText(sb.toString());
92 return this;
93 }
94
95 /** renderer used while the file path is being edited **/
96 @Override
97 public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected,
98 int row, int column) {
99 removeAll();
100 SaveLayerInfo info = (SaveLayerInfo)value;
101 value = info.getFile();
102 tfFilename.setText(value == null ? "" : value.toString());
103
104 StringBuilder sb = new StringBuilder();
105 sb.append("<html>");
106 sb.append(addLblLayerName(info));
107 sb.append("<br/>");
108
109 add(btnFileChooser, GBC.std());
110 add(tfFilename, GBC.eol().fill(GBC.HORIZONTAL).insets(1, 0, 0, 0));
111 tfFilename.selectAll();
112
113 sb.append(tfFilename.getToolTipText());
114 sb.append("</html>");
115 setToolTipText(sb.toString());
116 return this;
117 }
118
119 private static boolean canWrite(File f) {
120 if (f == null) return false;
121 if (f.isDirectory()) return false;
122 if (f.exists() && f.canWrite()) return true;
123 if (!f.exists() && f.getParentFile() != null && f.getParentFile().canWrite())
124 return true;
125 return false;
126 }
127
128 /** adds layer name label to (this) using the given info. Returns tooltip that
129 * should be added to the panel **/
130 private String addLblLayerName(SaveLayerInfo info) {
131 lblLayerName.setIcon(info.getLayer().getIcon());
132 lblLayerName.setText(info.getName());
133 add(lblLayerName, defaultCellStyle);
134 return tr("The bold text is the name of the layer.");
135 }
136
137 /** adds filename label to (this) using the given info. Returns tooltip that
138 * should be added to the panel */
139 private String addLblFilename(SaveLayerInfo info) {
140 String tooltip = "";
141 boolean error = false;
142 if (info.getFile() == null) {
143 error = info.isDoSaveToFile();
144 lblFilename.setText(tr("Click here to choose save path"));
145 lblFilename.setFont(lblFilename.getFont().deriveFont(Font.ITALIC));
146 tooltip = tr("Layer ''{0}'' is not backed by a file", info.getName());
147 } else {
148 String t = info.getFile().getPath();
149 lblFilename.setText(makePathFit(t));
150 tooltip = info.getFile().getAbsolutePath();
151 if (info.isDoSaveToFile() && !canWrite(info.getFile())) {
152 error = true;
153 tooltip = tr("File ''{0}'' is not writable. Please enter another file name.", info.getFile().getPath());
154 }
155 }
156
157 lblFilename.setBackground(error ? colorError : getBackground());
158 btnFileChooser.setBackground(error ? colorError : getBackground());
159
160 add(lblFilename, defaultCellStyle);
161 return tr("Click cell to change the file path.") + "<br/>" + tooltip;
162 }
163
164 /** makes the given path fit lblFilename, appends ellipsis on the left if it doesn’t fit.
165 * Idea: /home/user/josm → …/user/josm → …/josm; and take the first one that fits */
166 private String makePathFit(String t) {
167 boolean hasEllipsis = false;
168 while(t != null && !t.isEmpty()) {
169 int txtwidth = lblFilename.getFontMetrics(lblFilename.getFont()).stringWidth(t);
170 if(txtwidth < lblFilename.getWidth() || t.lastIndexOf(separator) < ellipsis.length()) {
171 break;
172 }
173 // remove ellipsis, if present
174 t = hasEllipsis ? t.substring(ellipsis.length()) : t;
175 // cut next block, and re-add ellipsis
176 t = ellipsis + t.substring(t.indexOf(separator) + 1);
177 hasEllipsis = true;
178 }
179 return t;
180 }
181
182 @Override
183 public void addCellEditorListener(CellEditorListener l) {
184 if (l != null) {
185 listeners.addIfAbsent(l);
186 }
187 }
188
189 protected void fireEditingCanceled() {
190 for (CellEditorListener l: listeners) {
191 l.editingCanceled(new ChangeEvent(this));
192 }
193 }
194
195 protected void fireEditingStopped() {
196 for (CellEditorListener l: listeners) {
197 l.editingStopped(new ChangeEvent(this));
198 }
199 }
200
201 @Override
202 public void cancelCellEditing() {
203 fireEditingCanceled();
204 }
205
206 @Override
207 public Object getCellEditorValue() {
208 return value;
209 }
210
211 @Override
212 public boolean isCellEditable(EventObject anEvent) {
213 return true;
214 }
215
216 @Override
217 public void removeCellEditorListener(CellEditorListener l) {
218 listeners.remove(l);
219 }
220
221 @Override
222 public boolean shouldSelectCell(EventObject anEvent) {
223 return true;
224 }
225
226 @Override
227 public boolean stopCellEditing() {
228 if (tfFilename.getText() == null || tfFilename.getText().trim().isEmpty()) {
229 value = null;
230 } else {
231 value = new File(tfFilename.getText());
232 }
233 fireEditingStopped();
234 return true;
235 }
236
237 private class LaunchFileChooserAction extends AbstractAction {
238 public LaunchFileChooserAction() {
239 putValue(NAME, "...");
240 putValue(SHORT_DESCRIPTION, tr("Launch a file chooser to select a file"));
241 }
242
243 @Override
244 public void actionPerformed(ActionEvent e) {
245 File f = SaveActionBase.createAndOpenSaveFileChooser(tr("Select filename"), "osm");
246 if (f != null) {
247 tfFilename.setText(f.toString());
248 stopCellEditing();
249 }
250 }
251 }
252}
Note: See TracBrowser for help on using the repository browser.