Package com.polarion.alm.shared.api.utils.html

Interface HtmlContentBuilder

All Superinterfaces:

HasHtmlBuilderTarget

All Known Subinterfaces:

HtmlFragmentBuilder

public interface HtmlContentBuilder
extends HasHtmlBuilderTarget

Builder for content of html tag, instances are returned by HtmlTagBuilder.append()

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
SharedContext	context()
HtmlFragmentBuilder	createNewFragmentBuilder()	Creates new builder for same target and context, never returns null.
HtmlDecoratedLabelBuilder	decoratedLabel()
HtmlContentBuilder	html(String value)	Caller must ensure that the html is well formatted and encoded, because this method does no validation or encoding.
HtmlContentBuilder	javaScript(String value)
HtmlContentBuilder	nbsp()	Add not break space.
HtmlTagSelector<HtmlTagBuilder>	tag()	Returns selector for appending a child tag, the methods on returned instance can be called multiple times to append multiple children.
HtmlContentBuilder	text(String value)
HtmlContentBuilder	textWithFormatting(String value)

Methods inherited from interface com.polarion.alm.shared.api.utils.html.HasHtmlBuilderTarget

target

Method Details

tag

@NotNull
HtmlTagSelector<HtmlTagBuilder> tag()

Returns selector for appending a child tag, the methods on returned instance can be called multiple times to append multiple children.

Throws:

IllegalStateException - after HtmlTagBuilder.finished() was called.

text

@NotNull
HtmlContentBuilder text(@Nullable
 String value)

Parameters:

value - - un-escaped value, new lines(\n) and other formatting characters are not handled in any way. can be null - when null, than nothing will be appended to result

Throws:

IllegalStateException - after HtmlTagBuilder.finished() was called.

textWithFormatting

@NotNull
HtmlContentBuilder textWithFormatting(@Nullable
 String value)

Parameters:

value - - un-escaped value, new lines(\n) will be replaced with
and other formatting characters will be also handled. Can be null - when null, than nothing will be appended to result

Throws:

IllegalStateException - after HtmlTagBuilder.finished() was called.

javaScript

@NotNull
HtmlContentBuilder javaScript(@Nullable
 String value)

Parameters:

value - - un-escaped java script. can be null - when null, than nothing will be appended to result

Throws:

IllegalStateException - after HtmlTagBuilder.finished() was called.

html

@NotNull
HtmlContentBuilder html(@Nullable
 String value)

Caller must ensure that the html is well formatted and encoded, because this method does no validation or encoding.

Parameters:

value - can be null - when null, than nothing will be appended to result

Throws:

IllegalStateException - after HtmlTagBuilder.finished() was called.

nbsp

@NotNull
HtmlContentBuilder nbsp()

Add not break space.

decoratedLabel

@NotNull
HtmlDecoratedLabelBuilder decoratedLabel()

context

@NotNull
SharedContext context()

createNewFragmentBuilder

@NotNull
HtmlFragmentBuilder createNewFragmentBuilder()

Creates new builder for same target and context, never returns null.