Package org.jvnet.hudson.plugins.collapsingconsolesections

Class CollapsingSectionNote

java.lang.Object

hudson.console.ConsoleNote

org.jvnet.hudson.plugins.collapsingconsolesections.CollapsingSectionNote

All Implemented Interfaces:

ExtensionPoint, Describable, Serializable

public class CollapsingSectionNote
extends ConsoleNote

Author:

dty

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CollapsingSectionNote.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.console.ConsoleNote

INSECURE, POSTAMBLE, POSTAMBLE_STR, PREAMBLE, PREAMBLE_STR

Constructor Summary

Constructors

Constructor	Description
CollapsingSectionNote(String sectionDisplayName, String sectionStartPattern, String sectionEndPattern, boolean collapseOnlyOneLevel)	Deprecated.
CollapsingSectionNote(String sectionDisplayName, String sectionStartPattern, String sectionEndPattern, boolean collapseOnlyOneLevel, boolean collapseSection)

Method Summary

Modifier and Type	Method	Description
ConsoleAnnotator	annotate(Object context, MarkupText text, int charPos)
SectionDefinition	getDefinition()
String	getSectionDisplayName()
String	getSectionEndPattern()
String	getSectionStartPattern()
boolean	isCollapseOnlyOneLevel()
boolean	isCollapseSection()	Check if the section should be collapsed by default.

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 Details

CollapsingSectionNote

@DataBoundConstructor
public CollapsingSectionNote(@Nonnull
 String sectionDisplayName,
 @Nonnull
 String sectionStartPattern,
 @Nonnull
 String sectionEndPattern,
 boolean collapseOnlyOneLevel,
 boolean collapseSection)

CollapsingSectionNote

@Deprecated
public CollapsingSectionNote(String sectionDisplayName,
 String sectionStartPattern,
 String sectionEndPattern,
 boolean collapseOnlyOneLevel)

Deprecated.

Method Details

getSectionDisplayName

@Nonnull
public String getSectionDisplayName()

getSectionStartPattern

@Nonnull
public String getSectionStartPattern()

getSectionEndPattern

@Nonnull
public String getSectionEndPattern()

isCollapseSection

public boolean isCollapseSection()

Check if the section should be collapsed by default.

Returns:

true if the section should be collapsed.

Since:

1.6.0

isCollapseOnlyOneLevel

public boolean isCollapseOnlyOneLevel()

getDefinition

@Nonnull
public SectionDefinition getDefinition()

annotate

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

Specified by:

annotate in class ConsoleNote