001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.widgets; 003 004import java.awt.Component; 005import java.awt.Dimension; 006import java.awt.GridBagLayout; 007import java.text.DateFormat; 008import java.text.SimpleDateFormat; 009import java.time.Instant; 010import java.util.ArrayList; 011import java.util.Date; 012import java.util.List; 013 014import javax.swing.JLabel; 015import javax.swing.JPanel; 016import javax.swing.JSlider; 017import javax.swing.JSpinner; 018import javax.swing.SpinnerDateModel; 019import javax.swing.event.ChangeListener; 020 021import org.openstreetmap.josm.tools.GBC; 022import org.openstreetmap.josm.tools.date.DateUtils; 023 024/** 025 * Widget originally created for date filtering of GPX tracks. 026 * Allows to enter the date or choose it by using slider 027 * @since 5815 028 */ 029@SuppressWarnings("PMD.ReplaceJavaUtilDate") // JSpinner needs Date anyway, so not using Date makes no sense 030public class DateEditorWithSlider extends JPanel { 031 private final JSpinner spinner; 032 private final JSlider slider; 033 private Instant dateMin; 034 private Instant dateMax; 035 private static final int MAX_SLIDER = 300; 036 private boolean watchSlider = true; 037 038 private final transient List<ChangeListener> listeners = new ArrayList<>(); 039 040 /** 041 * Constructs a new {@code DateEditorWithSlider} with a given label 042 * @param labelText The label to display 043 */ 044 public DateEditorWithSlider(String labelText) { 045 super(new GridBagLayout()); 046 spinner = new JSpinner(new SpinnerDateModel()); 047 String pattern = ((SimpleDateFormat) DateUtils.getDateFormat(DateFormat.DEFAULT)).toPattern(); 048 JSpinner.DateEditor timeEditor = new JSpinner.DateEditor(spinner, pattern); 049 spinner.setEditor(timeEditor); 050 051 spinner.setPreferredSize(new Dimension(spinner.getPreferredSize().width+5, 052 spinner.getPreferredSize().height)); 053 054 slider = new JSlider(0, MAX_SLIDER); 055 spinner.addChangeListener(e -> { 056 int i = slider.getValue(); 057 Date d = (Date) spinner.getValue(); 058 int j = intFromDate(d); 059 if (i != j) { 060 watchSlider = false; 061 slider.setValue(j); 062 watchSlider = true; 063 } 064 for (ChangeListener l : listeners) { 065 l.stateChanged(e); 066 } 067 }); 068 slider.addChangeListener(e -> { 069 if (!watchSlider) return; 070 Date d = (Date) spinner.getValue(); 071 Date d1 = dateFromInt(slider.getValue()); 072 if (!d.equals(d1)) { 073 spinner.setValue(d1); 074 } 075 }); 076 add(new JLabel(labelText), GBC.std()); 077 add(spinner, GBC.std().insets(10, 0, 0, 0)); 078 add(slider, GBC.eol().insets(10, 0, 0, 0).fill(GBC.HORIZONTAL)); 079 080 dateMin = Instant.EPOCH; 081 dateMax = Instant.now(); 082 } 083 084 protected Date dateFromInt(int value) { 085 double k = 1.0*value/MAX_SLIDER; 086 return new Date((long) (dateMax.toEpochMilli()*k+ dateMin.toEpochMilli()*(1-k))); 087 } 088 089 protected int intFromDate(Date date) { 090 return (int) (300.0*(date.getTime()-dateMin.getEpochSecond()) / 091 (dateMax.getEpochSecond()-dateMin.getEpochSecond())); 092 } 093 094 /** 095 * Sets the date range that is available using the slider 096 * @param dateMin The min date 097 * @param dateMax The max date 098 */ 099 public void setRange(Instant dateMin, Instant dateMax) { 100 this.dateMin = dateMin; 101 this.dateMax = dateMax; 102 } 103 104 /** 105 * Sets the slider to the given value 106 * @param date The date 107 */ 108 public void setDate(Instant date) { 109 spinner.setValue(Date.from(date)); 110 } 111 112 /** 113 * Gets the date that was selected by the user 114 * @return The date 115 */ 116 public Instant getDate() { 117 return ((Date) spinner.getValue()).toInstant(); 118 } 119 120 /** 121 * Adds a change listener to this date editor. 122 * @param l The listener 123 */ 124 public void addDateListener(ChangeListener l) { 125 listeners.add(l); 126 } 127 128 /** 129 * Removes a change listener from this date editor. 130 * @param l The listener 131 */ 132 public void removeDateListener(ChangeListener l) { 133 listeners.remove(l); 134 } 135 136 @Override 137 public void setEnabled(boolean enabled) { 138 super.setEnabled(enabled); 139 for (Component c: getComponents()) { 140 c.setEnabled(enabled); 141 } 142 } 143}