-
Notifications
You must be signed in to change notification settings - Fork 6.1k
8139228: JFileChooser renders file names as HTML document #24439
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
Conversation
👋 Welcome back tr! A progress list of the required criteria for merging this PR into |
@TejeshR13 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 174 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. ➡️ To integrate this PR with the above commit message to the |
@TejeshR13 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
|
/reviewers 2 |
@aivanov-jdk |
public class HTMLFileName { | ||
static File directory; | ||
public static void main(String[] args) throws Exception { | ||
String INSTRUCTIONS = """ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the windows is skipped?
Don't you need to check all L&F and platforms? as of now you validated metal(default on linux) and aqua(default on mac).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the windows is skipped?
Because it's impossible to create a file with <html>
in the name on Windows.
Don't you need to check all L&F and platforms? as of now you validated metal(default on linux) and aqua(default on mac).
A good point. Validating other L&Fs would be good.
I wonder if the test can be automated, it would make validating all L&F so much easier.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Making an automated test would be difficult, because the text/html is totally OS and L&F dependant. Example without fix in macos the file name will be empty on filepane and in combobox it shows as HTML text. But it doesn't hold the same for other L&F and in linux.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OS or L&F dependant?
macOS uses Aqua by default, Linux uses Metal by default. The behaviour in different L&F could be different.
The test may be customised for a L&F if needed… and it's likely required. I haven't looked into it yet, so I can't suggest anything. Exploring the possibility of making the test automatic is worth the effort.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dependant on L&F I hope.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> Exception in thread "AWT-EventQueue-0" java.nio.file.InvalidPathException: Illegal char <<> at index 0: <html><h1 color=#ff00ff><font face="Comic Sans MS">SWING ROCKS!!!111
> at java.base/sun.nio.fs.WindowsPathParser.normalize(WindowsPathParser.java:191)
> at java.base/sun.nio.fs.WindowsPathParser.parse(WindowsPathParser.java:142)
> at java.base/sun.nio.fs.WindowsPathParser.parse(WindowsPathParser.java:46)
> at java.base/sun.nio.fs.WindowsPath.parse(WindowsPath.java:92)
> at java.base/sun.nio.fs.WindowsFileSystem.getPath(WindowsFileSystem.java:203)
> at java.base/java.nio.file.Path.of(Path.java:148)
> at java.base/java.nio.file.Paths.get(Paths.java:69)
> at java.desktop/sun.awt.shell.ShellFolder.getShellFolder(ShellFolder.java:260)
> at java.desktop/javax.swing.filechooser.FileSystemView.getShellFolder(FileSystemView.java:724)
> at java.desktop/javax.swing.filechooser.FileSystemView.getSystemIcon(FileSystemView.java:242)
> at java.desktop/com.sun.java.swing.plaf.windows.WindowsFileChooserUI$WindowsFileView.getIcon(WindowsFileChooserUI.java:1398)
> at java.desktop/javax.swing.JFileChooser.getIcon(JFileChooser.java:1614)
This exception looks like a bug? I think if the file was not found then null is an expected result.
For now it can be bypassed by this:
import java.io.File;
import java.lang.Override;
import javax.swing.Icon;
import javax.swing.JFileChooser;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.UnsupportedLookAndFeelException;
import javax.swing.filechooser.FileSystemView;
public class VirtualFileChooser {
public static void main(String[] args) throws UnsupportedLookAndFeelException, ClassNotFoundException, InstantiationException, IllegalAccessException {
UIManager.setLookAndFeel("com.sun.java.swing.plaf.windows.WindowsLookAndFeel");
//UIManager.setLookAndFeel("com.sun.java.swing.plaf.windows.WindowsClassicLookAndFeel");
SwingUtilities.invokeLater(() -> {
JFileChooser chooser = new JFileChooser(new VirtualFileSystemView());
int result = chooser.showOpenDialog(null);
if (result == JFileChooser.APPROVE_OPTION) {
File selectedFile = chooser.getSelectedFile();
System.out.println("Selected: " + selectedFile.getAbsolutePath());
}
});
}
static class VirtualFileSystemView extends FileSystemView {
@Override
public File createNewFolder(File containingDir) {
return null;
}
@Override
public File[] getRoots() {
return new File[]{
new File("/", "<html><h1 color=#ff00ff><font face=\"Comic Sans MS\">SWING ROCKS!!!111"),
new File("/", "virtualFile2.txt"),
new File("/", "virtualFolder")
};
}
@Override
public File getHomeDirectory() {
return new File("/");
}
@Override
public File getDefaultDirectory() {
return new File("/");
}
@Override
public File[] getFiles(File dir, boolean useFileHiding) {
// Simulate a virtual folder structure
return new File[]{
new File("/", "<html><h1 color=#ff00ff><font face=\"Comic Sans MS\">SWING ROCKS!!!111"),
new File(dir, "virtualFile2.txt"),
new File(dir, "virtualFolder")
};
}
@Override
public Icon getSystemIcon(File f) {
return null;
}
}
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that the bug occurs both in the list of roots (in the dropdown) and in the list of files.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, thank you for the updated virtual test. I've updated the PR with windows L&F fix and also have updated the test too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mrserb @aivanov-jdk Can u please re-review the updated changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now @mrserb deserves being a co-author.
/reviewers 2 reviewer |
@aivanov-jdk |
src/java.desktop/macosx/classes/com/apple/laf/AquaFileChooserUI.java
Outdated
Show resolved
Hide resolved
public class HTMLFileName { | ||
static File directory; | ||
public static void main(String[] args) throws Exception { | ||
String INSTRUCTIONS = """ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now @mrserb deserves being a co-author.
/integrate |
Going to push as commit 917c154.
Your commit was automatically rebased without conflicts. |
@TejeshR13 Pushed as commit 917c154. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
The rendering of the directory names are handled as JLabel w.r.t Look and feel and also either Details/List view. Though FilePane creates basic rendering for these two few Look and Feel define their own renderers and also ComboBox Directory directory name view. Since HTML filtering is not taken care in any of these renderers, JLabel renders them as HTML document if nothing is set or specified.
The fix is to get "html.disable" property from JFileChooser and set the same to JLabel component which renders and set Directory name. Hence applications can either enable/disable this property and control HTML rendering of directory name.
Progress
Issue
Reviewers
Reviewing
Using
git
Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/24439/head:pull/24439
$ git checkout pull/24439
Update a local copy of the PR:
$ git checkout pull/24439
$ git pull https://git.openjdk.org/jdk.git pull/24439/head
Using Skara CLI tools
Checkout this PR locally:
$ git pr checkout 24439
View PR using the GUI difftool:
$ git pr show -t 24439
Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/24439.diff
Using Webrev
Link to Webrev Comment