File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\console\ExpandableDetailsNote.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2010-2011, CloudBees, Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson.console;
25
26 import hudson.Extension;
27 import hudson.MarkupText;
28
29 import java.io.IOException;
30 import java.util.logging.Level;
31 import java.util.logging.Logger;
32
33 /**
34 * Renders a button that can be clicked to reveal additional block tag (and HTML inside it.)
35 *
36 * <p>
37 * Useful if you want the user to be able to see additional details.
38 *
39 * @author Kohsuke Kawaguchi
40 * @since 1.395
41 */
42 public class ExpandableDetailsNote extends ConsoleNote {
43 private final String caption;
44 private final String html;
45
46 public ExpandableDetailsNote(String caption, String html) {
47 this.caption = caption;
48 this.html = html;
49 }
50
51 @Override
52 public ConsoleAnnotator annotate(Object context, MarkupText text, int charPos) {
53 text.addMarkup(charPos,
54 "<input type=button value='"+caption+"' class='reveal-expandable-detail'><div class='expandable-detail'>"+html+"</div>");
55 return null;
56 }
57
58 public static String encodeTo(String buttonCaption, String html) {
59 try {
60 return new ExpandableDetailsNote(buttonCaption, html).encode();
61 } catch (IOException e) {
62 // impossible, but don't make this a fatal problem
63 LOGGER.log(Level.WARNING, "Failed to serialize "+HyperlinkNote.class,e);
64 return "";
65 }
66 }
67
68 @Extension
69 public static final class DescriptorImpl extends ConsoleAnnotationDescriptor {
70 public String getDisplayName() {
71 return "Expandable details";
72 }
73 }
74
75 private static final Logger LOGGER = Logger.getLogger(ExpandableDetailsNote.class.getName());
76 }
77