Package org.apache.juneau.dto.html5

Class HtmlElement

java.lang.Object

org.apache.juneau.dto.html5.HtmlElement

Direct Known Subclasses:

HtmlElementContainer, HtmlElementMixed, HtmlElementRawText, HtmlElementText, HtmlElementVoid

@Html(format=XML)
public abstract class HtmlElement
extends Object

Superclass for all HTML elements.

These are beans that when serialized using HtmlSerializer generate valid HTML5 elements.

See Also:

• Overview > juneau-dto > HTML5

Constructor Summary

Constructors

Constructor	Description
HtmlElement()

Method Summary

Modifier and Type	Method	Description
HtmlElement	_class(String _class)	class attribute.
HtmlElement	accesskey(String accesskey)	accesskey attribute.
HtmlElement	attr(String key, Object val)	Adds an arbitrary attribute to this element.
HtmlElement	attrUri(String key, Object val)	Adds an arbitrary URI attribute to this element.
HtmlElement	contenteditable(Object contenteditable)	contenteditable attribute.
protected Object	deminimize(Object value, String attr)	If the specified attribute is a boolean, it gets converted to the attribute name if true or null if false.
HtmlElement	dir(String dir)	dir attribute.
<T> T	getAttr(Class<T> type, String key)	Returns the attribute with the specified name converted to the specified class type.
String	getAttr(String key)	Returns the attribute with the specified name.
LinkedHashMap<String,Object>	getAttrs()	The attributes of this element.
HtmlElement	hidden(Object hidden)	hidden attribute.
HtmlElement	id(String id)	id attribute.
HtmlElement	lang(String lang)	lang attribute.
HtmlElement	onabort(String onabort)	onabort attribute.
HtmlElement	onblur(String onblur)	onblur attribute.
HtmlElement	oncancel(String oncancel)	oncancel attribute.
HtmlElement	oncanplay(String oncanplay)	oncanplay attribute.
HtmlElement	oncanplaythrough(String oncanplaythrough)	oncanplaythrough attribute.
HtmlElement	onchange(String onchange)	onchange attribute.
HtmlElement	onclick(String onclick)	onclick attribute.
HtmlElement	oncuechange(String oncuechange)	oncuechange attribute.
HtmlElement	ondblclick(String ondblclick)	ondblclick attribute.
HtmlElement	ondurationchange(String ondurationchange)	ondurationchange attribute.
HtmlElement	onemptied(String onemptied)	onemptied attribute.
HtmlElement	onended(String onended)	onended attribute.
HtmlElement	onerror(String onerror)	onerror attribute.
HtmlElement	onfocus(String onfocus)	onfocus attribute.
HtmlElement	oninput(String oninput)	oninput attribute.
HtmlElement	oninvalid(String oninvalid)	oninvalid attribute.
HtmlElement	onkeydown(String onkeydown)	onkeydown attribute.
HtmlElement	onkeypress(String onkeypress)	onkeypress attribute.
HtmlElement	onkeyup(String onkeyup)	onkeyup attribute.
HtmlElement	onload(String onload)	onload attribute.
HtmlElement	onloadeddata(String onloadeddata)	onloadeddata attribute.
HtmlElement	onloadedmetadata(String onloadedmetadata)	onloadedmetadata attribute.
HtmlElement	onloadstart(String onloadstart)	onloadstart attribute.
HtmlElement	onmousedown(String onmousedown)	onmousedown attribute.
HtmlElement	onmouseenter(String onmouseenter)	onmouseenter attribute.
HtmlElement	onmouseleave(String onmouseleave)	onmouseleave attribute.
HtmlElement	onmousemove(String onmousemove)	onmousemove attribute.
HtmlElement	onmouseout(String onmouseout)	onmouseout attribute.
HtmlElement	onmouseover(String onmouseover)	onmouseover attribute.
HtmlElement	onmouseup(String onmouseup)	onmouseup attribute.
HtmlElement	onmousewheel(String onmousewheel)	onmousewheel attribute.
HtmlElement	onpause(String onpause)	onpause attribute.
HtmlElement	onplay(String onplay)	onplay attribute.
HtmlElement	onplaying(String onplaying)	onplaying attribute.
HtmlElement	onprogress(String onprogress)	onprogress attribute.
HtmlElement	onratechange(String onratechange)	onratechange attribute.
HtmlElement	onreset(String onreset)	onreset attribute.
HtmlElement	onresize(String onresize)	onresize attribute.
HtmlElement	onscroll(String onscroll)	onscroll attribute.
HtmlElement	onseeked(String onseeked)	onseeked attribute.
HtmlElement	onseeking(String onseeking)	onseeking attribute.
HtmlElement	onselect(String onselect)	onselect attribute.
HtmlElement	onshow(String onshow)	onshow attribute.
HtmlElement	onstalled(String onstalled)	onstalled attribute.
HtmlElement	onsubmit(String onsubmit)	onsubmit attribute.
HtmlElement	onsuspend(String onsuspend)	onsuspend attribute.
HtmlElement	ontimeupdate(String ontimeupdate)	ontimeupdate attribute.
HtmlElement	ontoggle(String ontoggle)	ontoggle attribute.
HtmlElement	onvolumechange(String onvolumechange)	onvolumechange attribute.
HtmlElement	onwaiting(String onwaiting)	onwaiting attribute.
HtmlElement	setAttrs(LinkedHashMap<String,Object> attrs)	Sets the attributes for this element.
HtmlElement	spellcheck(Object spellcheck)	spellcheck attribute.
HtmlElement	style(String style)	style attribute.
HtmlElement	tabindex(Object tabindex)	tabindex attribute.
HtmlElement	title(String title)	title attribute.
String	toString()
HtmlElement	translate(Object translate)	translate attribute.

Methods inherited from class java.lang.Object

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

Constructor Details

HtmlElement

public HtmlElement()

Method Details

getAttrs

@Xml(format=ATTRS)
@Beanp("a")
public LinkedHashMap<String,Object> getAttrs()

The attributes of this element.

Returns:

The attributes of this element.

setAttrs

@Beanp("a")
public HtmlElement setAttrs(LinkedHashMap<String,Object> attrs)

Sets the attributes for this element.

Parameters:

attrs - The new attributes for this element.

Returns:

This object.

attr

public HtmlElement attr(String key,
 Object val)

Adds an arbitrary attribute to this element.

Parameters:

key - The attribute name.

val - The attribute value.

Returns:

This object.

attrUri

public HtmlElement attrUri(String key,
 Object val)

Adds an arbitrary URI attribute to this element.

Same as attr(String, Object), except if the value is a string that appears to be a URI (e.g. "servlet:/xxx").

The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.

URIs defined by UriResolver can be used for values.

Parameters:

key - The attribute name.

val - The attribute value.

Returns:

This object.

getAttr

public String getAttr(String key)

Returns the attribute with the specified name.

Parameters:

key - The attribute name.

Returns:

The attribute value, or null if the named attribute does not exist.

getAttr

public <T> T getAttr(Class<T> type,
 String key)

Returns the attribute with the specified name converted to the specified class type.

Type Parameters:

T - The class type to convert this class to.

Parameters:

type - The class type to convert this class to. See ConverterUtils for a list of supported conversion types.

key - The attribute name.

Returns:

The attribute value, or null if the named attribute does not exist.

accesskey

public HtmlElement accesskey(String accesskey)

accesskey attribute.

Parameters:

accesskey - The new value for this attribute.

Returns:

This object.

_class

public HtmlElement _class(String _class)

class attribute.

Parameters:

_class - The new value for this attribute.

Returns:

This object.

contenteditable

public HtmlElement contenteditable(Object contenteditable)

contenteditable attribute.

Parameters:

contenteditable - The new value for this attribute. Typically a Boolean or String.

Returns:

This object.

dir

public HtmlElement dir(String dir)

dir attribute.

Parameters:

dir - The new value for this attribute.

Returns:

This object.

hidden

public HtmlElement hidden(Object hidden)

hidden attribute.

Parameters:

hidden - The new value for this attribute. Typically a Boolean or String.

Returns:

This object.

id

public HtmlElement id(String id)

id attribute.

Parameters:

id - The new value for this attribute.

Returns:

This object.

lang

public HtmlElement lang(String lang)

lang attribute.

Parameters:

lang - The new value for this attribute.

Returns:

This object.

onabort

public HtmlElement onabort(String onabort)

onabort attribute.

Parameters:

onabort - The new value for this attribute.

Returns:

This object.

onblur

public HtmlElement onblur(String onblur)

onblur attribute.

Parameters:

onblur - The new value for this attribute.

Returns:

This object.

oncancel

public HtmlElement oncancel(String oncancel)

oncancel attribute.

Parameters:

oncancel - The new value for this attribute.

Returns:

This object.

oncanplay

public HtmlElement oncanplay(String oncanplay)

oncanplay attribute.

Parameters:

oncanplay - The new value for this attribute.

Returns:

This object.

oncanplaythrough

public HtmlElement oncanplaythrough(String oncanplaythrough)

oncanplaythrough attribute.

Parameters:

oncanplaythrough - The new value for this attribute.

Returns:

This object.

onchange

public HtmlElement onchange(String onchange)

onchange attribute.

Parameters:

onchange - The new value for this attribute.

Returns:

This object.

onclick

public HtmlElement onclick(String onclick)

onclick attribute.

Parameters:

onclick - The new value for this attribute.

Returns:

This object.

oncuechange

public HtmlElement oncuechange(String oncuechange)

oncuechange attribute.

Parameters:

oncuechange - The new value for this attribute.

Returns:

This object.

ondblclick

public HtmlElement ondblclick(String ondblclick)

ondblclick attribute.

Parameters:

ondblclick - The new value for this attribute.

Returns:

This object.

ondurationchange

public HtmlElement ondurationchange(String ondurationchange)

ondurationchange attribute.

Parameters:

ondurationchange - The new value for this attribute.

Returns:

This object.

onemptied

public HtmlElement onemptied(String onemptied)

onemptied attribute.

Parameters:

onemptied - The new value for this attribute.

Returns:

This object.

onended

public HtmlElement onended(String onended)

onended attribute.

Parameters:

onended - The new value for this attribute.

Returns:

This object.

onerror

public HtmlElement onerror(String onerror)

onerror attribute.

Parameters:

onerror - The new value for this attribute.

Returns:

This object.

onfocus

public HtmlElement onfocus(String onfocus)

onfocus attribute.

Parameters:

onfocus - The new value for this attribute.

Returns:

This object.

oninput

public HtmlElement oninput(String oninput)

oninput attribute.

Parameters:

oninput - The new value for this attribute.

Returns:

This object.

oninvalid

public HtmlElement oninvalid(String oninvalid)

oninvalid attribute.

Parameters:

oninvalid - The new value for this attribute.

Returns:

This object.

onkeydown

public HtmlElement onkeydown(String onkeydown)

onkeydown attribute.

Parameters:

onkeydown - The new value for this attribute.

Returns:

This object.

onkeypress

public HtmlElement onkeypress(String onkeypress)

onkeypress attribute.

Parameters:

onkeypress - The new value for this attribute.

Returns:

This object.

onkeyup

public HtmlElement onkeyup(String onkeyup)

onkeyup attribute.

Parameters:

onkeyup - The new value for this attribute.

Returns:

This object.

onload

public HtmlElement onload(String onload)

onload attribute.

Parameters:

onload - The new value for this attribute.

Returns:

This object.

onloadeddata

public HtmlElement onloadeddata(String onloadeddata)

onloadeddata attribute.

Parameters:

onloadeddata - The new value for this attribute.

Returns:

This object.

onloadedmetadata

public HtmlElement onloadedmetadata(String onloadedmetadata)

onloadedmetadata attribute.

Parameters:

onloadedmetadata - The new value for this attribute.

Returns:

This object.

onloadstart

public HtmlElement onloadstart(String onloadstart)

onloadstart attribute.

Parameters:

onloadstart - The new value for this attribute.

Returns:

This object.

onmousedown

public HtmlElement onmousedown(String onmousedown)

onmousedown attribute.

Parameters:

onmousedown - The new value for this attribute.

Returns:

This object.

onmouseenter

public HtmlElement onmouseenter(String onmouseenter)

onmouseenter attribute.

Parameters:

onmouseenter - The new value for this attribute.

Returns:

This object.

onmouseleave

public HtmlElement onmouseleave(String onmouseleave)

onmouseleave attribute.

Parameters:

onmouseleave - The new value for this attribute.

Returns:

This object.

onmousemove

public HtmlElement onmousemove(String onmousemove)

onmousemove attribute.

Parameters:

onmousemove - The new value for this attribute.

Returns:

This object.

onmouseout

public HtmlElement onmouseout(String onmouseout)

onmouseout attribute.

Parameters:

onmouseout - The new value for this attribute.

Returns:

This object.

onmouseover

public HtmlElement onmouseover(String onmouseover)

onmouseover attribute.

Parameters:

onmouseover - The new value for this attribute.

Returns:

This object.

onmouseup

public HtmlElement onmouseup(String onmouseup)

onmouseup attribute.

Parameters:

onmouseup - The new value for this attribute.

Returns:

This object.

onmousewheel

public HtmlElement onmousewheel(String onmousewheel)

onmousewheel attribute.

Parameters:

onmousewheel - The new value for this attribute.

Returns:

This object.

onpause

public HtmlElement onpause(String onpause)

onpause attribute.

Parameters:

onpause - The new value for this attribute.

Returns:

This object.

onplay

public HtmlElement onplay(String onplay)

onplay attribute.

Parameters:

onplay - The new value for this attribute.

Returns:

This object.

onplaying

public HtmlElement onplaying(String onplaying)

onplaying attribute.

Parameters:

onplaying - The new value for this attribute.

Returns:

This object.

onprogress

public HtmlElement onprogress(String onprogress)

onprogress attribute.

Parameters:

onprogress - The new value for this attribute.

Returns:

This object.

onratechange

public HtmlElement onratechange(String onratechange)

onratechange attribute.

Parameters:

onratechange - The new value for this attribute.

Returns:

This object.

onreset

public HtmlElement onreset(String onreset)

onreset attribute.

Parameters:

onreset - The new value for this attribute.

Returns:

This object.

onresize

public HtmlElement onresize(String onresize)

onresize attribute.

Parameters:

onresize - The new value for this attribute.

Returns:

This object.

onscroll

public HtmlElement onscroll(String onscroll)

onscroll attribute.

Parameters:

onscroll - The new value for this attribute.

Returns:

This object.

onseeked

public HtmlElement onseeked(String onseeked)

onseeked attribute.

Parameters:

onseeked - The new value for this attribute.

Returns:

This object.

onseeking

public HtmlElement onseeking(String onseeking)

onseeking attribute.

Parameters:

onseeking - The new value for this attribute.

Returns:

This object.

onselect

public HtmlElement onselect(String onselect)

onselect attribute.

Parameters:

onselect - The new value for this attribute.

Returns:

This object.

onshow

public HtmlElement onshow(String onshow)

onshow attribute.

Parameters:

onshow - The new value for this attribute.

Returns:

This object.

onstalled

public HtmlElement onstalled(String onstalled)

onstalled attribute.

Parameters:

onstalled - The new value for this attribute.

Returns:

This object.

onsubmit

public HtmlElement onsubmit(String onsubmit)

onsubmit attribute.

Parameters:

onsubmit - The new value for this attribute.

Returns:

This object.

onsuspend

public HtmlElement onsuspend(String onsuspend)

onsuspend attribute.

Parameters:

onsuspend - The new value for this attribute.

Returns:

This object.

ontimeupdate

public HtmlElement ontimeupdate(String ontimeupdate)

ontimeupdate attribute.

Parameters:

ontimeupdate - The new value for this attribute.

Returns:

This object.

ontoggle

public HtmlElement ontoggle(String ontoggle)

ontoggle attribute.

Parameters:

ontoggle - The new value for this attribute.

Returns:

This object.

onvolumechange

public HtmlElement onvolumechange(String onvolumechange)

onvolumechange attribute.

Parameters:

onvolumechange - The new value for this attribute.

Returns:

This object.

onwaiting

public HtmlElement onwaiting(String onwaiting)

onwaiting attribute.

Parameters:

onwaiting - The new value for this attribute.

Returns:

This object.

spellcheck

public HtmlElement spellcheck(Object spellcheck)

spellcheck attribute.

Parameters:

spellcheck - The new value for this attribute. Typically a Boolean or String.

Returns:

This object.

style

public HtmlElement style(String style)

style attribute.

Parameters:

style - The new value for this attribute.

Returns:

This object.

tabindex

public HtmlElement tabindex(Object tabindex)

tabindex attribute.

Parameters:

tabindex - The new value for this attribute. Typically a Number or String.

Returns:

This object.

title

public HtmlElement title(String title)

title attribute.

Parameters:

title - The new value for this attribute.

Returns:

This object.

translate

public HtmlElement translate(Object translate)

translate attribute.

Parameters:

translate - The new value for this attribute. Typically a Number or String.

Returns:

This object.

deminimize

protected Object deminimize(Object value,
 String attr)

If the specified attribute is a boolean, it gets converted to the attribute name if true or null if false.

Parameters:

value - The attribute value.

attr - The attribute name.

Returns:

The deminimized value, or the same value if the value wasn't a boolean.

toString

public String toString()

Overrides:

toString in class Object