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
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/java.desktop/share/classes/javax/swing/JSplitPane.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2023, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -41,6 +41,7 @@
import javax.accessibility.AccessibleStateSet;
import javax.accessibility.AccessibleValue;
import javax.swing.plaf.SplitPaneUI;
import javax.swing.plaf.basic.BasicSplitPaneUI;

/**
* <code>JSplitPane</code> is used to divide two (and only two)
@@ -361,6 +362,15 @@ public JSplitPane(int newOrientation,

}

/**
* {@inheritDoc}
* @param enabled {@inheritDoc}
*/
@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..

}

/**
* Sets the L&amp;F object that renders this component.
@@ -575,7 +585,6 @@ public void setOneTouchExpandable(boolean newValue) {
repaint();
}


/**
* Gets the <code>oneTouchExpandable</code> property.
*
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 1997, 2023, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1997, 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -360,6 +360,20 @@ else if (e.getPropertyName() == JSplitPane.
}
}

/**
* {@inheritDoc}
* @param enabled {@inheritDoc}
*/
@Override
public void setEnabled(boolean enabled) {
if (splitPane.isOneTouchExpandable() &&
rightButton != null &&
leftButton != null) {

rightButton.setEnabled(enabled);
leftButton.setEnabled(enabled);
}
}

/**
* Paints the divider.
129 changes: 129 additions & 0 deletions test/jdk/javax/swing/JSplitPane/TestSplitPaneEnableTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
/*
* Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/

/*
* @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.

* @summary Verifies JSplitPane setEnabled(false) disables one touch expandable clicks
* @run main TestSplitPaneEnableTest
*/

import java.awt.Point;
import java.awt.Robot;
import java.awt.event.InputEvent;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JSplitPane;
import javax.swing.plaf.basic.BasicSplitPaneDivider;
import javax.swing.plaf.basic.BasicSplitPaneUI;
import javax.swing.SwingUtilities;

public class TestSplitPaneEnableTest {
private static JButton leftOneTouchButton;
private static JButton rightOneTouchButton;
private static JFrame frame;
private static JSplitPane jsp;
private static volatile Point loc;
private static volatile int prevDivLoc;
private static volatile int curDivLoc;

public static void main(String[] args) throws Exception {
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.

jsp = new JSplitPane(JSplitPane.HORIZONTAL_SPLIT,
new JButton("Left"),
new JButton("Right"));

frame.getContentPane().add(jsp);
jsp.setUI(new TestSplitPaneUI());
jsp.setOneTouchExpandable(true);

jsp.setEnabled(false);

frame.setSize(400, 200);
frame.setLocationRelativeTo(null);
frame.setVisible(true);
});

robot.waitForIdle();
robot.delay(1000);

SwingUtilities.invokeAndWait(() -> {
loc = leftOneTouchButton.getLocationOnScreen();
prevDivLoc = jsp.getDividerLocation();
});
robot.mouseMove(loc.x, loc.y);
robot.mousePress(InputEvent.BUTTON1_DOWN_MASK);
robot.mouseRelease(InputEvent.BUTTON1_DOWN_MASK);

robot.waitForIdle();
robot.delay(1000);

SwingUtilities.invokeAndWait(() -> {
curDivLoc = jsp.getDividerLocation();
});
System.out.println("current Divider location " + curDivLoc);
if (curDivLoc != prevDivLoc) {
throw new RuntimeException("Divider position changed on disabled oneTouchExpandable arrow click");
}
} finally {
SwingUtilities.invokeAndWait(() -> {
if (frame != null) {
frame.dispose();
}
});
}
}

static class TestSplitPaneUI extends BasicSplitPaneUI {

public TestSplitPaneUI() {
super();
}

public BasicSplitPaneDivider createDefaultDivider() {
return new TestSplitPaneDivider(this);
}
}

static class TestSplitPaneDivider extends BasicSplitPaneDivider {

public TestSplitPaneDivider(BasicSplitPaneUI ui) {
super(ui);
}

protected JButton createLeftOneTouchButton() {
leftOneTouchButton = super.createLeftOneTouchButton();
return leftOneTouchButton;
}

protected JButton createRightOneTouchButton() {
rightOneTouchButton = super.createRightOneTouchButton();
return rightOneTouchButton;
}
}
}