source: josm/trunk/src/org/openstreetmap/josm/gui/history/VersionInfoPanel.java@ 8226

Last change on this file since 8226 was 8226, checked in by simon04, 9 years ago

fix #10600 - History dialog: include imagery_used tag value
  • Property svn:eol-style set to native
File size: 9.4 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.history;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.BorderLayout;
7import java.awt.GridBagConstraints;
8import java.awt.GridBagLayout;
9import java.awt.GridLayout;
10import java.io.UnsupportedEncodingException;
11import java.net.URLEncoder;
12import java.text.DateFormat;
13import java.util.Observable;
14import java.util.Observer;
15
16import javax.swing.JComponent;
17import javax.swing.JLabel;
18import javax.swing.JPanel;
19import javax.swing.JTextArea;
20
21import org.openstreetmap.josm.Main;
22import org.openstreetmap.josm.data.osm.Changeset;
23import org.openstreetmap.josm.data.osm.OsmPrimitive;
24import org.openstreetmap.josm.data.osm.User;
25import org.openstreetmap.josm.data.osm.history.HistoryOsmPrimitive;
26import org.openstreetmap.josm.gui.JosmUserIdentityManager;
27import org.openstreetmap.josm.gui.layer.OsmDataLayer;
28import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
29import org.openstreetmap.josm.gui.widgets.UrlLabel;
30import org.openstreetmap.josm.tools.CheckParameterUtil;
31import org.openstreetmap.josm.tools.GBC;
32import org.openstreetmap.josm.tools.Utils;
33import org.openstreetmap.josm.tools.date.DateUtils;
34
35/**
36 * VersionInfoPanel is an UI component which displays the basic properties of a version
37 * of a {@link OsmPrimitive}.
38 * @since 1709
39 */
40public class VersionInfoPanel extends JPanel implements Observer{
41 private PointInTimeType pointInTimeType;
42 private HistoryBrowserModel model;
43 private JMultilineLabel lblInfo;
44 private UrlLabel lblUser;
45 private UrlLabel lblChangeset;
46 private JPanel pnlChangesetSource;
47 private JPanel pnlChangesetImageryUsed;
48 private JLabel lblSource;
49 private JLabel lblImageryUsed;
50 private JTextArea lblChangesetComment;
51 private JTextArea lblChangesetSource;
52 private JTextArea lblChangesetImageryUsed;
53
54 protected static JTextArea buildTextArea(String tooltip) {
55 JTextArea lbl = new JTextArea();
56 lbl.setLineWrap(true);
57 lbl.setWrapStyleWord(true);
58 lbl.setEditable(false);
59 lbl.setOpaque(false);
60 lbl.setToolTipText(tooltip);
61 return lbl;
62 }
63
64 protected static JLabel buildLabel(String text, String tooltip, JTextArea textArea) {
65 // We need text field to be a JTextArea for line wrapping but cannot put HTML code in here,
66 // so create a separate JLabel with same characteristics (margin, font)
67 JLabel lbl = new JLabel("<html><p style='margin-top:"+textArea.getMargin().top+"'>"+text+"</html>");
68 lbl.setFont(textArea.getFont());
69 lbl.setToolTipText(tooltip);
70 return lbl;
71 }
72
73 protected static JPanel buildTextPanel(JLabel label, JTextArea textArea) {
74 JPanel pnl = new JPanel(new GridBagLayout());
75 pnl.add(label, GBC.std().anchor(GBC.NORTHWEST));
76 pnl.add(textArea, GBC.eol().insets(2, 0, 0, 0).fill());
77 return pnl;
78 }
79
80 protected void build() {
81 JPanel pnl1 = new JPanel(new BorderLayout());
82 lblInfo = new JMultilineLabel("");
83 pnl1.add(lblInfo, BorderLayout.CENTER);
84
85 JPanel pnlUserAndChangeset = new JPanel(new GridLayout(2,2));
86 lblUser = new UrlLabel("", 2);
87 pnlUserAndChangeset.add(new JLabel(tr("User:")));
88 pnlUserAndChangeset.add(lblUser);
89 pnlUserAndChangeset.add(new JLabel(tr("Changeset:")));
90 lblChangeset = new UrlLabel("", 2);
91 pnlUserAndChangeset.add(lblChangeset);
92
93 lblChangesetComment = buildTextArea(tr("Changeset comment"));
94 lblChangesetSource = buildTextArea(tr("Changeset source"));
95 lblChangesetImageryUsed = buildTextArea(tr("Imagery used"));
96
97 lblSource = buildLabel(tr("<b>Source</b>:"), tr("Changeset source"), lblChangesetSource);
98 lblImageryUsed = buildLabel(tr("<b>Imagery</b>:"), tr("Imagery used"), lblChangesetImageryUsed);
99 pnlChangesetSource = buildTextPanel(lblSource, lblChangesetSource);
100 pnlChangesetImageryUsed = buildTextPanel(lblImageryUsed, lblChangesetImageryUsed);
101
102 setLayout(new GridBagLayout());
103 GridBagConstraints gc = new GridBagConstraints();
104 gc.anchor = GridBagConstraints.NORTHWEST;
105 gc.fill = GridBagConstraints.HORIZONTAL;
106 gc.weightx = 1.0;
107 gc.weighty = 1.0;
108 add(pnl1, gc);
109 gc.gridy = 1;
110 gc.weighty = 0.0;
111 add(pnlUserAndChangeset, gc);
112 gc.gridy = 2;
113 add(lblChangesetComment, gc);
114 gc.gridy = 3;
115 add(pnlChangesetSource, gc);
116 gc.gridy = 4;
117 add(pnlChangesetImageryUsed, gc);
118 }
119
120 protected HistoryOsmPrimitive getPrimitive() {
121 if (model == null || pointInTimeType == null)
122 return null;
123 return model.getPointInTime(pointInTimeType);
124 }
125
126 protected String getInfoText() {
127 HistoryOsmPrimitive primitive = getPrimitive();
128 if (primitive == null)
129 return "";
130 String text;
131 if (model.isLatest(primitive)) {
132 OsmDataLayer editLayer = Main.main.getEditLayer();
133 text = tr("<html>Version <strong>{0}</strong> currently edited in layer ''{1}''</html>",
134 Long.toString(primitive.getVersion()),
135 editLayer == null ? tr("unknown") : editLayer.getName()
136 );
137 } else {
138 String date = "?";
139 if (primitive.getTimestamp() != null) {
140 date = DateUtils.formatDateTime(primitive.getTimestamp(), DateFormat.SHORT, DateFormat.SHORT);
141 }
142 text = tr(
143 "<html>Version <strong>{0}</strong> created on <strong>{1}</strong></html>",
144 Long.toString(primitive.getVersion()), date);
145 }
146 return text;
147 }
148
149 /**
150 * Constructs a new {@code VersionInfoPanel}.
151 */
152 public VersionInfoPanel() {
153 pointInTimeType = null;
154 model = null;
155 build();
156 }
157
158 /**
159 * constructor
160 *
161 * @param model the model (must not be null)
162 * @param pointInTimeType the point in time this panel visualizes (must not be null)
163 * @exception IllegalArgumentException thrown, if model is null
164 * @exception IllegalArgumentException thrown, if pointInTimeType is null
165 *
166 */
167 public VersionInfoPanel(HistoryBrowserModel model, PointInTimeType pointInTimeType) throws IllegalArgumentException {
168 CheckParameterUtil.ensureParameterNotNull(pointInTimeType, "pointInTimeType");
169 CheckParameterUtil.ensureParameterNotNull(model, "model");
170
171 this.model = model;
172 this.pointInTimeType = pointInTimeType;
173 model.addObserver(this);
174 build();
175 }
176
177 protected static String getUserUrl(String username) throws UnsupportedEncodingException {
178 return Main.getBaseUserUrl() + "/" + URLEncoder.encode(username, "UTF-8").replaceAll("\\+", "%20");
179 }
180
181 @Override
182 public void update(Observable o, Object arg) {
183 lblInfo.setText(getInfoText());
184
185 HistoryOsmPrimitive primitive = getPrimitive();
186 Changeset cs = primitive.getChangeset();
187
188 if (!model.isLatest(primitive)) {
189 User user = primitive.getUser();
190 String url = Main.getBaseBrowseUrl() + "/changeset/" + primitive.getChangesetId();
191 lblChangeset.setUrl(url);
192 lblChangeset.setDescription(Long.toString(primitive.getChangesetId()));
193
194 String username = "";
195 if (user != null) {
196 username = user.getName();
197 }
198 lblUser.setDescription(username);
199 try {
200 if (user != null && user != User.getAnonymous()) {
201 lblUser.setUrl(getUserUrl(username));
202 } else {
203 lblUser.setUrl(null);
204 }
205 } catch(UnsupportedEncodingException e) {
206 Main.error(e);
207 lblUser.setUrl(null);
208 }
209 } else {
210 String username = JosmUserIdentityManager.getInstance().getUserName();
211 if (username == null) {
212 lblUser.setDescription(tr("anonymous"));
213 lblUser.setUrl(null);
214 } else {
215 lblUser.setDescription(username);
216 try {
217 lblUser.setUrl(getUserUrl(username));
218 } catch(UnsupportedEncodingException e) {
219 Main.error(e);
220 lblUser.setUrl(null);
221 }
222 }
223 lblChangeset.setDescription(tr("none"));
224 lblChangeset.setUrl(null);
225 }
226
227 final Changeset oppCs = model.getPointInTime(pointInTimeType.opposite()).getChangeset();
228 updateText(cs, "comment", lblChangesetComment, null, oppCs, lblChangesetComment);
229 updateText(cs, "source", lblChangesetSource, lblSource, oppCs, pnlChangesetSource);
230 updateText(cs, "imagery_used", lblChangesetImageryUsed, lblImageryUsed, oppCs, pnlChangesetImageryUsed);
231 }
232
233 protected static void updateText(Changeset cs, String attr, JTextArea textArea, JLabel label, Changeset oppCs, JComponent container) {
234 final String text = cs != null ? cs.get(attr) : null;
235 // Update text, hide prefixing label if empty
236 if (label != null) {
237 label.setVisible(text != null && !Utils.strip(text).isEmpty());
238 }
239 textArea.setText(text);
240 // Hide container if values of both versions are empty
241 container.setVisible(text != null || (oppCs != null && oppCs.get(attr) != null));
242 }
243}
Note: See TracBrowser for help on using the repository browser.