hudson.console
Class ExpandableDetailsNote

java.lang.Object
  hudson.console.ConsoleNote
      hudson.console.ExpandableDetailsNote

All Implemented Interfaces:

ExtensionPoint, Describable, Serializable

public class ExpandableDetailsNote
extends ConsoleNote

Renders a button that can be clicked to reveal additional block tag (and HTML inside it.)

Useful if you want the user to be able to see additional details.

Since:

1.395

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Nested Class Summary

static class

ExpandableDetailsNote.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.console.ConsoleNote

POSTAMBLE, POSTAMBLE_STR, PREAMBLE, PREAMBLE_STR

Constructor Summary

ExpandableDetailsNote(String caption, String html)

Method Summary

ConsoleAnnotator	annotate(Object context, MarkupText text, int charPos) When the line of a console output that this annotation is attached is read by someone, a new ConsoleNote is de-serialized and this method is invoked to annotate that line.
static String	encodeTo(String buttonCaption, String html)

Methods inherited from class hudson.console.ConsoleNote

encode, encodeTo, encodeTo, findPreamble, getDescriptor, readFrom, removeNotes, removeNotes, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExpandableDetailsNote

public ExpandableDetailsNote(String caption,
                             String html)

Method Detail

annotate

public ConsoleAnnotator annotate(Object context,
                                 MarkupText text,
                                 int charPos)

Description copied from class: ConsoleNote

When the line of a console output that this annotation is attached is read by someone, a new ConsoleNote is de-serialized and this method is invoked to annotate that line.

Specified by:

annotate in class ConsoleNote

Parameters:

context - The object that owns the console output in question.

text - Represents a line of the console output being annotated.

charPos - The character position in 'text' where this annotation is attached.

Returns:

if non-null value is returned, this annotator will handle the next line. this mechanism can be used to annotate multiple lines starting at the annotated position.

encodeTo

public static String encodeTo(String buttonCaption,
                              String html)