Skip to content

8367348: Enhance PassFailJFrame to support links in HTML #4106

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

8367348: Enhance PassFailJFrame to support links in HTML #4106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 23 additions & 2 deletions test/jdk/java/awt/regtesthelpers/PassFailJFrame.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
import javax.swing.JTextArea;
import javax.swing.Timer;
import javax.swing.border.Border;
import javax.swing.event.HyperlinkListener;
import javax.swing.text.JTextComponent;
import javax.swing.text.html.HTMLEditorKit;
import javax.swing.text.html.StyleSheet;
Expand All @@ -98,7 +99,8 @@
* tester. The instructions can be either plain text or HTML. If the
* text of the instructions starts with {@code "<html>"}, the
* instructions are displayed as HTML, as supported by Swing, which
* provides richer formatting options.
* provides richer formatting options. To handle navigating links in the
* instructions, call {@link Builder#hyperlinkListener} to install a listener.
* <p>
* The instructions are displayed in a text component with word-wrapping
* so that there's no horizontal scroll bar. If the text doesn't fit, a
Expand Down Expand Up @@ -592,6 +594,7 @@ private static void createUI(String title, String instructions,
frame.add(createInstructionUIPanel(instructions,
testTimeOut,
rows, columns,
null,
false,
false, 0),
BorderLayout.CENTER);
Expand All @@ -610,6 +613,7 @@ private static void createUI(Builder builder) {
createInstructionUIPanel(builder.instructions,
builder.testTimeOut,
builder.rows, builder.columns,
builder.hyperlinkListener,
builder.screenCapture,
builder.addLogArea,
builder.logAreaRows);
Expand All @@ -631,6 +635,7 @@ private static void createUI(Builder builder) {
private static JComponent createInstructionUIPanel(String instructions,
long testTimeOut,
int rows, int columns,
HyperlinkListener hyperlinkListener,
boolean enableScreenCapture,
boolean addLogArea,
int logAreaRows) {
Expand All @@ -643,6 +648,9 @@ private static JComponent createInstructionUIPanel(String instructions,
JTextComponent text = instructions.startsWith("<html>")
? configureHTML(instructions, rows, columns)
: configurePlainText(instructions, rows, columns);
if (hyperlinkListener != null && text instanceof JEditorPane ep) {
ep.addHyperlinkListener(hyperlinkListener);
}
text.setEditable(false);
text.setBorder(createTextBorder());
text.setCaretPosition(0);
Expand Down Expand Up @@ -716,7 +724,7 @@ private static JTextComponent configureHTML(String instructions,
// Reduce the list default margins
styles.addRule("ol, ul { margin-left-ltr: 30; margin-left-rtl: 30 }");
// Make the size of code (and other elements) the same as other text
styles.addRule("code, kbd, samp, pre { font-size: inherit }");
styles.addRule("code, kbd, samp, pre { font-size: inherit; background: #DDD; }");

return text;
}
Expand Down Expand Up @@ -1398,6 +1406,7 @@ public static final class Builder {
private int rows;
private int columns;
private boolean screenCapture;
private HyperlinkListener hyperlinkListener;
private boolean addLogArea;
private int logAreaRows = 10;

Expand Down Expand Up @@ -1478,6 +1487,18 @@ public Builder columns(int columns) {
return this;
}

/**
* Sets a {@link HyperlinkListener} for navigating links inside
* the instructions pane.
*
* @param hyperlinkListener the listener
* @return this builder
*/
public Builder hyperlinkListener(HyperlinkListener hyperlinkListener) {
this.hyperlinkListener = hyperlinkListener;
return this;
}

public Builder screenCapture() {
this.screenCapture = true;
return this;
Expand Down