bayou.html

Class HtmlElement

java.lang.Object

bayou.html.HtmlElement

All Implemented Interfaces:

HtmlPiece

Direct Known Subclasses:

Html4.AREA, Html4.BASE, Html4.BR, Html4.COL, Html4.HR, Html4.IMG, Html4.INPUT, Html4.LINK, Html4.META, Html4.PARAM, Html5.EMBED, Html5.KEYGEN, Html5.MENUITEM, Html5.SOURCE, Html5.TRACK, Html5.WBR, HtmlParentElement

public abstract class HtmlElement
extends Object
implements HtmlPiece

Html element.

An html element has attributes. An attribute is a name-value pair. For example

     HtmlElement input = new Html4.INPUT();
     input.setAttribute("id", "q");
     input.setAttribute("disabled", "");
     input.render(0, System.out::print); // <input id="q" disabled>
 

For boolean attributes, use "" as true, null as false, for example

     input.setAttribute("disabled", "");   // <input name="q" disabled>
     input.setAttribute("disabled", null); // <input name="q">  // not disabled
 

This is an abstract class; a concrete subclass needs to implement getElementType().

See HtmlParentElement for elements that can contain children.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HtmlElement() Protected constructor for subclasses.

Method Summary

Abstract Method
HtmlElementType	getElementType() Get the metadata of this element.
Instance Methods
boolean	isBlock() Whether this is a "block" element.
int	getAttributeCount() Get the number of attributes.
CharSequence	getAttribute(String name) Get the value of the attribute; null if the attribute is not present.
CharSequence	setAttribute(String name, CharSequence value) Set the value of the attribute.
Map<String,CharSequence>	getAttributeMap() Get a live Map view of the attributes.
void	render(int indent, Consumer<CharSequence> out) Render this element to `out`.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.html.HtmlPiece

render

Constructor Detail

HtmlElement

protected HtmlElement()

Protected constructor for subclasses.

Method Detail

getElementType

public abstract HtmlElementType getElementType()

Get the metadata of this element. See HtmlElementType.

isBlock

public boolean isBlock()

Whether this is a "block" element.

This method is equivalent to `getElementType().isBlock`.

Specified by:

isBlock in interface HtmlPiece

getAttributeCount

public int getAttributeCount()

Get the number of attributes.

getAttribute

public CharSequence getAttribute(String name)

Get the value of the attribute; null if the attribute is not present.

setAttribute

public CharSequence setAttribute(String name,
                                 CharSequence value)

Set the value of the attribute.

If `value` is null, the attribute is removed.

The value can contain any chars. It can be empty.

Returns:

the previous value of the attribute, or null if the attribute didn't exist.

getAttributeMap

public Map<String,CharSequence> getAttributeMap()

Get a live Map view of the attributes.

The returned Map supports read and write.

render

public void render(int indent,
                   Consumer<CharSequence> out)

Render this element to `out`.

An example rendering: <input name="q" disabled>

If an attribute value is empty, only the name is rendered. For example.

 setAttribute("disabled", "")    ==>    <input disabled> 

Special chars in attribute values will be escaped, using HtmlPiece.renderEscaped(). For example

 setAttribute("name", "a&b")     ==>    <input name="a&amp;b"> 

Specified by:

render in interface HtmlPiece