Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

5021949: JSplitPane setEnabled(false) shouldn't be partially functional #19695

Closed
wants to merge 7 commits into from

Conversation

prsadhuk
Copy link
Contributor

@prsadhuk prsadhuk commented Jun 13, 2024

Issue is seen in that if we call setEnabled(false) over JSplitPane than it can't be dragged via its divider, But if SplitPane have one touch expandable true than user can click those buttons and change the divider position.
So, if splitpane is disabled, then both dragging in divider and one-touch-expandable click should be disabled.
Fix is made to override setEnabled and disable one-touch-expandable buttons actions..


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-5021949: JSplitPane setEnabled(false) shouldn't be partially functional (Bug - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/19695/head:pull/19695
$ git checkout pull/19695

Update a local copy of the PR:
$ git checkout pull/19695
$ git pull https://git.openjdk.org/jdk.git pull/19695/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 19695

View PR using the GUI difftool:
$ git pr show -t 19695

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/19695.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jun 13, 2024

👋 Welcome back psadhukhan! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Jun 13, 2024

@prsadhuk 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:

5021949: JSplitPane setEnabled(false) shouldn't be partially functional

Reviewed-by: abhiscxk, achung, aivanov

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 195 new commits pushed to the master branch:

  • 37e7698: 8335154: jcmd VM.classes -verbose=false does not set verbose to false
  • f3b69da: 8335136: Underscore as parameter name in one-parameter functional types fails to compile
  • 46b817b: 8333363: ubsan: instanceKlass.cpp: runtime error: member call on null pointer of type 'struct AnnotationArray'
  • 0fc5b27: 8332014: since-checker - Fix @ since tags in jdk.jshell
  • 9d20b58: 8334328: Reduce object allocation for FloatToDecimal and DoubleToDecimal
  • 9bb675f: 8334719: (se) Deferred close of SelectableChannel may result in a Selector doing the final close before concurrent I/O on channel has completed
  • 6682305: 8334779: Test compiler/c1/CanonicalizeArrayLength.java is timing out
  • 3796fdf: 8328536: javac - crash on unknown type referenced in yield statement
  • 07bc523: 8334670: SSLSocketOutputRecord buffer miscalculation
  • 4ebb771: 8334769: Shenandoah: Move CodeCache_lock close to its use in ShenandoahConcurrentNMethodIterator
  • ... and 185 more: https://git.openjdk.org/jdk/compare/3a01b47ac97714608356ce3faf797c37dc63e9af...master

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.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the rfr Pull request is ready for review label Jun 13, 2024
@openjdk
Copy link

openjdk bot commented Jun 13, 2024

@prsadhuk The following label will be automatically applied to this pull request:

  • client

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.

@openjdk openjdk bot added the client client-libs-dev@openjdk.org label Jun 13, 2024
@mlbridge
Copy link

mlbridge bot commented Jun 13, 2024

Copy link
Contributor

@kumarabhi006 kumarabhi006 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the test can be modified to iterate for all installed LAFs.

try {
Robot robot = new Robot();
SwingUtilities.invokeAndWait(() -> {
frame = new JFrame();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Frame title can be added.

robot.delay(1000);

SwingUtilities.invokeAndWait(() -> {
loc = leftOneTouchButton.getLocationOnScreen();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran the test on ubuntu 22.04, test failed with IllegalComponentStateException: component must be showing on the screen to determine its location for GTK L&F.
There is no such touch button available for JSplitPane divider.
May skip testing for GTK.

JSplitPane_GTK

new JButton("Left"),
new JButton("Right"));

frame.getContentPane().add(jsp);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
frame.getContentPane().add(jsp);
frame.add(jsp);

Copy link
Contributor

@kumarabhi006 kumarabhi006 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran the test with suggested fix. Looks good to me.

@Override
public void setEnabled(boolean enabled) {
super.setEnabled(enabled);
((BasicSplitPaneUI)(this.getUI())).getDivider().setEnabled(enabled);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it fine to assume that the UI is a BasicSplitPaneUI object? what happens if the JSplitPane UI is an AquaSplitPaneUI for example?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All L&F including Aqua extends BasicSplitPaneUI so it's ok...The existing test iterates through all L&F without any issue..

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All L&F including Aqua extends BasicSplitPaneUI so it's ok...The existing test iterates through all L&F without any issue..

That is true, yet it is still possible to set a L&F that doesn't extend BasicSplitPaneUI and the updated code will throw ClassCastException.

I'm sure such a situation is rare, if it exists at all, yet I don't think the public API should have such a limitation: JSplitPane.setUI accepts SplitPaneUI, so it is valid to pass an object that is not subclass of BasicSplitPaneUI.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok...Will add check..

@Override
public void setEnabled(boolean enabled) {
super.setEnabled(enabled);
((BasicSplitPaneUI)(this.getUI())).getDivider().setEnabled(enabled);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All L&F including Aqua extends BasicSplitPaneUI so it's ok...The existing test iterates through all L&F without any issue..

That is true, yet it is still possible to set a L&F that doesn't extend BasicSplitPaneUI and the updated code will throw ClassCastException.

I'm sure such a situation is rare, if it exists at all, yet I don't think the public API should have such a limitation: JSplitPane.setUI accepts SplitPaneUI, so it is valid to pass an object that is not subclass of BasicSplitPaneUI.

Comment on lines 98 to 100
robot.mouseMove(loc.x, loc.y);
robot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it enough to verify the state of the buttons whether they're enabled or not. It should be simpler, it could be done without rendering the frame.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok..modified to just check for button state...

Comment on lines 79 to 82
jsp.setUI(new TestSplitPaneUI());
jsp.setOneTouchExpandable(true);

jsp.setEnabled(false);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be simpler, it could be done without rendering the frame.

I'm pretty sure it could be done without creating a frame and without showing the frame:

Suggested change
jsp.setUI(new TestSplitPaneUI());
jsp.setOneTouchExpandable(true);
jsp.setEnabled(false);
jsp.setUI(new TestSplitPaneUI());
jsp.setOneTouchExpandable(true);
jsp.setEnabled(false);
if (leftOneTouchButton.isEnabled()) {
throw new RuntimeException("leftButton is enabled for disabled JSplitPane");
}
if (rightOneTouchButton.isEnabled()) {
throw new RuntimeException("rightButton is enabled for disabled JSplitPane");
}

Calling jsp.setEnabled(false); changes the state of the buttons immediately, doesn't it?

@prsadhuk
Copy link
Contributor Author

I guess modified PR will solve the problem you reported...

Copy link
Member

@aivanov-jdk aivanov-jdk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now, except for a couple of minor comments.

@@ -60,46 +57,27 @@ private static void setLookAndFeel(UIManager.LookAndFeelInfo laf) {
}

public static void main(String[] args) throws Exception {
Robot robot = new Robot();
for (UIManager.LookAndFeelInfo laf : UIManager.getInstalledLookAndFeels()) {
if (laf.getClassName().toLowerCase().contains("gtk")) {
continue;
}
System.out.println("Testing LAF : " + laf.getClassName());
SwingUtilities.invokeAndWait(() -> setLookAndFeel(laf));
Copy link
Member

@aivanov-jdk aivanov-jdk Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The setLookAndFeel(laf) can be moved into the main invokeAndWait block.

Comment on lines 45 to 46
private static JSplitPane jsp;
private static volatile boolean btnEnabled;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both jsp and btnEnabled are unused now.

/*
* @test
* @bug 5021949
* @key headful
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please verify if the updated test still requires headful environment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jun 26, 2024
@prsadhuk
Copy link
Contributor Author

prsadhuk commented Jul 2, 2024

/integrate

@openjdk
Copy link

openjdk bot commented Jul 2, 2024

Going to push as commit 5fe07b3.
Since your change was applied there have been 237 commits pushed to the master branch:

  • ee4720a: 8333306: gc/arguments/TestParallelGCErgo.java fails when largepage are enabled
  • 2f4f6cc: 8317721: RISC-V: Implement CRC32 intrinsic
  • 3ca2bcd: 8335060: ClassCastException after JDK-8294960
  • 747e1e4: 8334295: CTW: update modules
  • 0a6ffa5: 8261242: [Linux] OSContainer::is_containerized() returns true when run outside a container
  • 71e3798: 8335308: compiler/uncommontrap/DeoptReallocFailure.java times out with SerialGC on Windows
  • c7e9ebb: 8331732: [PPC64] Unify and optimize code which converts != 0 to 1
  • 53242cd: 8335283: Build failure due to 'no_sanitize' attribute directive ignored
  • d9bcf06: 8335217: Fix memory ordering in ClassLoaderData::ChunkedHandleList
  • bb18498: 8335349: jcmd VM.classloaders "fold" option should be optional
  • ... and 227 more: https://git.openjdk.org/jdk/compare/3a01b47ac97714608356ce3faf797c37dc63e9af...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Jul 2, 2024
@openjdk openjdk bot closed this Jul 2, 2024
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jul 2, 2024
@openjdk
Copy link

openjdk bot commented Jul 2, 2024

@prsadhuk Pushed as commit 5fe07b3.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@prsadhuk prsadhuk deleted the JDK-5021949 branch July 2, 2024 03:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client client-libs-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

4 participants