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

Last change on this file since 9136 was 9078, checked in by Don-vip, 8 years ago

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