JDK-7036669 : Simplify revalidating component hierarchy with multiple validate roots
  • Type: Enhancement
  • Component: client-libs
  • Sub-Component: java.awt
  • Affected Version: 7
  • Priority: P2
  • Status: Closed
  • Resolution: Fixed
  • OS: generic
  • CPU: generic
  • Submitted: 2011-04-14
  • Updated: 2017-05-16
  • Resolved: 2011-05-17
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 7
7 b142Fixed
Related Reports
Relates :  
JDK-7037453 - Clarify specification for Component.revalidate() and other validity- and mixing-related methods
Relates :  
JDK-6973780 - JCK manual case JTextFieldTests.html#JTextField fails in jdk7 b100
Relates :  
JDK-6907705 - fixing - #6852592: "invalidate() must be smarter" revealed problem with JTree
Relates :  
JDK-6852592 - invalidate() must be smarter
Description
6907705 reveals a failing JCK test. The JTextField.setColumns() method doesn't update the JTextField size.

After discussing this issue with Swing and AWT teams, it is clear that a fix for 6852592 is slightly incomplete. The fix introduces 'validate roots' concept in AWT - containers on which the invalidate() operation stops. However, it doesn't provide a way for the developer to quickly identify a validate root, so that a subsequent validate() method call could be performed on the correct component (i.e. the nearest validate root).

Swing already has a method JComponent.revalidate() which does just that. And 6907705 could be fixed by calling revalidate() on the parent of the JTextField. However, since JComponent.getContainer() returns a Container, and the JTextField could be placed in a non-Swing container, we can't simply use the revalidate() Swing machinery.

This RFE proposes to implement the Component.revalidate() method.
Comments
SUGGESTED FIX --- old/src/share/classes/java/awt/Component.java 2011-04-19 14:38:43.000000000 +0400 +++ new/src/share/classes/java/awt/Component.java 2011-04-19 14:38:43.000000000 +0400 @@ -2945,6 +2945,46 @@ } /** + * Revalidates the component hierarchy up to the nearest validate root. + * <p> + * This method first invalidates the component hierarchy starting from this + * component up to the nearest validate root. Afterwards, the component + * hierarchy is validated starting from the nearest validate root. + * <p> + * This is a convenience method supposed to help application developers + * avoid looking for validate roots manually. Basically, it's equivalent to + * first calling the {@link #invalidate()} method on this component, and + * then calling the {@link #validate()} method on the nearest validate + * root. + * + * @see Container#isValidateRoot + * @since 1.7 + */ + public void revalidate() { + synchronized (getTreeLock()) { + invalidate(); + + Container root = getContainer(); + if (root == null) { + // There's no parents. Just validate itself. + validate(); + } else { + while (!root.isValidateRoot()) { + if (root.getContainer() == null) { + // If there's no validate roots, we'll validate the + // topmost container + break; + } + + root = root.getContainer(); + } + + root.validate(); + } + } + } + + /** * Creates a graphics context for this component. This method will * return <code>null</code> if this component is currently not * displayable. --- old/src/share/classes/javax/swing/plaf/basic/BasicSplitPaneDivider.java 2011-04-19 14:38:45.000000000 +0400 +++ new/src/share/classes/javax/swing/plaf/basic/BasicSplitPaneDivider.java 2011-04-19 14:38:45.000000000 +0400 @@ -154,7 +154,7 @@ setBackground(UIManager.getColor("SplitPane.background")); } - private void revalidate() { + private void revalidateSplitPane() { invalidate(); if (splitPane != null) { splitPane.revalidate(); @@ -315,7 +315,7 @@ setCursor((orientation == JSplitPane.HORIZONTAL_SPLIT) ? Cursor.getPredefinedCursor(Cursor.E_RESIZE_CURSOR) : Cursor.getPredefinedCursor(Cursor.S_RESIZE_CURSOR)); - revalidate(); + revalidateSplitPane(); } else if (e.getPropertyName() == JSplitPane. ONE_TOUCH_EXPANDABLE_PROPERTY) { @@ -376,7 +376,7 @@ add(rightButton); } } - revalidate(); + revalidateSplitPane(); } --- /dev/null 2011-04-04 22:09:25.851006711 +0400 +++ new/test/java/awt/Component/Revalidate/Revalidate.java 2011-04-19 14:38:46.000000000 +0400 @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2011, 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 7036669 + @summary Test Component.revalidate() method + @author ###@###.###: area=awt.component + @run main Revalidate +*/ + +import java.awt.*; + +public class Revalidate { + private static Frame frame = new Frame(); + private static Panel panel = new Panel() { + @Override + public boolean isValidateRoot() { + return true; + } + }; + private static Button button = new Button("Test"); + + private static void sleep() { + try { Thread.sleep(500); } catch (Exception e) {} + } + + private static void printState(String str) { + System.out.println(str + " isValid state: "); + System.out.println(" frame: " + frame.isValid()); + System.out.println(" panel: " + panel.isValid()); + System.out.println(" button: " + button.isValid()); + } + + private static void fail(String msg) { + frame.dispose(); + throw new RuntimeException(msg); + } + + private static void check(String n, Component c, boolean v) { + if (c.isValid() != v) { + fail(n + ".isValid() = " + c.isValid() + "; expected: " + v); + } + } + private static void check(String str, boolean f, boolean p, boolean b) { + printState(str); + + check("frame", frame, f); + check("panel", panel, p); + check("button", button, b); + } + + public static void main(String[] args) { + // setup + frame.add(panel); + panel.add(button); + frame.setBounds(200, 200, 300, 200); + frame.setVisible(true); + sleep(); + check("Upon showing", true, true, true); + + button.setBounds(1, 1, 30, 30); + sleep(); + check("button.setBounds():", true, false, false); + + button.revalidate(); + sleep(); + check("button.revalidate():", true, true, true); + + button.setBounds(1, 1, 30, 30); + sleep(); + check("button.setBounds():", true, false, false); + + panel.revalidate(); + sleep(); + // because the panel's validate root is actually OK + check("panel.revalidate():", true, false, false); + + button.revalidate(); + sleep(); + check("button.revalidate():", true, true, true); + + panel.setBounds(2, 2, 125, 130); + sleep(); + check("panel.setBounds():", false, false, true); + + button.revalidate(); + sleep(); + check("button.revalidate():", false, true, true); + + panel.setBounds(3, 3, 152, 121); + sleep(); + check("panel.setBounds():", false, false, true); + + panel.revalidate(); + sleep(); + check("panel.revalidate():", true, true, true); + + // cleanup + frame.dispose(); + } +}
19-04-2011
EVALUATION The Component.revalidate() method should: 1. Call invalidate(); 2. Traverse the hierarchy up to the nearest validate root and call the validate() method on it.
14-04-2011