Skip to content

Commit 0395e4e

Browse files
hnshns
committedNov 8, 2021
8276768: Snippet copy feature should use button instead of link
Reviewed-by: prappo
·
JEP-429-branchpoint
1 parent d8b0dee commit 0395e4e

File tree

5 files changed

+70
-70
lines changed

5 files changed

+70
-70
lines changed
 

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -447,13 +447,14 @@ protected Content snippetTagOutput(Element element, SnippetTree tag, StyledText
447447
String copyText = resources.getText("doclet.Copy_snippet_to_clipboard");
448448
String copiedText = resources.getText("doclet.Copied_snippet_to_clipboard");
449449
HtmlTree snippetContainer = HtmlTree.DIV(HtmlStyle.snippetContainer,
450-
HtmlTree.A("#", new HtmlTree(TagName.IMG)
450+
new HtmlTree(TagName.BUTTON)
451+
.add(HtmlTree.SPAN(Text.of(copyText))
452+
.put(HtmlAttr.DATA_COPIED, copiedText))
453+
.add(new HtmlTree(TagName.IMG)
451454
.put(HtmlAttr.SRC, htmlWriter.pathToRoot.resolve(DocPaths.CLIPBOARD_SVG).getPath())
452455
.put(HtmlAttr.ALT, copyText))
453456
.addStyle(HtmlStyle.snippetCopy)
454-
.put(HtmlAttr.ONCLICK, "copySnippet(this)")
455-
.put(HtmlAttr.ARIA_LABEL, copyText)
456-
.put(HtmlAttr.DATA_COPIED, copiedText));
457+
.put(HtmlAttr.ONCLICK, "copySnippet(this)"));
457458
return snippetContainer.add(pre.add(code));
458459
}
459460

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/script.js

+12-7
Original file line numberDiff line numberDiff line change
@@ -106,19 +106,24 @@ function indexFilesLoaded() {
106106
&& tagSearchIndex;
107107
}
108108

109-
function copySnippet(link) {
109+
function copySnippet(button) {
110110
var textarea = document.createElement("textarea");
111111
textarea.style.height = 0;
112112
document.body.appendChild(textarea);
113-
textarea.value = link.nextElementSibling.innerText;
113+
textarea.value = button.nextElementSibling.innerText;
114114
textarea.select();
115115
document.execCommand("copy");
116116
document.body.removeChild(textarea);
117-
link.classList.add("copied");
118-
var parent = link.parentElement;
119-
parent.onmouseleave = parent.ontouchend = function() {
120-
link.classList.remove("copied");
121-
};
117+
var span = button.firstElementChild;
118+
var copied = span.getAttribute("data-copied");
119+
if (span.innerHTML !== copied) {
120+
var initialLabel = span.innerHTML;
121+
span.innerHTML = copied;
122+
var parent = button.parentElement;
123+
parent.onmouseleave = parent.ontouchend = function() {
124+
span.innerHTML = initialLabel;
125+
};
126+
}
122127
}
123128

124129
// Workaround for scroll position not being included in browser history (8249133)

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/stylesheet.css

+24-30
Original file line numberDiff line numberDiff line change
@@ -936,62 +936,56 @@ pre.snippet {
936936
div.snippet-container {
937937
position: relative;
938938
}
939-
a.snippet-copy {
939+
button.snippet-copy {
940940
position: absolute;
941-
top: 8px;
942-
right: 8px;
941+
top: 6px;
942+
right: 6px;
943+
height: 1.7em;
944+
opacity: 50%;
945+
transition: opacity 0.2s;
946+
padding: 2px;
947+
border: none;
948+
cursor: pointer;
949+
background: none;
943950
}
944-
a.snippet-copy img {
951+
button.snippet-copy img {
945952
width: 18px;
946953
height: 18px;
947954
padding: 0.05em 0;
948-
opacity: 50%;
949-
transition: opacity 0.2s;
955+
background: none;
950956
}
951-
div.snippet-container:hover a.snippet-copy img {
957+
div.snippet-container:hover button.snippet-copy {
952958
opacity: 80%;
953959
}
954-
div.snippet-container a.snippet-copy:hover img {
955-
opacity: 100%;
956-
}
957-
a.snippet-copy:active img {
958-
background: #d3d3d3;
960+
div.snippet-container button.snippet-copy:hover {
959961
opacity: 100%;
960962
}
961-
a.snippet-copy::before {
963+
button.snippet-copy span {
962964
color: #3d3d3d;
963965
content: attr(aria-label);
964966
font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
965967
font-size: 85%;
966968
line-height: 1.2em;
967969
padding: 0.2em;
968-
position: absolute;
969-
opacity: 80%;
970-
transition: opacity 0.2s;
970+
position: relative;
971971
white-space: nowrap;
972-
top: -0.01em;
973-
right: 1.5em;
972+
top: -0.5em;
974973
display: none;
975974
}
976-
div.snippet-container:hover a.snippet-copy::before {
977-
display: inherit;
975+
div.snippet-container:hover button.snippet-copy span {
976+
display: inline;
978977
}
979-
div.snippet-container a.snippet-copy:hover::before {
978+
button.snippet-copy:active {
979+
background: #d3d3d3;
980980
opacity: 100%;
981981
}
982-
a.snippet-copy.copied::before {
983-
content: attr(data-copied);
984-
}
985-
a.snippet-copy:active::before {
986-
background-color: #dadada;
987-
}
988982
@media screen and (max-width: 800px) {
989983
pre.snippet {
990984
padding-top: 26px;
991985
}
992-
a.snippet-copy {
993-
top: 6px;
994-
right: 6px;
986+
button.snippet-copy {
987+
top: 4px;
988+
right: 4px;
995989
}
996990
}
997991
pre.snippet .italic {

‎test/langtools/jdk/javadoc/doclet/testSnippetTag/TestSnippetTag.java

+27-27
Original file line numberDiff line numberDiff line change
@@ -224,9 +224,9 @@ public String langAttribute() {
224224
<span class="element-name">case%s</span>()</div>
225225
<div class="block">A method.
226226
\s
227-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="cop\
228-
ySnippet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.sv\
229-
g" alt="Copy"></a>
227+
<div class="snippet-container"><button class="snippet-copy" onclick="copySni\
228+
ppet(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" al\
229+
t="Copy"></button>
230230
<pre class="snippet"%s><code%s> Hello, Snippet!
231231
</code></pre>
232232
</div>
@@ -948,9 +948,9 @@ record TestCase(String input, String expectedOutput) { }
948948
"""
949949
<span class="element-name">case%s</span>()</div>
950950
<div class="block">
951-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="cop\
952-
ySnippet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.sv\
953-
g" alt="Copy"></a>
951+
<div class="snippet-container"><button class="snippet-copy" onclick="copySni\
952+
ppet(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" al\
953+
t="Copy"></button>
954954
<pre class="snippet"><code>%s</code></pre>
955955
</div>""".formatted(id, t.expectedOutput()));
956956
});
@@ -1044,9 +1044,9 @@ record TestCase(String input, Function<String, String> expectedTransformation) {
10441044
"""
10451045
<span class="element-name">case%s</span>()</div>
10461046
<div class="block">
1047-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="cop\
1048-
ySnippet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.sv\
1049-
g" alt="Copy"></a>
1047+
<div class="snippet-container"><button class="snippet-copy" onclick="copySni\
1048+
ppet(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" al\
1049+
t="Copy"></button>
10501050
<pre class="snippet"><code>%s</code></pre>
10511051
</div>""".formatted(index, expectedOutput));
10521052
});
@@ -1605,9 +1605,9 @@ record TestCase(Snippet snippet, String expectedOutput) { }
16051605
"""
16061606
<span class="element-name">case%s</span>()</div>
16071607
<div class="block">
1608-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="cop\
1609-
ySnippet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.sv\
1610-
g" alt="Copy"></a>
1608+
<div class="snippet-container"><button class="snippet-copy" onclick="copySni\
1609+
ppet(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" al\
1610+
t="Copy"></button>
16111611
<pre class="snippet"><code>%s</code></pre>
16121612
</div>""".formatted(index, t.expectedOutput()));
16131613
});
@@ -1722,18 +1722,18 @@ public void testAttributeValueSyntaxCurly(Path base) throws Exception {
17221722
"""
17231723
<span class="element-name">case0</span>()</div>
17241724
<div class="block">
1725-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="copySni\
1726-
ppet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.svg" alt="\
1727-
Copy"></a>
1725+
<div class="snippet-container"><button class="snippet-copy" onclick="copySnippet\
1726+
(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" alt="Copy"\
1727+
></button>
17281728
<pre class="snippet"><code></code></pre>
17291729
</div>""");
17301730
checkOutput("pkg/A.html", true,
17311731
"""
17321732
<span class="element-name">case1</span>()</div>
17331733
<div class="block">
1734-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="copySni\
1735-
ppet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.svg" alt="\
1736-
Copy"></a>
1734+
<div class="snippet-container"><button class="snippet-copy" onclick="copySnippet\
1735+
(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" alt="Copy"\
1736+
></button>
17371737
<pre class="snippet"><code></code></pre>
17381738
</div>""");
17391739
}
@@ -1832,9 +1832,9 @@ public void testAttributeValueSyntax(Path base) throws Exception {
18321832
"""
18331833
<span class="element-name">case%s</span>()</div>
18341834
<div class="block">
1835-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="cop\
1836-
ySnippet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.sv\
1837-
g" alt="Copy"></a>
1835+
<div class="snippet-container"><button class="snippet-copy" onclick="copySni\
1836+
ppet(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" al\
1837+
t="Copy"></button>
18381838
<pre class="snippet"><code>2</code></pre>
18391839
</div>
18401840
""".formatted(j));
@@ -1916,9 +1916,9 @@ record TestCase(Snippet snippet, String expectedOutput) { }
19161916
"""
19171917
<span class="element-name">case%s</span>()</div>
19181918
<div class="block">
1919-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="cop\
1920-
ySnippet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.sv\
1921-
g" alt="Copy"></a>
1919+
<div class="snippet-container"><button class="snippet-copy" onclick="copySni\
1920+
ppet(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" al\
1921+
t="Copy"></button>
19221922
<pre class="snippet"><code>%s</code></pre>
19231923
</div>""".formatted(index, t.expectedOutput()));
19241924
});
@@ -2248,9 +2248,9 @@ record TestCase(Snippet snippet, String expectedOutput) { }
22482248
"""
22492249
<span class="element-name">case%s</span>()</div>
22502250
<div class="block">
2251-
<div class="snippet-container"><a href="#" class="snippet-copy" onclick="cop\
2252-
ySnippet(this)" aria-label="Copy" data-copied="Copied!"><img src="../copy.sv\
2253-
g" alt="Copy"></a>
2251+
<div class="snippet-container"><button class="snippet-copy" onclick="copySni\
2252+
ppet(this)"><span data-copied="Copied!">Copy</span><img src="../copy.svg" al\
2253+
t="Copy"></button>
22542254
<pre class="snippet"><code>%s</code></pre>
22552255
</div>""".formatted(index, t.expectedOutput()));
22562256
});

‎test/langtools/jdk/javadoc/lib/javadoc/tester/LinkChecker.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ void addID(int line, String name) {
351351

352352
void addReference(String name, Path from, int line) {
353353
if (checked) {
354-
if (name != null && !name.isEmpty()) {
354+
if (name != null) {
355355
ID id = map.get(name);
356356
if (id == null || !id.declared) {
357357
error(from, line, "id not found: " + this.name + "#" + name);
@@ -368,7 +368,7 @@ void addReference(String name, Path from, int line) {
368368

369369
void check() {
370370
map.forEach((name, id) -> {
371-
if (name != null && !name.isEmpty() && !id.declared) {
371+
if (name != null && !id.declared) {
372372
//log.error(currFile, 0, "id not declared: " + name);
373373
for (Position ref : id.references) {
374374
error(ref.path, ref.line, "id not found: " + this.name + "#" + name);

0 commit comments

Comments
 (0)
Please sign in to comment.