consistent-time-format -- Times should be consistent in the application

[deyan]

Make the time format in the application in the following format: MM:SS:sss. This applies to:

• Timeline head
• Timeline HUD
• Timeline tick label

When the user edits a whole field, the value he has entered should be converted to the format from milliseconds

[stefan]

Basically, this task is contains three minor tweaks:

• change in the time format in org.sophie2.main.func.timelines.hud.HeadSection in the compute() method:
  

SimpleDateFormat sdf = new SimpleDateFormat("mm:ss:SSS");

• method createSpinnerEditor was added to the BoundSpinner class which, by default returns null, in which case nothing happens, i.e. the behavior of the BoundSpinner isn't changed. When this method is overridden by some child of BoundSpinner}}, it returns {{{JPanel (in our case wrapper of JFormattedTextField) that is used as a editor in the swing's JSpinner API.
  • code of significance for our editor (the inner class of BaseTimelinesSpinner), as described above:

    private String formatTime(int millis) {
    			int min = millis / 1000 / 60;
    			int sec = millis / 1000 % 60;
    			int mil = millis % 1000;
    			return String.format(FORMAT, min, sec, mil);
    		}
    
    		private int extractTime(String time) {
    			String[] tokens = time.split(":");
    			assert (tokens.length == 3);
    			int min = Integer.parseInt(tokens[0]);
    			int sec = Integer.parseInt(tokens[1]);
    			int mil = Integer.parseInt(tokens[2]);
    			return mil + (sec * 1000) + (min * 60 * 1000);
    		}
    
    		public void stateChanged(ChangeEvent e) {
    			JSpinner spinnerSource = (JSpinner) (e.getSource());
    			int val = (Integer) spinnerSource.getValue();
    			getTextField().setValue(formatTime(val));
    
    		}
    
    		public void propertyChange(PropertyChangeEvent evt) {
    			if (this.spinner == null) {
    				return;
    			}
    
    			Object source = evt.getSource();
    			String name = evt.getPropertyName();
    			if ((source instanceof JFormattedTextField) && "value".equals(name)) {
    				int lastValue = (Integer) this.spinner.getValue();
    
    				try {
    					String textValue = (String) getTextField().getValue();
    					this.spinner.setValue(extractTime(textValue));
    				} catch (IllegalArgumentException iae) {
    					try {
    						((JFormattedTextField) source).setValue(lastValue);
    					} catch (IllegalArgumentException iae2) {
    						// TODO do nothing if field invalid
    					}
    				}
    			}
    
    		}
    	}
    

• change the display of the Timeline's play head. This cannot be implemented because this value is hard-coded property in the JSpinner's API. There is only possibility (the property is called Spinner.showValue) to choose whether it is showed or not.

[meddle]

I'm failing the ticket because when you enter in the spinner editable field a number that is no in the format d:d:d, an assertation error is thrown.

Another thing, when you pick a bug/tweak ticket you review it's analysis to see if you understand what is the problem. You can fail it if you don't understand it. When you pass it you must score it and write yourself as an analysis reviewer.

[stefan]

the analysis is fine, except the fact that there can be nothing done to change the value format of the timeline's playing head. "Timeline tick label" should also be added in the conditions of the bug.

[stefan]

Basically, this task is contains three minor tweaks:

• change in the time format in org.sophie2.main.func.timelines.hud.HeadSection in the compute() method:

  SimpleDateFormat sdf = new SimpleDateFormat("mm:ss:SSS");
  

• method createSpinnerEditor was added to the BoundSpinner class which, by default returns null, in which case nothing happens, i.e. the behavior of the BoundSpinner isn't changed. When this method is overridden by some child of BoundSpinner}}, it returns JPanel (in our case wrapper of JFormattedTextField) that is used as a editor in the swing's JSpinner API.
  • code of significance for our editor (the inner class of BaseTimelinesSpinner), as described above:

    private int extractTime(String time) {
    			String[] tokens = time.split(":");
    			assert (tokens.length == 3);
    			int min = Integer.parseInt(tokens[0]);
    			int sec = Integer.parseInt(tokens[1]);
    			int mil = Integer.parseInt(tokens[2]);
    			return mil + (sec * 1000) + (min * 60 * 1000);
    		}
    
    		public void stateChanged(ChangeEvent e) {
    			JSpinner spinnerSource = (JSpinner) (e.getSource());
    			int val = (Integer) spinnerSource.getValue();
    			getTextField().setValue(formatTime(val));
    		}
    		
    		public boolean validate(String field) {
    			String[] tokens = field.split(":");
    			if (!(tokens.length == 3)) {
    				return false;
    			}
    			for (int i = 0; i < tokens.length; i++) {
    				for (int j = 0; j < tokens[i].length(); j++) {
    					if (!Character.isDigit(tokens[i].charAt(j))) {
    						return false;
    					}
    				}
    			}
    			return true;
    		}
    
    		public void propertyChange(PropertyChangeEvent evt) {
    			if (this.spinner == null) {
    				return;
    			}
    
    			Object source = evt.getSource();
    			String name = evt.getPropertyName();
    			if ((source instanceof JFormattedTextField) && "value".equals(name)) {
    				int lastValue = (Integer) this.spinner.getValue();
    
    				try {
    					String textValue = (String) getTextField().getValue();
    					if (!validate(textValue)) {
    						((JFormattedTextField) source).setValue(formatTime(lastValue));
    						return;
    					}
    					this.spinner.setValue(extractTime(textValue));
    				} catch (IllegalArgumentException iae) {
    					try {
    						((JFormattedTextField) source).setValue(formatTime(lastValue));
    					} catch (IllegalArgumentException iae2) {
    						// TODO do nothing if field invalid
    					}
    				}
    			}
    
    		}
    

  • as you can see, a method validate() is added to the inner class, in order to provide validation of the format of the input - xx:xx:xxx. The validation of the real value (number of milliseconds) in the logic of the application is provided by the BoundSpinner.validate method.
• change the display of the Timeline's play head. This cannot be implemented because this value is hard-coded property in the JSpinner's API. There is only possibility (the property is called Spinner.showValue) to choose whether it is showed or not.

[mira]

• I fail the task, because I cannot apply the patch to the trunk

[stefan]

The last patch contains SpinnerNumberModel in order to provide capability of using the spinner to change (increase or decrease) the value of minutes, seconds or milliseconds of the spinner, if the caret of the text field is in the minutes, seconds or milliseconds section respectfully. The code of significance:

/**
	 * An implementation of {@link SpinnerNumberModel} class, in order to
	 * provide capability
	 * 
	 * @author stefan
	 * 
	 */
	class BaseTimelineSpinnerModel extends SpinnerNumberModel {

		private static final long serialVersionUID = 5065673918920549095L;

		private int step;

		/**
		 * The default and only constructor.
		 * 
		 * @param step
		 *            The default step in milliseconds - usually
		 *            {@link BaseTimelinesSpinner#STEP_SIZE_MILLIS}
		 */
		public BaseTimelineSpinnerModel(int step) {
			super(Integer.valueOf(0), Integer.valueOf(0), null, Integer
					.valueOf(step));
			this.step = step;
		}

		@Override
		public Object getNextValue() {
			super.setStepSize(this.step * getStepMult());
			return super.getNextValue();
		}

		@Override
		public Object getPreviousValue() {
			super.setStepSize(this.step * getStepMult());
			return super.getPreviousValue();
		}

		/**
		 * Returns the step size.
		 * 
		 * @return Step.
		 */
		public int getStep() {
			return this.step;
		}
	}

[kyli]

Seems OK to me. I would just like to note, that using auto-formatting in eclipse is not encouraged by meddle :)

4p, merged with trunk at [8686].

[meddle]

Closing all the tickets before M Y1