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

Last change on this file since 6915 was 6865, checked in by Don-vip, 10 years ago

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