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

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

sonar - fb-contrib - minor performance improvements:

  • Method passes constant String of length 1 to character overridden method
  • Method needlessly boxes a boolean constant
  • Method uses iterator().next() on a List to get the first item
  • Method converts String to boxed primitive using excessive boxing
  • Method converts String to primitive using excessive boxing
  • Method creates array using constants
  • Class defines List based fields but uses them like Sets
  • Property svn:eol-style set to native
File size: 9.8 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.dialogs.LayerListDialog;
34import org.openstreetmap.josm.gui.dialogs.LayerListPopup;
35import org.openstreetmap.josm.gui.dialogs.NotesDialog;
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.Utils;
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 requiresUploadToServer() {
89 return isModified();
90 }
91
92 @Override
93 public boolean isSavable() {
94 return true;
95 }
96
97 @Override
98 public boolean requiresSaveToFile() {
99 return getAssociatedFile() != null && isModified();
100 }
101
102 @Override
103 public void paint(Graphics2D g, MapView mv, Bounds box) {
104 for (Note note : noteData.getNotes()) {
105 Point p = mv.getPoint(note.getLatLon());
106
107 ImageIcon icon = null;
108 if (note.getId() < 0) {
109 icon = NotesDialog.ICON_NEW_SMALL;
110 } else if (note.getState() == State.closed) {
111 icon = NotesDialog.ICON_CLOSED_SMALL;
112 } else {
113 icon = NotesDialog.ICON_OPEN_SMALL;
114 }
115 int width = icon.getIconWidth();
116 int height = icon.getIconHeight();
117 g.drawImage(icon.getImage(), p.x - (width / 2), p.y - height, Main.map.mapView);
118 }
119 if (noteData.getSelectedNote() != null) {
120 StringBuilder sb = new StringBuilder("<html>");
121 sb.append(tr("Note"))
122 .append(' ').append(noteData.getSelectedNote().getId());
123 for (NoteComment comment : noteData.getSelectedNote().getComments()) {
124 String commentText = comment.getText();
125 //closing a note creates an empty comment that we don't want to show
126 if (commentText != null && !commentText.trim().isEmpty()) {
127 sb.append("<hr/>");
128 String userName = XmlWriter.encode(comment.getUser().getName());
129 if (userName == null || userName.trim().isEmpty()) {
130 userName = "&lt;Anonymous&gt;";
131 }
132 sb.append(userName);
133 sb.append(" on ");
134 sb.append(DateUtils.getDateFormat(DateFormat.MEDIUM).format(comment.getCommentTimestamp()));
135 sb.append(":<br/>");
136 String htmlText = XmlWriter.encode(comment.getText(), true);
137 htmlText = htmlText.replace("&#xA;", "<br/>"); //encode method leaves us with entity instead of \n
138 htmlText = htmlText.replace("/", "/\u200b"); //zero width space to wrap long URLs (see #10864)
139 sb.append(htmlText);
140 }
141 }
142 sb.append("</html>");
143 JToolTip toolTip = new JToolTip();
144 toolTip.setTipText(sb.toString());
145 Point p = mv.getPoint(noteData.getSelectedNote().getLatLon());
146
147 g.setColor(ColorHelper.html2color(Main.pref.get("color.selected")));
148 g.drawRect(p.x - (NotesDialog.ICON_SMALL_SIZE / 2), p.y - NotesDialog.ICON_SMALL_SIZE,
149 NotesDialog.ICON_SMALL_SIZE - 1, NotesDialog.ICON_SMALL_SIZE - 1);
150
151 int tx = p.x + (NotesDialog.ICON_SMALL_SIZE / 2) + 5;
152 int ty = p.y - NotesDialog.ICON_SMALL_SIZE - 1;
153 g.translate(tx, ty);
154
155 //Carried over from the OSB plugin. Not entirely sure why it is needed
156 //but without it, the tooltip doesn't get sized correctly
157 for (int x = 0; x < 2; x++) {
158 Dimension d = toolTip.getUI().getPreferredSize(toolTip);
159 d.width = Math.min(d.width, mv.getWidth() / 2);
160 if (d.width > 0 && d.height > 0) {
161 toolTip.setSize(d);
162 try {
163 toolTip.paint(g);
164 } catch (IllegalArgumentException e) {
165 // See #11123 - https://bugs.openjdk.java.net/browse/JDK-6719550
166 // Ignore the exception, as Netbeans does: http://hg.netbeans.org/main-silver/rev/c96f4d5fbd20
167 Main.error(e, false);
168 }
169 }
170 }
171 g.translate(-tx, -ty);
172 }
173 }
174
175 @Override
176 public Icon getIcon() {
177 return NotesDialog.ICON_OPEN_SMALL;
178 }
179
180 @Override
181 public String getToolTipText() {
182 return noteData.getNotes().size() + ' ' + tr("Notes");
183 }
184
185 @Override
186 public void mergeFrom(Layer from) {
187 throw new UnsupportedOperationException("Notes layer does not support merging yet");
188 }
189
190 @Override
191 public boolean isMergable(Layer other) {
192 return false;
193 }
194
195 @Override
196 public void visitBoundingBox(BoundingXYVisitor v) {
197 for (Note note : noteData.getNotes()) {
198 v.visit(note.getLatLon());
199 }
200 }
201
202 @Override
203 public Object getInfoComponent() {
204 StringBuilder sb = new StringBuilder();
205 sb.append(tr("Notes layer"))
206 .append('\n')
207 .append(tr("Total notes:"))
208 .append(' ')
209 .append(noteData.getNotes().size())
210 .append('\n')
211 .append(tr("Changes need uploading?"))
212 .append(' ')
213 .append(isModified());
214 return sb.toString();
215 }
216
217 @Override
218 public Action[] getMenuEntries() {
219 List<Action> actions = new ArrayList<>();
220 actions.add(LayerListDialog.getInstance().createShowHideLayerAction());
221 actions.add(LayerListDialog.getInstance().createDeleteLayerAction());
222 actions.add(new LayerListPopup.InfoAction(this));
223 actions.add(new LayerSaveAction(this));
224 actions.add(new LayerSaveAsAction(this));
225 return actions.toArray(new Action[actions.size()]);
226 }
227
228 @Override
229 public void mouseClicked(MouseEvent e) {
230 if (SwingUtilities.isRightMouseButton(e) && noteData.getSelectedNote() != null) {
231 final String url = OsmApi.getOsmApi().getBaseUrl() + "notes/" + noteData.getSelectedNote().getId();
232 Utils.copyToClipboard(url);
233 return;
234 } else if (!SwingUtilities.isLeftMouseButton(e)) {
235 return;
236 }
237 Point clickPoint = e.getPoint();
238 double snapDistance = 10;
239 double minDistance = Double.MAX_VALUE;
240 Note closestNote = null;
241 for (Note note : noteData.getNotes()) {
242 Point notePoint = Main.map.mapView.getPoint(note.getLatLon());
243 //move the note point to the center of the icon where users are most likely to click when selecting
244 notePoint.setLocation(notePoint.getX(), notePoint.getY() - NotesDialog.ICON_SMALL_SIZE / 2);
245 double dist = clickPoint.distanceSq(notePoint);
246 if (minDistance > dist && clickPoint.distance(notePoint) < snapDistance) {
247 minDistance = dist;
248 closestNote = note;
249 }
250 }
251 noteData.setSelectedNote(closestNote);
252 }
253
254 @Override
255 public File createAndOpenSaveFileChooser() {
256 return SaveActionBase.createAndOpenSaveFileChooser(tr("Save GPX file"), NoteExporter.FILE_FILTER);
257 }
258
259 @Override
260 public AbstractIOTask createUploadTask(ProgressMonitor monitor) {
261 return new UploadNoteLayerTask(this, monitor);
262 }
263
264 @Override
265 public void mousePressed(MouseEvent e) {
266 // Do nothing
267 }
268
269 @Override
270 public void mouseReleased(MouseEvent e) {
271 // Do nothing
272 }
273
274 @Override
275 public void mouseEntered(MouseEvent e) {
276 // Do nothing
277 }
278
279 @Override
280 public void mouseExited(MouseEvent e) {
281 // Do nothing
282 }
283}
Note: See TracBrowser for help on using the repository browser.