Package de.hsh.graja.util.comment

Class Paragraph

java.lang.Object

de.hsh.graja.util.comment.Content

de.hsh.graja.util.comment.AbstractSequenceContent

de.hsh.graja.util.comment.Sequence

de.hsh.graja.util.comment.Paragraph

All Implemented Interfaces:

ContentLogger, Serializable

public class Paragraph
extends Sequence

This content is rendered as a paragraph. A subsequent content will begin after a line break and (depending on the renderer) after some vertical distance. A Paragraph serves as a container for several Contents that have Content.isInlineContent() returning true.

Usage example:

        Sequence sq= new Sequence();
  Paragraph para= new Paragraph(Inline.format(includeSpec, 
             "Expected return value from '%s': %f. Observed: %f.", avgMethodName, expected, observed)));
  para.formatInlineItem(includeSpec, FontWeightAndStyle.smaller(), " Here comes some debug information ...");
  sq.addItem(para);

See Also:

• Serialized Form

Field Summary

Fields inherited from class de.hsh.graja.util.comment.Content

EXCLUSIVE, renderUuid

Constructor Summary

Constructors

Constructor	Description
Paragraph()	Create an empty paragraph.
Paragraph(IncludeSpec includeSpec, String firstInlineData)	Create a paragraph with a first inline content with normal font style.
Paragraph(IncludeSpec includeSpec, String firstInlineData, FontWeightAndStyle fwas)	Create a paragraph with a first inline content with given font style.
Paragraph(Inline firstInline)	Create a paragraph with a first inline content.

Method Summary

Modifier and Type	Method	Description
void	addItem(Content content)	Adds an inline content or a line break to the paragraph.
void	formatInlineItem(IncludeSpec includeSpec, FontWeightAndStyle fwas, String format, Object... args)	Add another inline content to the end of the paragraph.
void	formatInlineItem(IncludeSpec includeSpec, String format, Object... args)	Add another inline content to the end of the paragraph.
void	newLine(IncludeSpec includeSpec)	Add a line break.
void	renderHtmlImpl(StringBuilder sb, IncludeInfo includeInfo, RenderContext ctx, boolean useJavascript)	appends all comments in the sequence one after the other without any visual marks between the individual items.
void	renderPlainImpl(StringBuilder sb, IncludeInfo includeInfo, RenderContext ctx)	appends all comments in the sequence one after the other without any visual marks between the individual items.
static List<Content>	surroundParagraphIfNeededAndPossible(Iterable<Content> comments)	Finds successive Content items in comments each returning {code true} from and puts these together in one or more surrounding {@link Paragraph} items.
String	toString(String prefix)	This method is for debugging purposes.

Methods inherited from class de.hsh.graja.util.comment.Sequence

addItems, clear, equals, formatAsInlineNewlineSeq, getNestedContents, hashCode, size

Methods inherited from class de.hsh.graja.util.comment.AbstractSequenceContent

isInlineContent

Methods inherited from class de.hsh.graja.util.comment.Content

click, dehighlight, disableCallerStacktraceRecording, enableCallerStacktraceRecording, excludeGlobally, getIncludeSpec, getRenderUuid, getStackdump, hide, highlight, include, isCallerStacktraceRecordingEnabled, isHidden, isShowing, onClick, onClick, onHide, onHide, onLoad, onLoad, onShow, onShow, registerCallable, renderHtml, renderHtml, renderIdAttribute, renderJavascriptOncePerClass, renderOnClickAttribute, renderPlain, renderPlain, setGlobalIncludeInfo, setHref, setIncludeSpec, show, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Paragraph

public Paragraph()

Create an empty paragraph.

Paragraph

public Paragraph(IncludeSpec includeSpec,
 String firstInlineData)

Create a paragraph with a first inline content with normal font style.

Parameters:

includeSpec - the include spec of the first inline content

firstInlineData - the text of the first inline content

Paragraph

public Paragraph(IncludeSpec includeSpec,
 String firstInlineData,
 FontWeightAndStyle fwas)

Create a paragraph with a first inline content with given font style.

Parameters:

includeSpec - the include Spec of the first inline content

firstInlineData - the text of the first inline content

fwas - the font of the first inline content

Paragraph

public Paragraph(Inline firstInline)

Create a paragraph with a first inline content.

Parameters:

firstInline - the first inline content

Method Details

addItem

public void addItem(Content content)

Adds an inline content or a line break to the paragraph. If the item is globally excluded (see AbstractSequenceContent#excludeGlobally(Content), then the item is not added and ignored.

Specified by:

addItem in interface ContentLogger

Overrides:

addItem in class Sequence

Parameters:

content - content to be added. This must be an instance of Content return true from Content.isInlineContent(). Otherwise an exception is thrown.

Throws:

IllegalArgumentException - if the parameter is not an instance of Content returning true from Content.isInlineContent()

formatInlineItem

public void formatInlineItem(IncludeSpec includeSpec,
 String format,
 Object... args)

Add another inline content to the end of the paragraph.

Parameters:

includeSpec - the include Spec of the additional inline content

format - a format string as defined by Formatter.format(String, Object...).

args - arguments as expected by Formatter.format(String, Object...).

formatInlineItem

public void formatInlineItem(IncludeSpec includeSpec,
 FontWeightAndStyle fwas,
 String format,
 Object... args)

Add another inline content to the end of the paragraph.

Parameters:

includeSpec - the include spec of the additional inline content

fwas - a font specification

format - a format string as defined by Formatter.format(String, Object...).

args - arguments as expected by Formatter.format(String, Object...).

newLine

public void newLine(IncludeSpec includeSpec)

Add a line break.

Parameters:

includeSpec - the include spec for the line break

toString

public String toString(String prefix)

Description copied from class: Content

This method is for debugging purposes.

Overrides:

toString in class Content

Parameters:

prefix - If the output has multiple lines, prefix specifies the indentation of the subsequent lines.

Returns:

a string representation of the content and it's internal structure.

See Also:

• Content.toString(java.lang.String)

renderHtmlImpl

public void renderHtmlImpl(StringBuilder sb,
 IncludeInfo includeInfo,
 RenderContext ctx,
 boolean useJavascript)

Description copied from class: Sequence

appends all comments in the sequence one after the other without any visual marks between the individual items.

Overrides:

renderHtmlImpl in class Sequence

Parameters:

sb - HTML code result

includeInfo - controls, which content to be rendered.

ctx - render context

useJavascript - if true, the generated HTML code will contain Javascript

See Also:

• Content#renderHtmlImpl(StringBuilder, IncludeInfo, RenderContext)

renderPlainImpl

public void renderPlainImpl(StringBuilder sb,
 IncludeInfo includeInfo,
 RenderContext ctx)

Description copied from class: Sequence

appends all comments in the sequence one after the other without any visual marks between the individual items.

Overrides:

renderPlainImpl in class Sequence

Parameters:

sb - plain text result

includeInfo - controls, which content to be rendered.

ctx - render context (unused).

See Also:

• Content.renderPlainImpl(StringBuilder, IncludeInfo, RenderContext)

surroundParagraphIfNeededAndPossible

public static List<Content> surroundParagraphIfNeededAndPossible(Iterable<Content> comments)

Finds successive Content items in comments each returning {code true} from and puts these together in one or more surrounding {@link Paragraph} items.

Parameters:

comments -

Returns: