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

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

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