7124282: [macosx] Can't see table cell highlighter when the highlight border is the same color as the cell. #7768
Conversation
|
👋 Welcome back honkar-jdk! A progress list of the required criteria for merging this PR into |
openjdk
bot
changed the title
|
@honkar-jdk The following label will be automatically applied to this pull request:
When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command. |
Webrevs
|
|
Before and After images of cell focus ring changes on SwingSet2. (cell focus on first cell) |
| @@ -889,7 +889,7 @@ public Object createValue(UIDefaults defaultsTable) { | |||
| "Table.gridColor", white, // grid line color | |||
| "Table.focusCellBackground", textHighlightText, | |||
| "Table.focusCellForeground", textHighlight, | |||
| "Table.focusCellHighlightBorder", focusCellHighlightBorder, | |||
| "Table.focusCellHighlightBorder", new BorderUIResource.LineBorderUIResource(deriveContrastFocusRing(selectionBackground), 2), | |||
There was a problem hiding this comment.
You have used border thickness as 2 without relying on scale factor. Did you check if it looks same in retina as well as non-retina display?
There was a problem hiding this comment.
Do we also need to do the same for List.focusCellHighlightBorder?
There was a problem hiding this comment.
@prsadhuk Thank you for reviewing.
Earlier when I used the default thickness (thickness=1) the cell focus ring was visible but not prominent as shown in the following screenshot. Please let me know if I need to change thickness to 1 or keep it the same?
Thickness=1
The thickness looks the same on retina as well as non-retina display. I have included the screenshots for comparison-
There was a problem hiding this comment.
Since List.focusCellHighlightBorder uses the same focusRingColor as used by Table we can change it for List as well. Can I make changes to List using this issue and PR or should I track it by adding a new JBS bug/PR ?
There was a problem hiding this comment.
Just thinking, Do we need to manipulate hue and saturation for focus ring?
It seems from native "Numbers" app which is closest to Tables & cells, I see the focus ring is always blue irrespective of what the selection background (and system accent color) is
and since Aqua should mimic native look, so I guess just this change will probably do
- Table.focusCellHighlightBorder", focusCellHighlightBorder,
+ Table.focusCellHighlightBorder", new BorderUIResouce.LineBorderUIResouce(Color.blue), 2),
There was a problem hiding this comment.
With latest repo and your fix, I put a debug log in deriveContrastFocusRing() and it seems to produce this output (for scenario above)
selectedBackgroundColor com.apple.laf.AquaImageFactory$SystemColorProxy[r=54,g=128,b=34]
I see, even if I change the highlight Color to blue, it does not call deriveContrastFocusRing() again and the focus ring remains green although background Color of JTable cell changes to blue [ I think deriveContrastFocusRing needs to be called every time accent color is changed in System->Preferences]
There was a problem hiding this comment.
@prsadhuk I'm currently testing on mac 11.6 and observe that the background color for JTable follows accent color changes (in mac 11.6). Below are screenshots on mac 10.15 vs mac 11.6 under same settings
On Mac 10.15, JTable's background color seems to follow the highlight color changes whereas in 11.6 it follows the accent color changes. In both versions the selectionBackground is obtained from the same property - alternateSelectedControlColor
The other issue which was related to on-the-fly accent/highlight color changes corresponding to following case - deriveContrastFocusRing needs to be called every time there is change to System Preference colors is fixed and the code will be pushed shortly.
There was a problem hiding this comment.
@prsadhuk Pushed new changes related to -
- On-the-fly focus ring changes
- Since selectionBackground was following highlight color changes in mac 10.15 and accent color changes in mac 11.6, I have updated deriveContrastFocusRing() to use original focusRingColor (which follows accent color changes in both versions) to obtain the lighter version.
There was a problem hiding this comment.
Do we also need to do the same for List.focusCellHighlightBorder?
@prsadhuk Just wanted to include these screenshots for reference in case we decided to do similar changes for JList. Before and after images if the above changes are applied to Lists as well.
BEFORE
Single Selection
Multiple Selection
AFTER
Single Selection
Multiple Selection
There was a problem hiding this comment.
@prsadhuk I might have missed considering a more generic condition for the edge case. I'll push the line formatting changes, along with the these changes.
| hsbValues[2] = brightnessValue; | ||
|
|
||
| //create and return Color corresponding to new hsbValues | ||
| return Color.getHSBColor(hsbValues[0], hsbValues[1], hsbValues[2]); |
There was a problem hiding this comment.
It seems you are only manipulating hue and saturation, not the brightness which is set to 1.0f throughout..need to change the javadoc comment
There was a problem hiding this comment.
Sure. I will change the Javadocs comments as suggested.
The reason for setting brightness to max value is that for any color returned by hue and saturation offset, setting brightness=1 gives the brightest color for the new color used for cell highlighting purpose.
|
@honkar-jdk This change now passes all automated pre-integration checks. ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details. After integration, the commit message for the final commit will be: You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been 170 new commits pushed to the
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details. As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@prsadhuk, @prrace) but any other Committer may sponsor as well. ➡️ To flag this PR as ready for integration with the above commit message, type |
@prsadhuk The code might require re-review as I have changed the edge case condition to accommodate grayish color (red, blue, green components are not exactly equal) and formatted the line lengths. |
| * @param focusRingColor - the {@code Color} object | ||
| * @return the {@code Color} object corresponding to new HSB values | ||
| */ | ||
| static Color deriveLighterFocusRing(Color focusRingColor) { |
There was a problem hiding this comment.
I guess we are not generating a "lighter" focus ring now, just a prominent one, so I think this function needs renaming..
There was a problem hiding this comment.
Also, I see if we start off with "Graphite" accent color then the focus ring is "Graphite" but then even if we change to any other accent color, the focus ring remains "Graphite"
There was a problem hiding this comment.
@prsadhuk I was able to replicate the above scenario and as mentioned it oddly happens only when we start with Graphite as accent color. Looking into it further.
There was a problem hiding this comment.
Following type properties where checked for cellFocusRing color
-
alternateSelectedControlColor
Issue: Doesn't follow accent color in macos 10.15 and deprecated property. -
selectedContentBackgroundColor
Issue: New property corresponding to alternateSelectedControlColor (deprecated). Causes build issues as the property is supported on macOS 10.14+ and the macOS deployment target version is 10.12 for jdk. -
controlAccentColor
Issue: Causes build issues due to version compatibility, property supported on only macOS 10.14+ -
accentColor
Issue: Property supported on only macOS 10.15+, compatibility and run time issues. -
keyboardfocusindicatorcolor
Issue: Works well for most of the scenarios (including on-the-fly changes) and follows the accent color changes except when we start the application with accent color set to Graphite and then change accent color on-the-fly (as mentioned above). The cell focus ring remains gray. The issue seems to be with the system color returned by the type-property "keyboardfocusindicatorcolor" under this setting.
There was a problem hiding this comment.
It seems KEYBOARD_FOCUS_COLOR via focusRingColor is also used for menuSelectedBackgroundColor which is used for
CheckBoxMenuItem.selectionBackground
ComboBox.selectionBackground
Menu.selectionBackground
MenuBar.selectionBackground
MenuItem.selectionBackground
"PopupMenu.selectionBackground", menuSelectedBackgroundColor,
RadioButtonMenuItem.selectionBackground
which might also get affected if you use new property, so you need to test all those widgets if you intend to use reuse KEYBOARD_FOCUS_COLOR so I guess safe bet is to use new color as you mentioned to limit the change to highlight color.
There was a problem hiding this comment.
@prsadhuk Following code changes were pushed and ready for re-review
- New color added to CSystemColor.m - CELL_HIGHLIGHT_COLOR, to limit the effects of highlight color changes
- AquaImageFactory and LWCToolkit changed as part of addition of new color
- method renamed from deriveLighterFocusRing() to deriveProminentFocusRing()
- Test case made headful to load system colors
There was a problem hiding this comment.
@prsadhuk With the new changes a public method is added to AquaImageFactory, does this require a CSR?
There was a problem hiding this comment.
If you are talking about getCellHighlightColorUIResource() then no. We don't have specs for this class.
I have added similar getSelectedControlColorUIResource method for JDK-8251377 without CSR
There was a problem hiding this comment.
@prsadhuk Thank you! Noted. Yes, it is thegetCellHighlightColorUIResource() method.
@prsadhuk Suggested changes have been incorporated. PR might require a re-review. |
| @@ -388,6 +388,9 @@ public Object createValue(UIDefaults defaultsTable) { | |||
| final Color focusRingColor = AquaImageFactory.getFocusRingColorUIResource(); | |||
| final Border focusCellHighlightBorder = new BorderUIResource.LineBorderUIResource(focusRingColor); | |||
|
|
|||
| // for table cell highlighter | |||
| final Color cellFocusRing = AquaImageFactory.getCellHighlightColorUIResource(); | |||
There was a problem hiding this comment.
overall looks ok. I believe you have tested well in BigSur and Monterey also..
Minor nit, this cellFocusRing should be "cellFocusRingColor" like other color variables.
There was a problem hiding this comment.
@prsadhuk I have tested it on BigSur and Monterey, the new changes are working well. I will change the variable name as suggested and update the PR.
There was a problem hiding this comment.
@prsadhuk Updated the PR. A note on the test case, since the test case is automated it tests the cell focus ring with colors loaded during the start of program execution and any on-the-fly accent color changes were tested manually.
|
/integrate |
|
@honkar-jdk |
|
/sponsor |
|
Going to push as commit bd6026c.
Your commit was automatically rebased without conflicts. |
openjdk
bot
removed
ready
|
@prsadhuk @honkar-jdk Pushed as commit bd6026c. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
Previously while tabbing through the JTable cell, the cell highlighter/focus ring was not visible against the selection background.
Changes are made to Aqua LAF to derive a lighter focus ring color by changing saturation and setting brightness component to 100% of original focus ring color so that it is visible while tabbing through
JTablecells. A new method is added for this purpose which takes infocusRingColor, does adjustment to saturation and brightness and returns a new focus ring color. There are edge cases where the HSB transformation does not yield the right focus ring color, for these cases a default color is returned.A test case is added to compare the RGB difference between the original focus ring color & selection background and the new focus ring color & selection background. A note on the test case, since the test case is automated it tests the cell focus ring with colors loaded during the start of program execution and any on-the-fly accent color changes were tested manually.
Edge Cases
The edge case condition consists of two parts –
To handle white/black colors - (hsbValues[0] == 0 && hsbValues[1] == 0) - representing hue and saturation of zero obtained for black, white or exactly grey (red=green=color) conditions
To handle grayish colors - hsbValues[1] <= satGrayScale where satGrayScale <= 0.10 . For any given hue and brightness, a saturation of less than or equal to 10% represents grayish tint colors. (The second case was added to accommodate grayish focus ring color returned by system when Accent color = Graphite. The returned color is not exactly gray but grayish (r=135, g=135, b=140)). To accommodate a more generic case of grayish colors, the satGrayScale has a threshold or tolerance of 0.10 or 10%.
Used the following resources to test out different grayish colors and optimal saturation offsets used in
deriveLighterFocusRing().A note on the system-colors:
For Mac 10.14 below:
keyboardfocusindicatorcolor
Issue: Works well for most of the scenarios (including on-the-fly changes) and follows the accent color changes except when we start the application with accent color set to Graphite and then change accent color on-the-fly The cell focus ring remains gray. The issue is with the system color returned by the type-property "keyboardfocusindicatorcolor" under this setting and NOT a JDK product bug.
For Mac 10.14+:
controlAccentColor
is available and it follows accent color changes (even when application started with Graphite as accent color). The proposed fix uses this type property when mac version is 10.14+
PS: The native L&F (Mac OS) and Swing L&F for JTable cell tabbing differs (on native tables the cell background turns white on focus with a cell focus ring). Since the background for Swing tables can be set by users and also overridden by subclassing
DefaultTableCellRenderer, and to adhere to current implementation of Swing, the white cell background changes are not incorporated. Only the Focus Ring/ Cell Highlighter is made more prominent.Progress
Issue
Reviewers
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/7768/head:pull/7768$ git checkout pull/7768Update a local copy of the PR:
$ git checkout pull/7768$ git pull https://git.openjdk.java.net/jdk pull/7768/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 7768View PR using the GUI difftool:
$ git pr show -t 7768Using diff file
Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/7768.diff