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

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

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