source: josm/trunk/src/org/openstreetmap/josm/gui/layer/NoteLayer.java@ 12669

Last change on this file since 12669 was 12667, checked in by Don-vip, 7 years ago

see #14704 - allow to export validator errors ("Save as" in validator layer contextual menu). Same format than Osmose
  • Property svn:eol-style set to native
File size: 11.1 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.layer;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trn;
6
7import java.awt.Dimension;
8import java.awt.Graphics2D;
9import java.awt.Point;
10import java.awt.event.MouseEvent;
11import java.awt.event.MouseListener;
12import java.io.File;
13import java.text.DateFormat;
14import java.util.ArrayList;
15import java.util.Collection;
16import java.util.Collections;
17import java.util.List;
18
19import javax.swing.Action;
20import javax.swing.Icon;
21import javax.swing.ImageIcon;
22import javax.swing.JToolTip;
23import javax.swing.SwingUtilities;
24
25import org.openstreetmap.josm.Main;
26import org.openstreetmap.josm.actions.SaveActionBase;
27import org.openstreetmap.josm.data.Bounds;
28import org.openstreetmap.josm.data.notes.Note;
29import org.openstreetmap.josm.data.notes.Note.State;
30import org.openstreetmap.josm.data.notes.NoteComment;
31import org.openstreetmap.josm.data.osm.NoteData;
32import org.openstreetmap.josm.data.osm.NoteData.NoteDataUpdateListener;
33import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
34import org.openstreetmap.josm.gui.MainApplication;
35import org.openstreetmap.josm.gui.MapView;
36import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils;
37import org.openstreetmap.josm.gui.dialogs.LayerListDialog;
38import org.openstreetmap.josm.gui.dialogs.LayerListPopup;
39import org.openstreetmap.josm.gui.io.AbstractIOTask;
40import org.openstreetmap.josm.gui.io.UploadNoteLayerTask;
41import org.openstreetmap.josm.gui.progress.ProgressMonitor;
42import org.openstreetmap.josm.io.NoteExporter;
43import org.openstreetmap.josm.io.OsmApi;
44import org.openstreetmap.josm.io.XmlWriter;
45import org.openstreetmap.josm.tools.ColorHelper;
46import org.openstreetmap.josm.tools.ImageProvider;
47import org.openstreetmap.josm.tools.Logging;
48import org.openstreetmap.josm.tools.date.DateUtils;
49
50/**
51 * A layer to hold Note objects.
52 * @since 7522
53 */
54public class NoteLayer extends AbstractModifiableLayer implements MouseListener, NoteDataUpdateListener {
55
56 private final NoteData noteData;
57
58 /**
59 * Create a new note layer with a set of notes
60 * @param notes A list of notes to show in this layer
61 * @param name The name of the layer. Typically "Notes"
62 */
63 public NoteLayer(Collection<Note> notes, String name) {
64 super(name);
65 noteData = new NoteData(notes);
66 noteData.addNoteDataUpdateListener(this);
67 }
68
69 /** Convenience constructor that creates a layer with an empty note list */
70 public NoteLayer() {
71 this(Collections.<Note>emptySet(), tr("Notes"));
72 }
73
74 @Override
75 public void hookUpMapView() {
76 MainApplication.getMap().mapView.addMouseListener(this);
77 }
78
79 @Override
80 public synchronized void destroy() {
81 MainApplication.getMap().mapView.removeMouseListener(this);
82 noteData.removeNoteDataUpdateListener(this);
83 super.destroy();
84 }
85
86 /**
87 * Returns the note data store being used by this layer
88 * @return noteData containing layer notes
89 */
90 public NoteData getNoteData() {
91 return noteData;
92 }
93
94 @Override
95 public boolean isModified() {
96 return noteData.isModified();
97 }
98
99 @Override
100 public boolean isUploadable() {
101 return true;
102 }
103
104 @Override
105 public boolean requiresUploadToServer() {
106 return isModified();
107 }
108
109 @Override
110 public boolean isSavable() {
111 return true;
112 }
113
114 @Override
115 public boolean requiresSaveToFile() {
116 return getAssociatedFile() != null && isModified();
117 }
118
119 @Override
120 public void paint(Graphics2D g, MapView mv, Bounds box) {
121 final int iconHeight = ImageProvider.ImageSizes.SMALLICON.getAdjustedHeight();
122 final int iconWidth = ImageProvider.ImageSizes.SMALLICON.getAdjustedWidth();
123
124 for (Note note : noteData.getNotes()) {
125 Point p = mv.getPoint(note.getLatLon());
126
127 ImageIcon icon;
128 if (note.getId() < 0) {
129 icon = ImageProvider.get("dialogs/notes", "note_new", ImageProvider.ImageSizes.SMALLICON);
130 } else if (note.getState() == State.CLOSED) {
131 icon = ImageProvider.get("dialogs/notes", "note_closed", ImageProvider.ImageSizes.SMALLICON);
132 } else {
133 icon = ImageProvider.get("dialogs/notes", "note_open", ImageProvider.ImageSizes.SMALLICON);
134 }
135 int width = icon.getIconWidth();
136 int height = icon.getIconHeight();
137 g.drawImage(icon.getImage(), p.x - (width / 2), p.y - height, MainApplication.getMap().mapView);
138 }
139 if (noteData.getSelectedNote() != null) {
140 StringBuilder sb = new StringBuilder("<html>");
141 sb.append(tr("Note"))
142 .append(' ').append(noteData.getSelectedNote().getId());
143 for (NoteComment comment : noteData.getSelectedNote().getComments()) {
144 String commentText = comment.getText();
145 //closing a note creates an empty comment that we don't want to show
146 if (commentText != null && !commentText.trim().isEmpty()) {
147 sb.append("<hr/>");
148 String userName = XmlWriter.encode(comment.getUser().getName());
149 if (userName == null || userName.trim().isEmpty()) {
150 userName = "&lt;Anonymous&gt;";
151 }
152 sb.append(userName);
153 sb.append(" on ");
154 sb.append(DateUtils.getDateFormat(DateFormat.MEDIUM).format(comment.getCommentTimestamp()));
155 sb.append(":<br/>");
156 String htmlText = XmlWriter.encode(comment.getText(), true);
157 htmlText = htmlText.replace("&#xA;", "<br/>"); //encode method leaves us with entity instead of \n
158 htmlText = htmlText.replace("/", "/\u200b"); //zero width space to wrap long URLs (see #10864)
159 sb.append(htmlText);
160 }
161 }
162 sb.append("</html>");
163 JToolTip toolTip = new JToolTip();
164 toolTip.setTipText(sb.toString());
165 Point p = mv.getPoint(noteData.getSelectedNote().getLatLon());
166
167 g.setColor(ColorHelper.html2color(Main.pref.get("color.selected")));
168 g.drawRect(p.x - (iconWidth / 2), p.y - iconHeight,
169 iconWidth - 1, iconHeight - 1);
170
171 int tx = p.x + (iconWidth / 2) + 5;
172 int ty = p.y - iconHeight - 1;
173 g.translate(tx, ty);
174
175 //Carried over from the OSB plugin. Not entirely sure why it is needed
176 //but without it, the tooltip doesn't get sized correctly
177 for (int x = 0; x < 2; x++) {
178 Dimension d = toolTip.getUI().getPreferredSize(toolTip);
179 d.width = Math.min(d.width, mv.getWidth() / 2);
180 if (d.width > 0 && d.height > 0) {
181 toolTip.setSize(d);
182 try {
183 toolTip.paint(g);
184 } catch (IllegalArgumentException e) {
185 // See #11123 - https://bugs.openjdk.java.net/browse/JDK-6719550
186 // Ignore the exception, as Netbeans does: http://hg.netbeans.org/main-silver/rev/c96f4d5fbd20
187 Logging.log(Logging.LEVEL_ERROR, e);
188 }
189 }
190 }
191 g.translate(-tx, -ty);
192 }
193 }
194
195 @Override
196 public Icon getIcon() {
197 return ImageProvider.get("dialogs/notes", "note_open", ImageProvider.ImageSizes.SMALLICON);
198 }
199
200 @Override
201 public String getToolTipText() {
202 return trn("{0} note", "{0} notes", noteData.getNotes().size(), noteData.getNotes().size());
203 }
204
205 @Override
206 public void mergeFrom(Layer from) {
207 throw new UnsupportedOperationException("Notes layer does not support merging yet");
208 }
209
210 @Override
211 public boolean isMergable(Layer other) {
212 return false;
213 }
214
215 @Override
216 public void visitBoundingBox(BoundingXYVisitor v) {
217 for (Note note : noteData.getNotes()) {
218 v.visit(note.getLatLon());
219 }
220 }
221
222 @Override
223 public Object getInfoComponent() {
224 StringBuilder sb = new StringBuilder();
225 sb.append(tr("Notes layer"))
226 .append('\n')
227 .append(tr("Total notes:"))
228 .append(' ')
229 .append(noteData.getNotes().size())
230 .append('\n')
231 .append(tr("Changes need uploading?"))
232 .append(' ')
233 .append(isModified());
234 return sb.toString();
235 }
236
237 @Override
238 public Action[] getMenuEntries() {
239 List<Action> actions = new ArrayList<>();
240 actions.add(LayerListDialog.getInstance().createShowHideLayerAction());
241 actions.add(LayerListDialog.getInstance().createDeleteLayerAction());
242 actions.add(new LayerListPopup.InfoAction(this));
243 actions.add(new LayerSaveAction(this));
244 actions.add(new LayerSaveAsAction(this));
245 return actions.toArray(new Action[actions.size()]);
246 }
247
248 @Override
249 public void mouseClicked(MouseEvent e) {
250 if (SwingUtilities.isRightMouseButton(e) && noteData.getSelectedNote() != null) {
251 final String url = OsmApi.getOsmApi().getBaseUrl() + "notes/" + noteData.getSelectedNote().getId();
252 ClipboardUtils.copyString(url);
253 return;
254 } else if (!SwingUtilities.isLeftMouseButton(e)) {
255 return;
256 }
257 Point clickPoint = e.getPoint();
258 double snapDistance = 10;
259 double minDistance = Double.MAX_VALUE;
260 final int iconHeight = ImageProvider.ImageSizes.SMALLICON.getAdjustedHeight();
261 Note closestNote = null;
262 for (Note note : noteData.getNotes()) {
263 Point notePoint = MainApplication.getMap().mapView.getPoint(note.getLatLon());
264 //move the note point to the center of the icon where users are most likely to click when selecting
265 notePoint.setLocation(notePoint.getX(), notePoint.getY() - iconHeight / 2);
266 double dist = clickPoint.distanceSq(notePoint);
267 if (minDistance > dist && clickPoint.distance(notePoint) < snapDistance) {
268 minDistance = dist;
269 closestNote = note;
270 }
271 }
272 noteData.setSelectedNote(closestNote);
273 }
274
275 @Override
276 public File createAndOpenSaveFileChooser() {
277 return SaveActionBase.createAndOpenSaveFileChooser(tr("Save Note file"), NoteExporter.FILE_FILTER);
278 }
279
280 @Override
281 public AbstractIOTask createUploadTask(ProgressMonitor monitor) {
282 return new UploadNoteLayerTask(this, monitor);
283 }
284
285 @Override
286 public void mousePressed(MouseEvent e) {
287 // Do nothing
288 }
289
290 @Override
291 public void mouseReleased(MouseEvent e) {
292 // Do nothing
293 }
294
295 @Override
296 public void mouseEntered(MouseEvent e) {
297 // Do nothing
298 }
299
300 @Override
301 public void mouseExited(MouseEvent e) {
302 // Do nothing
303 }
304
305 @Override
306 public void noteDataUpdated(NoteData data) {
307 invalidate();
308 }
309
310 @Override
311 public void selectedNoteChanged(NoteData noteData) {
312 invalidate();
313 }
314}
Note: See TracBrowser for help on using the repository browser.