1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
|
package tim.prune.function;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.FlowLayout;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.event.KeyAdapter;
import java.awt.event.KeyEvent;
import javax.swing.BorderFactory;
import javax.swing.ButtonGroup;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JRadioButton;
import javax.swing.SwingUtilities;
import tim.prune.App;
import tim.prune.GenericFunction;
import tim.prune.I18nManager;
import tim.prune.data.Distance;
import tim.prune.data.Field;
import tim.prune.data.TimeDifference;
import tim.prune.data.Unit;
import tim.prune.data.UnitSetLibrary;
import tim.prune.gui.GuiGridLayout;
import tim.prune.gui.WholeNumberField;
/**
* Superclass for functions which act on a defined
* distance limit or time limit
*/
public abstract class DistanceTimeLimitFunction extends GenericFunction
{
/** Dialog */
protected JDialog _dialog = null;
/** Radio buttons for splitting by distance and time */
private JRadioButton _distLimitRadio = null, _timeLimitRadio = null;
/** Radio button for splitting by fraction (such as half-distance) */
private JRadioButton _halvesRadio = null;
/** Flag for whether to offer halves or not */
private final boolean _showHalves;
/** Dropdown for selecting distance units */
private JComboBox<String> _distUnitsDropdown = null;
/** Text field for entering distance */
private WholeNumberField _distanceField = null;
/** Text fields for entering distance */
private WholeNumberField _limitHourField = null, _limitMinField = null;
/** Ok and cancel buttons */
private JButton _okButton = null;
/**
* React to item changes and key presses by enabling / disabling ok button
*/
private class ChangeListener extends KeyAdapter implements ItemListener
{
/** Item changed in ItemListener */
public void itemStateChanged(ItemEvent event) {
enableOkButton();
}
/** Key released in KeyListener */
public void keyReleased(KeyEvent event) {
enableOkButton();
if (event.getKeyCode() == KeyEvent.VK_ESCAPE) {
_dialog.dispose();
}
}
}
/**
* Constructor
*/
public DistanceTimeLimitFunction(App inApp, boolean inShowHalves)
{
super(inApp);
_showHalves = inShowHalves;
}
/**
* Begin the function
*/
public void begin()
{
if (_dialog == null)
{
_dialog = new JDialog(_parentFrame, getName(), true);
_dialog.setLocationRelativeTo(_parentFrame);
_dialog.setDefaultCloseOperation(JDialog.DISPOSE_ON_CLOSE);
_dialog.getContentPane().add(makeDialogComponents());
_dialog.pack();
}
enableOkButton();
// TODO: Maybe set distance units according to current Config setting?
final boolean hasTimestamps = _app.getTrackInfo().getTrack().hasData(Field.TIMESTAMP);
_timeLimitRadio.setEnabled(hasTimestamps);
if (!hasTimestamps) {
_distLimitRadio.setSelected(true);
}
SwingUtilities.invokeLater(() -> _distanceField.requestFocus());
_dialog.setVisible(true);
}
/**
* Create dialog components
* @return Panel containing all gui elements in dialog
*/
private Component makeDialogComponents()
{
JPanel dialogPanel = new JPanel();
dialogPanel.setLayout(new BorderLayout(5, 5));
// Make radio buttons for the options
_distLimitRadio = new JRadioButton(I18nManager.getText("dialog.correlate.options.distancelimit") + ": ");
_timeLimitRadio = new JRadioButton(I18nManager.getText("dialog.correlate.options.timelimit") + ": ");
if (_showHalves) {
_halvesRadio = new JRadioButton(I18nManager.getText("dialog.markers.halves"));
}
ButtonGroup radioGroup = new ButtonGroup();
radioGroup.add(_distLimitRadio);
radioGroup.add(_timeLimitRadio);
if (_showHalves) {
radioGroup.add(_halvesRadio);
}
// central panel for limits
JPanel limitsPanel = new JPanel();
limitsPanel.setBorder(BorderFactory.createEmptyBorder(8, 8, 8, 8));
GuiGridLayout grid = new GuiGridLayout(limitsPanel, new double[] {0.5, 1.0},
new boolean[] {false, false});
ChangeListener optionsChangedListener = new ChangeListener();
// distance limits
grid.add(_distLimitRadio);
_distLimitRadio.setSelected(true);
_distLimitRadio.addItemListener(optionsChangedListener);
JPanel distLimitPanel = new JPanel();
distLimitPanel.setLayout(new FlowLayout());
_distanceField = new WholeNumberField(3);
_distanceField.addKeyListener(optionsChangedListener);
distLimitPanel.add(_distanceField);
String[] distUnitsOptions = {I18nManager.getText("units.kilometres"), I18nManager.getText("units.metres"),
I18nManager.getText("units.miles")};
_distUnitsDropdown = new JComboBox<String>(distUnitsOptions);
_distUnitsDropdown.addItemListener(optionsChangedListener);
distLimitPanel.add(_distUnitsDropdown);
distLimitPanel.setAlignmentX(Component.LEFT_ALIGNMENT);
grid.add(distLimitPanel);
// time limit panel
grid.add(_timeLimitRadio);
_timeLimitRadio.addItemListener(optionsChangedListener);
JPanel timeLimitPanel = new JPanel();
timeLimitPanel.setLayout(new FlowLayout());
_limitHourField = new WholeNumberField(2);
_limitHourField.addKeyListener(optionsChangedListener);
timeLimitPanel.add(_limitHourField);
timeLimitPanel.add(new JLabel(I18nManager.getText("dialog.correlate.options.offset.hours")));
_limitMinField = new WholeNumberField(3);
_limitMinField.addKeyListener(optionsChangedListener);
timeLimitPanel.add(_limitMinField);
timeLimitPanel.add(new JLabel(I18nManager.getText("units.minutes")));
timeLimitPanel.setAlignmentX(Component.LEFT_ALIGNMENT);
grid.add(timeLimitPanel);
// halves
if (_showHalves)
{
grid.add(_halvesRadio);
_halvesRadio.addItemListener(optionsChangedListener);
}
dialogPanel.add(limitsPanel, BorderLayout.NORTH);
// button panel at bottom
JPanel buttonPanel = new JPanel();
buttonPanel.setLayout(new FlowLayout(FlowLayout.RIGHT));
// OK button
_okButton = new JButton(I18nManager.getText("button.ok"));
_okButton.addActionListener(e -> performFunction());
buttonPanel.add(_okButton);
// Cancel button
JButton cancelButton = new JButton(I18nManager.getText("button.cancel"));
cancelButton.addActionListener(e -> _dialog.dispose());
cancelButton.addKeyListener(new KeyAdapter() {
public void keyPressed(KeyEvent inE) {
if (inE.getKeyCode() == KeyEvent.VK_ESCAPE) {_dialog.dispose();}
}
});
buttonPanel.add(cancelButton);
dialogPanel.add(buttonPanel, BorderLayout.SOUTH);
return dialogPanel;
}
/**
* Enable or disable the OK button according to the inputs
*/
private void enableOkButton()
{
boolean enabled = false;
if (_distLimitRadio.isSelected()) {
enabled = _distanceField.getValue() > 0;
}
else if (_timeLimitRadio.isSelected()) {
enabled = _limitHourField.getValue() > 0 || _limitMinField.getValue() > 0;
}
else if (_halvesRadio != null && _halvesRadio.isSelected()) {
enabled = true;
}
_okButton.setEnabled(enabled);
// Also enable/disable the other fields
_distanceField.setEnabled(_distLimitRadio.isSelected());
_distUnitsDropdown.setEnabled(_distLimitRadio.isSelected());
_limitHourField.setEnabled(_timeLimitRadio.isSelected());
_limitMinField.setEnabled(_timeLimitRadio.isSelected());
}
/**
* @return selected time limit in seconds, or 0
*/
protected int getTimeLimitInSeconds()
{
if (_timeLimitRadio.isSelected()
&& (_limitHourField.getValue() > 0 || _limitMinField.getValue() > 0))
{
int timeLimitSeconds = _limitHourField.getValue() * 60 * 60
+ _limitMinField.getValue() * 60;
if (timeLimitSeconds > 0) {
return timeLimitSeconds;
}
}
return 0;
}
/**
* @return selected distance limit in radians, or 0.0
*/
protected double getDistanceLimitRadians()
{
if (_distLimitRadio.isSelected()
&& _distanceField.getValue() > 0)
{
final Unit[] distUnits = {UnitSetLibrary.UNITS_KILOMETRES,
UnitSetLibrary.UNITS_METRES, UnitSetLibrary.UNITS_MILES};
Unit distUnit = distUnits[_distUnitsDropdown.getSelectedIndex()];
double distLimitRadians = Distance.convertDistanceToRadians(_distanceField.getValue(), distUnit);
return distLimitRadians;
}
return 0.0;
}
/**
* @return selected distance limit in km, or 0.0
*/
protected double getDistanceLimitKilometres()
{
return Distance.convertRadiansToDistance(getDistanceLimitRadians(), UnitSetLibrary.UNITS_KILOMETRES);
}
/**
* @return true if "halves" option was selected
*/
protected boolean isHalvesSelected() {
return _halvesRadio != null && _halvesRadio.isSelected();
}
/**
* The dialog has been completed and OK pressed, so do the corresponding function
*/
protected abstract void performFunction();
/**
* Create a description for the given multiple of the configured limit
* @param inMultiple multiple of selected limit
* @return language-specific String description for waypoint names
*/
protected String createLimitDescription(int inMultiple)
{
if (_distLimitRadio.isSelected()
&& _distanceField.getValue() > 0)
{
final int distLimit = inMultiple * _distanceField.getValue();
final String[] distUnits = {"kilometres", "metres", "miles"};
final String unitKey = "units." + distUnits[_distUnitsDropdown.getSelectedIndex()] + ".short";
return "" + distLimit + " " + I18nManager.getText(unitKey);
}
else if (_timeLimitRadio.isSelected())
{
final long timeLimitSecs = (long) getTimeLimitInSeconds() * inMultiple;
return new TimeDifference(timeLimitSecs).getDescription();
}
return null;
}
}
|