Modified the behavior of spinner widget to react differently with dif…

[wmliuanl]

…ferent key combinations

arrow up/down: change by 1 increment
page up/down: change by 10 increment
Alt + arrow up/down change by 5 increment
Alt + page up/down change by 50 increment

Checklist

• Testing:

  • The feature has automated tests
  • Tests were run
  • If not, explain how you tested your changes
  • The features have been tested at our facility. The old spinner widget only increase or decrease by 1 increment when arrow up/down keys are pressed. But our operators are used to the our old inhouse control system programs which has edit controls that can response with different increments for different key combinations. To smooth up the transition from old inhouse control system to EPICS control system, I modified the spinner widget to provide similar behavior from CSS Phoebus OPIs.

• Documentation:

  • The feature is documented
  • The documentation is up to date
  • Release notes:
    • Added an entry if the change is breaking or significant
    • Added an entry when adding a new feature

[abrahamwolk]

This pull request looks OK to me.

One aspect to keep in mind is that it changes the behavior of pressing simply "Page Up" & "Page Down" to increment/decrement by 10, instead of by 1, as is currently the case.

[georgweiss]

For Mac users a bit of clarification may be needed:
Alt + arrow up is better phrased as Option + arrow up
Page up/down is actually fn + arrow up/down. So change by 50 needs three keys Option + fn + arrow up/down

[georgweiss]

It would also be a nice thing to describe this feature in the example display https://github.com/ControlSystemStudio/phoebus/blame/master/app/display/model/src/main/resources/examples/controls_textentry.bob

[kasemir]

"Page Up" & "Page Down" to increment/decrement by 10, instead of by 1, as is currently the case.

This could be a problem for existing displays. Users who are accustomed to pressing page up/down will suddenly jerk a motor into its limits.

Instead of amplifying the existing increment/decrement steps, you could reduce them:

arrow up/down: change by 0.1 increment, smaller than before
page up/down: change by 1 increment as before

[wmliuanl]

"This could be a problem for existing displays. Users who are accustomed to pressing page up/down will suddenly jerk a motor into its limits.

Instead of amplifying the existing increment/decrement steps, you could reduce them:

arrow up/down: change by 0.1 increment, smaller than before
page up/down: change by 1 increment as before"
Good point. I will make the changes and add description to the example display.

[wmliuanl]

Changed the key combinations to ctrl + up/down arrow ( x5); ctrl+ page up/down (x10); ctrl + left/right (x 10)
Updated the description in the example for spinner widget

[georgweiss]

ctrl+ page up/down (x10); ctrl + left/down (x 10)

Do not quite understand this.

[wmliuanl]

ctrl+ page up/down (x10); ctrl + left/down (x 10)

Do not quite understand this.

With some keyboard, page up and page down are configured as Fn keys that need Fn key to activate it. For such keyboards, ctrl + page up/down won't work. To support users with such keyboard, an alternative is to make use of left/right arrow key. Oh sorry, I said left/down. I will correct that later.

[wmliuanl]

"Page Up" & "Page Down" to increment/decrement by 10, instead of by 1, as is currently the case.

This could be a problem for existing displays. Users who are accustomed to pressing page up/down will suddenly jerk a motor into its limits.

Instead of amplifying the existing increment/decrement steps, you could reduce them:

arrow up/down: change by 0.1 increment, smaller than before page up/down: change by 1 increment as before

It failed to build when trying to reduce step size. So I changed behavior of arrow up/down and page up/down back to their default to avoid the potential issue for users.

[wmliuanl]

the combination of Ctrl + Page Up/Down doesn't work when test and thus been removed.
The working combinations are
Ctrl + Up/Down arrow keys with 5x step size
Ctrl + Left/Right arrow keys with 10x step size