Fix SerialPlotter.java not applying line ending preference on new window to dropdown box #11070

sceniclife · 2020-12-14T18:32:57Z

applyPreferences is called but the class function is misspelled as appyPreferences

Arduino/app/src/processing/app/SerialPlotter.java

Line 338 in f4e8a91

applyPreferences();

Because of the typo, the class function was never called and only the superclass is called.
In practice, the applyPreferences is just reading the preferences file and setting the dropdown boxes to the current running value. Because the class applyPreferences wasn't called, the line ending dropdown box is not displaying the correct line ending that the user had set.

Before the change, changing the line ending preference does change the preference.

Arduino/app/src/processing/app/SerialPlotter.java

Lines 323 to 326 in f4e8a91

    
           lineEndings.addActionListener((ActionEvent event) -> { 
        
             PreferencesData.setInteger("serial.line_ending", lineEndings.getSelectedIndex()); 
        
             noLineEndingAlert.setForeground(pane.getBackground()); 
        
           });

However, it's possible that No line ending is used even if you had a line ending preference set internally. (send() class function uses the current dropdown selection, and because No line ending is the default value on new window)

Arduino/app/src/processing/app/SerialPlotter.java

Lines 347 to 369 in f4e8a91

    
           private void send(String string) { 
        
             String s = string; 
        
             if (serial != null) { 
        
               switch (lineEndings.getSelectedIndex()) { 
        
                 case 1: 
        
                   s += "\n"; 
        
                   break; 
        
                 case 2: 
        
                   s += "\r"; 
        
                   break; 
        
                 case 3: 
        
                   s += "\r\n"; 
        
                   break; 
        
                 default: 
        
                   break; 
        
               } 
        
               if ("".equals(s) && lineEndings.getSelectedIndex() == 0 && !PreferencesData.has("runtime.line.ending.alert.notified")) { 
        
                 noLineEndingAlert.setForeground(Color.RED); 
        
                 PreferencesData.set("runtime.line.ending.alert.notified", "true"); 
        
               } 
        
               serial.write(s); 
        
             } 
        
           }

matthijskooijman

Huh? You rename a method, but no calls to this method? It seems it was called under the old name, how does that work? Is it that the superclass defines the method by the proper name and SerialPlotter tried but failed to override this method due to the typo?

What does this mean in practice? Before this fix, the line endings preference was not applied to the plotter? Or was it just that the dropdown did not reflect the actual value, but the right value was used internally?

sceniclife · 2020-12-15T16:54:22Z

@matthijskooijman The method is called on line

Arduino/app/src/processing/app/SerialPlotter.java

Line 338 in f4e8a91

applyPreferences();

Because of the typo, the class function was never called and only the superclass is called.
In practice, the applyPreferences is just reading the preferences file and setting the dropdown boxes to the current running value. Because the class applyPreferences wasn't called, the line ending dropdown box is not displaying the correct line ending that the user had set.

Before the change, changing the line ending preference does change the preference.

Arduino/app/src/processing/app/SerialPlotter.java

Lines 323 to 326 in f4e8a91

    
           lineEndings.addActionListener((ActionEvent event) -> { 
        
             PreferencesData.setInteger("serial.line_ending", lineEndings.getSelectedIndex()); 
        
             noLineEndingAlert.setForeground(pane.getBackground()); 
        
           });

However, it's possible that No line ending is used even if you had a line ending preference set internally. (send() class function uses the current dropdown selection, and because No line ending is the default value on new window)

Arduino/app/src/processing/app/SerialPlotter.java

Lines 347 to 369 in f4e8a91

    
           private void send(String string) { 
        
             String s = string; 
        
             if (serial != null) { 
        
               switch (lineEndings.getSelectedIndex()) { 
        
                 case 1: 
        
                   s += "\n"; 
        
                   break; 
        
                 case 2: 
        
                   s += "\r"; 
        
                   break; 
        
                 case 3: 
        
                   s += "\r\n"; 
        
                   break; 
        
                 default: 
        
                   break; 
        
               } 
        
               if ("".equals(s) && lineEndings.getSelectedIndex() == 0 && !PreferencesData.has("runtime.line.ending.alert.notified")) { 
        
                 noLineEndingAlert.setForeground(Color.RED); 
        
                 PreferencesData.set("runtime.line.ending.alert.notified", "true"); 
        
               } 
        
               serial.write(s); 
        
             } 
        
           }

sceniclife · 2020-12-15T17:16:13Z

Change can also be seen here: #7461

CLAassistant · 2021-04-09T12:56:22Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

Typo in SerialPlotter.java

e9d554e

per1234 added the SerialPlotter Tools > Serial Plotter label Dec 15, 2020

matthijskooijman reviewed Dec 15, 2020

View reviewed changes

sceniclife changed the title ~~Typo in SerialPlotter.java~~ Fix SerialPlotter.java not applying line ending preference on new window to dropdown box Dec 15, 2020

cmaglie merged commit 69e91ca into arduino:master May 10, 2021

cmaglie added this to the Release 1.8.14 milestone May 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix SerialPlotter.java not applying line ending preference on new window to dropdown box #11070

Fix SerialPlotter.java not applying line ending preference on new window to dropdown box #11070

sceniclife commented Dec 14, 2020 •

edited

Loading

matthijskooijman left a comment

sceniclife commented Dec 15, 2020 •

edited

Loading

sceniclife commented Dec 15, 2020

CLAassistant commented Apr 9, 2021

	lineEndings.addActionListener((ActionEvent event) -> {
	PreferencesData.setInteger("serial.line_ending", lineEndings.getSelectedIndex());
	noLineEndingAlert.setForeground(pane.getBackground());
	});

	private void send(String string) {
	String s = string;
	if (serial != null) {
	switch (lineEndings.getSelectedIndex()) {
	case 1:
	s += "\n";
	break;
	case 2:
	s += "\r";
	break;
	case 3:
	s += "\r\n";
	break;
	default:
	break;
	}
	if ("".equals(s) && lineEndings.getSelectedIndex() == 0 && !PreferencesData.has("runtime.line.ending.alert.notified")) {
	noLineEndingAlert.setForeground(Color.RED);
	PreferencesData.set("runtime.line.ending.alert.notified", "true");
	}
	serial.write(s);
	}
	}

Fix SerialPlotter.java not applying line ending preference on new window to dropdown box #11070

Fix SerialPlotter.java not applying line ending preference on new window to dropdown box #11070

Conversation

sceniclife commented Dec 14, 2020 • edited Loading

matthijskooijman left a comment

Choose a reason for hiding this comment

sceniclife commented Dec 15, 2020 • edited Loading

sceniclife commented Dec 15, 2020

CLAassistant commented Apr 9, 2021

sceniclife commented Dec 14, 2020 •

edited

Loading

sceniclife commented Dec 15, 2020 •

edited

Loading