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

Interface HtmlAttributesBuilder

public interface HtmlAttributesBuilder

Builder for specifying optional attributes of html tag.

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
HtmlAttributesBuilder	align(String value)	Adds and encodes the value for align attribute.
HtmlAttributesBuilder	booleanAttribute(String name)	Boolean attribute is defined only by name (e.g.
HtmlAttributesBuilder	border(String value)	Adds and encodes the value for border attribute.
HtmlAttributesBuilder	byName(String name, String value)	Adds value for attribute specified by name and encodes the value except when name is "href" or "src" (not case sensitive)
HtmlAttributesBuilder	cellpadding(String value)	Adds and encodes the value for cellpadding attribute.
HtmlAttributesBuilder	cellspacing(String value)	Adds and encodes the value for cellspacing attribute.
HtmlAttributesBuilder	charset(String value)	Adds and encodes the value for charset attribute.
HtmlAttributesBuilder	className(String value)	Adds and encodes the value for class attribute.
HtmlAttributesBuilder	colspan(String value)	Adds and encodes the value for colspan attribute.
HtmlAttributesBuilder	contentNotEditable()
HtmlAttributesBuilder	data(HtmlLink value)
HtmlAttributesBuilder	dleControlSelectCanceling()	Behaves differently for different browsers
HtmlAttributesBuilder	dleEventCanceling()	Behaves differently for different browsers
HtmlAttributesBuilder	height(String value)	Adds and encodes the value for height attribute.
HtmlAttributesBuilder	href(HtmlLink link)
HtmlAttributesBuilder	href(PortalLink link)
HtmlAttributesBuilder	id(String value)	Adds and encodes the value for id attribute.
HtmlAttributesBuilder	javascript()	Adds type="text/javascript" and charset="UTF-8"
HtmlAttributesBuilder	lastKnownIndex(int index)
HtmlAttributesBuilder	name(String value)	Adds and encodes the value for name attribute.
HtmlAttributesBuilder	onClick(String value)
JsMethodInvocationBuilder	onClickMethod()	Creates new builder for Javascript methods invocation
HtmlAttributesBuilder	readOnly()	The read only attribute is a boolean attribute and is property of input element.
HtmlAttributesBuilder	rowspan(String value)	Adds and encodes the value for rowspan attribute.
HtmlAttributesBuilder	src(HtmlLink value)
HtmlAttributesBuilder	start(int start)
HtmlAttributesBuilder	style(String value)	Adds and encodes the value for style attribute.
HtmlAttributesBuilder	target(String value)	Adds and encodes the value for target attribute.
HtmlAttributesBuilder	title(String value)	Adds and encodes the value for title attribute.
HtmlAttributesBuilder	type(String value)	Adds and encodes the value for type attribute.
HtmlAttributesBuilder	width(String value)	Adds and encodes the value for width attribute.

Method Details

id

@NotNull
HtmlAttributesBuilder id(@Nullable
 String value)

Adds and encodes the value for id attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if HtmlTagBuilder.finished() was called before.

IllegalStateException - if this method was already called for this object

className

@NotNull
HtmlAttributesBuilder className(@Nullable
 String value)

Adds and encodes the value for class attribute. If class attribute is already set then class will be appended.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if HtmlTagBuilder.finished() was called before.

style

@NotNull
HtmlAttributesBuilder style(@Nullable
 String value)

Adds and encodes the value for style attribute. If style attribute is already set then style will be appended.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if HtmlTagBuilder.finished() was called before.

href

@NotNull
HtmlAttributesBuilder href(@Nullable
 PortalLink link)

Parameters:

link - can be null - when null then the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

href

@NotNull
HtmlAttributesBuilder href(@Nullable
 HtmlLink link)

Parameters:

link - can be null - when null then the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

target

@NotNull
HtmlAttributesBuilder target(@Nullable
 String value)

Adds and encodes the value for target attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

onClick

@NotNull
HtmlAttributesBuilder onClick(@Nullable
 String value)

Parameters:

value - - already encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

onClickMethod

@NotNull
JsMethodInvocationBuilder onClickMethod()

Creates new builder for Javascript methods invocation

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

Since:

3.10.0

name

@NotNull
HtmlAttributesBuilder name(@Nullable
 String value)

Adds and encodes the value for name attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

title

@NotNull
HtmlAttributesBuilder title(@Nullable
 String value)

Adds and encodes the value for title attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

border

@NotNull
HtmlAttributesBuilder border(@Nullable
 String value)

Adds and encodes the value for border attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

width

@NotNull
HtmlAttributesBuilder width(@Nullable
 String value)

Adds and encodes the value for width attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

height

@NotNull
HtmlAttributesBuilder height(@Nullable
 String value)

Adds and encodes the value for height attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

cellpadding

@NotNull
HtmlAttributesBuilder cellpadding(@Nullable
 String value)

Adds and encodes the value for cellpadding attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

cellspacing

@NotNull
HtmlAttributesBuilder cellspacing(@Nullable
 String value)

Adds and encodes the value for cellspacing attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

rowspan

@NotNull
HtmlAttributesBuilder rowspan(@Nullable
 String value)

Adds and encodes the value for rowspan attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

colspan

@NotNull
HtmlAttributesBuilder colspan(@Nullable
 String value)

Adds and encodes the value for colspan attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

align

@NotNull
HtmlAttributesBuilder align(@Nullable
 String value)

Adds and encodes the value for align attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

type

@NotNull
HtmlAttributesBuilder type(@Nullable
 String value)

Adds and encodes the value for type attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

charset

@NotNull
HtmlAttributesBuilder charset(@Nullable
 String value)

Adds and encodes the value for charset attribute.

Parameters:

value - - not encoded value, can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

javascript

@NotNull
HtmlAttributesBuilder javascript()

Adds type="text/javascript" and charset="UTF-8"

src

@NotNull
HtmlAttributesBuilder src(@Nullable
 HtmlLink value)

Parameters:

value - can be null - when null than the attribute will not be in the result

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

dleEventCanceling

@NotNull
HtmlAttributesBuilder dleEventCanceling()

Behaves differently for different browsers

dleControlSelectCanceling

@NotNull
HtmlAttributesBuilder dleControlSelectCanceling()

Behaves differently for different browsers

contentNotEditable

@NotNull
HtmlAttributesBuilder contentNotEditable()

byName

@NotNull
HtmlAttributesBuilder byName(@NotNull
 String name,
 @Nullable
 String value)

Adds value for attribute specified by name and encodes the value except when name is "href" or "src" (not case sensitive)

Parameters:

name - name of attribute

value - value of attribute

Returns:

instance of this builder to allow method chaining

lastKnownIndex

@NotNull
HtmlAttributesBuilder lastKnownIndex(int index)

Parameters:

index - - ignored when < 0

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

start

@NotNull
HtmlAttributesBuilder start(int start)

Parameters:

start - - ignored when < 0

Throws:

IllegalStateException - if this method was already called for this object

IllegalStateException - if HtmlTagBuilder.finished() was called before.

readOnly

@NotNull
HtmlAttributesBuilder readOnly()

The read only attribute is a boolean attribute and is property of input element. When present, it specifies that an input field is read-only.

Since:

3.9.2

booleanAttribute

@NotNull
HtmlAttributesBuilder booleanAttribute(@NotNull
 String name)

Boolean attribute is defined only by name (e.g. readonly). When it is present, property is set to true otherwise is false.

Parameters:

name - name of the attribute

Since:

3.9.2

data

@NotNull
HtmlAttributesBuilder data(@Nullable
 HtmlLink value)

Parameters:

value - can be null. When null, then the attribute will not be in the result.

Throws:

IllegalStateException - if this method was already called for this object.

IllegalStateException - if HtmlTagBuilder.finished() was called before.

Since:

3.23.10