source: josm/trunk/src/org/openstreetmap/josm/gui/dialogs/changeset/query/TimeRestrictionPanel.java

Last change on this file was 17843, checked in by simon04, 3 years ago

see #14176 - Migrate ChangesetQuery to Instant
  • Property svn:eol-style set to native
File size: 13.0 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.dialogs.changeset.query;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Color;
7import java.awt.GridBagConstraints;
8import java.awt.GridBagLayout;
9import java.awt.Insets;
10import java.awt.event.ItemEvent;
11import java.awt.event.ItemListener;
12import java.time.Instant;
13import java.time.LocalDate;
14import java.time.LocalTime;
15import java.time.ZoneId;
16
17import javax.swing.BorderFactory;
18import javax.swing.ButtonGroup;
19import javax.swing.JLabel;
20import javax.swing.JOptionPane;
21import javax.swing.JPanel;
22import javax.swing.JRadioButton;
23
24import org.openstreetmap.josm.gui.HelpAwareOptionPane;
25import org.openstreetmap.josm.gui.help.HelpUtil;
26import org.openstreetmap.josm.gui.widgets.JosmTextField;
27import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
28import org.openstreetmap.josm.io.ChangesetQuery;
29import org.openstreetmap.josm.spi.preferences.Config;
30import org.openstreetmap.josm.tools.GBC;
31
32/**
33 * This is the panel to apply a time restriction to the changeset query.
34 * @since 11326 (extracted from AdvancedChangesetQueryPanel)
35 */
36public class TimeRestrictionPanel extends JPanel implements RestrictionPanel {
37
38 private final JRadioButton rbClosedAfter = new JRadioButton(
39 tr("Only changesets closed after the following date/time"));
40 private final JRadioButton rbClosedAfterAndCreatedBefore = new JRadioButton(
41 tr("Only changesets closed after and created before a specific date/time"));
42 private final JosmTextField tfClosedAfterDate1 = new JosmTextField();
43 private transient DateValidator valClosedAfterDate1;
44 private final JosmTextField tfClosedAfterTime1 = new JosmTextField();
45 private transient TimeValidator valClosedAfterTime1;
46 private final JosmTextField tfClosedAfterDate2 = new JosmTextField();
47 private transient DateValidator valClosedAfterDate2;
48 private final JosmTextField tfClosedAfterTime2 = new JosmTextField();
49 private transient TimeValidator valClosedAfterTime2;
50 private final JosmTextField tfCreatedBeforeDate = new JosmTextField();
51 private transient DateValidator valCreatedBeforeDate;
52 private final JosmTextField tfCreatedBeforeTime = new JosmTextField();
53 private transient TimeValidator valCreatedBeforeTime;
54
55 /**
56 * Constructs a new {@code TimeRestrictionPanel}.
57 */
58 public TimeRestrictionPanel() {
59 build();
60 }
61
62 protected JPanel buildClosedAfterInputPanel() {
63 JPanel pnl = new JPanel(new GridBagLayout());
64 GridBagConstraints gc = new GridBagConstraints();
65 gc.fill = GridBagConstraints.HORIZONTAL;
66 gc.weightx = 0.0;
67 gc.insets = new Insets(0, 0, 0, 3);
68 pnl.add(new JLabel(tr("Date: ")), gc);
69
70 gc.gridx = 1;
71 gc.weightx = 0.7;
72 pnl.add(tfClosedAfterDate1, gc);
73 SelectAllOnFocusGainedDecorator.decorate(tfClosedAfterDate1);
74 valClosedAfterDate1 = DateValidator.decorate(tfClosedAfterDate1);
75 tfClosedAfterDate1.setToolTipText(valClosedAfterDate1.getStandardTooltipTextAsHtml());
76
77 gc.gridx = 2;
78 gc.weightx = 0.0;
79 pnl.add(new JLabel(tr("Time:")), gc);
80
81 gc.gridx = 3;
82 gc.weightx = 0.3;
83 pnl.add(tfClosedAfterTime1, gc);
84 SelectAllOnFocusGainedDecorator.decorate(tfClosedAfterTime1);
85 valClosedAfterTime1 = TimeValidator.decorate(tfClosedAfterTime1);
86 tfClosedAfterTime1.setToolTipText(valClosedAfterTime1.getStandardTooltipTextAsHtml());
87 return pnl;
88 }
89
90 protected JPanel buildClosedAfterAndCreatedBeforeInputPanel() {
91 JPanel pnl = new JPanel(new GridBagLayout());
92 GridBagConstraints gc = new GridBagConstraints();
93 gc.fill = GridBagConstraints.HORIZONTAL;
94 gc.weightx = 0.0;
95 gc.insets = new Insets(0, 0, 0, 3);
96 pnl.add(new JLabel(tr("Closed after - ")), gc);
97
98 gc.gridx = 1;
99 gc.fill = GridBagConstraints.HORIZONTAL;
100 gc.weightx = 0.0;
101 gc.insets = new Insets(0, 0, 0, 3);
102 pnl.add(new JLabel(tr("Date:")), gc);
103
104 gc.gridx = 2;
105 gc.weightx = 0.7;
106 pnl.add(tfClosedAfterDate2, gc);
107 SelectAllOnFocusGainedDecorator.decorate(tfClosedAfterDate2);
108 valClosedAfterDate2 = DateValidator.decorate(tfClosedAfterDate2);
109 tfClosedAfterDate2.setToolTipText(valClosedAfterDate2.getStandardTooltipTextAsHtml());
110 gc.gridx = 3;
111 gc.weightx = 0.0;
112 pnl.add(new JLabel(tr("Time:")), gc);
113
114 gc.gridx = 4;
115 gc.weightx = 0.3;
116 pnl.add(tfClosedAfterTime2, gc);
117 SelectAllOnFocusGainedDecorator.decorate(tfClosedAfterTime2);
118 valClosedAfterTime2 = TimeValidator.decorate(tfClosedAfterTime2);
119 tfClosedAfterTime2.setToolTipText(valClosedAfterTime2.getStandardTooltipTextAsHtml());
120
121 gc.gridy = 1;
122 gc.gridx = 0;
123 gc.fill = GridBagConstraints.HORIZONTAL;
124 gc.weightx = 0.0;
125 gc.insets = new Insets(0, 0, 0, 3);
126 pnl.add(new JLabel(tr("Created before - ")), gc);
127
128 gc.gridx = 1;
129 gc.fill = GridBagConstraints.HORIZONTAL;
130 gc.weightx = 0.0;
131 gc.insets = new Insets(0, 0, 0, 3);
132 pnl.add(new JLabel(tr("Date:")), gc);
133
134 gc.gridx = 2;
135 gc.weightx = 0.7;
136 pnl.add(tfCreatedBeforeDate, gc);
137 SelectAllOnFocusGainedDecorator.decorate(tfCreatedBeforeDate);
138 valCreatedBeforeDate = DateValidator.decorate(tfCreatedBeforeDate);
139 tfCreatedBeforeDate.setToolTipText(valCreatedBeforeDate.getStandardTooltipTextAsHtml());
140
141 gc.gridx = 3;
142 gc.weightx = 0.0;
143 pnl.add(new JLabel(tr("Time:")), gc);
144
145 gc.gridx = 4;
146 gc.weightx = 0.3;
147 pnl.add(tfCreatedBeforeTime, gc);
148 SelectAllOnFocusGainedDecorator.decorate(tfCreatedBeforeTime);
149 valCreatedBeforeTime = TimeValidator.decorate(tfCreatedBeforeTime);
150 tfCreatedBeforeTime.setToolTipText(valCreatedBeforeDate.getStandardTooltipTextAsHtml());
151
152 return pnl;
153 }
154
155 protected void build() {
156 setLayout(new GridBagLayout());
157 setBorder(BorderFactory.createCompoundBorder(
158 BorderFactory.createEmptyBorder(3, 3, 3, 3),
159 BorderFactory.createCompoundBorder(
160 BorderFactory.createLineBorder(Color.GRAY),
161 BorderFactory.createEmptyBorder(5, 5, 5, 5)
162 )
163 ));
164
165 // -- changesets closed after a specific date/time
166 //
167 GridBagConstraints gc = GBC.eol().fill(GridBagConstraints.HORIZONTAL);
168 add(rbClosedAfter, gc);
169 add(buildClosedAfterInputPanel(), gc);
170
171 // -- changesets closed after a specific date/time and created before a specific date time
172 //
173 add(rbClosedAfterAndCreatedBefore, gc);
174 add(buildClosedAfterAndCreatedBeforeInputPanel(), gc);
175
176 ButtonGroup bg = new ButtonGroup();
177 bg.add(rbClosedAfter);
178 bg.add(rbClosedAfterAndCreatedBefore);
179
180 ItemListener restrictionChangeHandler = new TimeRestrictionChangedHandler();
181 rbClosedAfter.addItemListener(restrictionChangeHandler);
182 rbClosedAfterAndCreatedBefore.addItemListener(restrictionChangeHandler);
183
184 rbClosedAfter.setSelected(true);
185 }
186
187 /**
188 * Determines if the changeset query time information is valid.
189 * @return {@code true} if the changeset query time information is valid.
190 */
191 @Override
192 public boolean isValidChangesetQuery() {
193 if (rbClosedAfter.isSelected())
194 return valClosedAfterDate1.isValid() && valClosedAfterTime1.isValid();
195 else if (rbClosedAfterAndCreatedBefore.isSelected())
196 return valClosedAfterDate2.isValid() && valClosedAfterTime2.isValid()
197 && valCreatedBeforeDate.isValid() && valCreatedBeforeTime.isValid();
198 // should not happen
199 return true;
200 }
201
202 class TimeRestrictionChangedHandler implements ItemListener {
203 @Override
204 public void itemStateChanged(ItemEvent e) {
205 tfClosedAfterDate1.setEnabled(rbClosedAfter.isSelected());
206 tfClosedAfterTime1.setEnabled(rbClosedAfter.isSelected());
207
208 tfClosedAfterDate2.setEnabled(rbClosedAfterAndCreatedBefore.isSelected());
209 tfClosedAfterTime2.setEnabled(rbClosedAfterAndCreatedBefore.isSelected());
210 tfCreatedBeforeDate.setEnabled(rbClosedAfterAndCreatedBefore.isSelected());
211 tfCreatedBeforeTime.setEnabled(rbClosedAfterAndCreatedBefore.isSelected());
212 }
213 }
214
215 /**
216 * Initializes HMI for user input.
217 */
218 public void startUserInput() {
219 restoreFromSettings();
220 }
221
222 /**
223 * Sets the query restrictions on <code>query</code> for time based restrictions.
224 * @param query the query to fill
225 */
226 @Override
227 public void fillInQuery(ChangesetQuery query) {
228 if (!isValidChangesetQuery())
229 throw new IllegalStateException(tr("Cannot build changeset query with time based restrictions. Input is not valid."));
230 if (rbClosedAfter.isSelected()) {
231 LocalDate d1 = valClosedAfterDate1.getDate();
232 LocalTime d2 = valClosedAfterTime1.getTime();
233 final Instant d3 = d1.atTime(d2).atZone(ZoneId.systemDefault()).toInstant();
234 query.closedAfter(d3);
235 } else if (rbClosedAfterAndCreatedBefore.isSelected()) {
236 LocalDate d1 = valClosedAfterDate2.getDate();
237 LocalTime d2 = valClosedAfterTime2.getTime();
238 Instant d3 = d1.atTime(d2).atZone(ZoneId.systemDefault()).toInstant();
239
240 d1 = valCreatedBeforeDate.getDate();
241 d2 = valCreatedBeforeTime.getTime();
242 Instant d4 = d1.atTime(d2).atZone(ZoneId.systemDefault()).toInstant();
243
244 query.closedAfterAndCreatedBefore(d3, d4);
245 }
246 }
247
248 @Override
249 public void displayMessageIfInvalid() {
250 if (isValidChangesetQuery())
251 return;
252 HelpAwareOptionPane.showOptionDialog(
253 this,
254 tr(
255 "<html>Please enter valid date/time values to restrict<br>"
256 + "the query to a specific time range.</html>"
257 ),
258 tr("Invalid date/time values"),
259 JOptionPane.ERROR_MESSAGE,
260 HelpUtil.ht("/Dialog/ChangesetQueryDialog#InvalidDateTimeValues")
261 );
262 }
263
264 /**
265 * Remember settings in preferences.
266 */
267 public void rememberSettings() {
268 String prefRoot = "changeset-query.advanced.time-restrictions";
269 if (rbClosedAfter.isSelected()) {
270 Config.getPref().put(prefRoot + ".query-type", "closed-after");
271 } else if (rbClosedAfterAndCreatedBefore.isSelected()) {
272 Config.getPref().put(prefRoot + ".query-type", "closed-after-created-before");
273 }
274 Config.getPref().put(prefRoot + ".closed-after.date", tfClosedAfterDate1.getText());
275 Config.getPref().put(prefRoot + ".closed-after.time", tfClosedAfterTime1.getText());
276 Config.getPref().put(prefRoot + ".closed-created.closed.date", tfClosedAfterDate2.getText());
277 Config.getPref().put(prefRoot + ".closed-created.closed.time", tfClosedAfterTime2.getText());
278 Config.getPref().put(prefRoot + ".closed-created.created.date", tfCreatedBeforeDate.getText());
279 Config.getPref().put(prefRoot + ".closed-created.created.time", tfCreatedBeforeTime.getText());
280 }
281
282 /**
283 * Restore settings from preferences.
284 */
285 public void restoreFromSettings() {
286 String prefRoot = "changeset-query.advanced.open-restrictions";
287 String v = Config.getPref().get(prefRoot + ".query-type", "closed-after");
288 rbClosedAfter.setSelected("closed-after".equals(v));
289 rbClosedAfterAndCreatedBefore.setSelected("closed-after-created-before".equals(v));
290 if (!rbClosedAfter.isSelected() && !rbClosedAfterAndCreatedBefore.isSelected()) {
291 rbClosedAfter.setSelected(true);
292 }
293 tfClosedAfterDate1.setText(Config.getPref().get(prefRoot + ".closed-after.date", ""));
294 tfClosedAfterTime1.setText(Config.getPref().get(prefRoot + ".closed-after.time", ""));
295 tfClosedAfterDate2.setText(Config.getPref().get(prefRoot + ".closed-created.closed.date", ""));
296 tfClosedAfterTime2.setText(Config.getPref().get(prefRoot + ".closed-created.closed.time", ""));
297 tfCreatedBeforeDate.setText(Config.getPref().get(prefRoot + ".closed-created.created.date", ""));
298 tfCreatedBeforeTime.setText(Config.getPref().get(prefRoot + ".closed-created.created.time", ""));
299 if (!valClosedAfterDate1.isValid()) {
300 tfClosedAfterDate1.setText("");
301 }
302 if (!valClosedAfterTime1.isValid()) {
303 tfClosedAfterTime1.setText("");
304 }
305 if (!valClosedAfterDate2.isValid()) {
306 tfClosedAfterDate2.setText("");
307 }
308 if (!valClosedAfterTime2.isValid()) {
309 tfClosedAfterTime2.setText("");
310 }
311 if (!valCreatedBeforeDate.isValid()) {
312 tfCreatedBeforeDate.setText("");
313 }
314 if (!valCreatedBeforeTime.isValid()) {
315 tfCreatedBeforeTime.setText("");
316 }
317 }
318}
Note: See TracBrowser for help on using the repository browser.