Package org.apache.juneau.dto.html5

Class Form

java.lang.Object

org.apache.juneau.dto.html5.HtmlElement

org.apache.juneau.dto.html5.HtmlElementMixed

org.apache.juneau.dto.html5.Form

@Bean(typeName="form")
public class Form
extends HtmlElementMixed

DTO for an HTML <form> element.

See Also:

• Overview > juneau-dto > HTML5

Constructor Summary

Constructors

Constructor	Description
Form()	Creates an empty Form element.
Form(String action)	Creates a Form element with the specified action(String) attribute.
Form(String action, Object... children)	Creates an Form element with the specified action(String) attribute and child nodes.

Method Summary

Modifier and Type	Method	Description
Form	_class(String _class)	class attribute.
final Form	acceptcharset(String acceptcharset)	accept-charset attribute.
Form	accesskey(String accesskey)	accesskey attribute.
final Form	action(String action)	action attribute.
final Form	autocomplete(String autocomplete)	autocomplete attribute.
Form	child(Object child)	Adds a child element to this element.
Form	children(Object... children)	Adds one or more child elements to this element.
Form	contenteditable(Object contenteditable)	contenteditable attribute.
Form	dir(String dir)	dir attribute.
final Form	enctype(String enctype)	enctype attribute.
Form	hidden(Object hidden)	hidden attribute.
Form	id(String id)	id attribute.
Form	lang(String lang)	lang attribute.
final Form	method(String method)	method attribute.
final Form	name(String name)	name attribute.
final Form	novalidate(Boolean novalidate)	novalidate attribute.
Form	onabort(String onabort)	onabort attribute.
Form	onblur(String onblur)	onblur attribute.
Form	oncancel(String oncancel)	oncancel attribute.
Form	oncanplay(String oncanplay)	oncanplay attribute.
Form	oncanplaythrough(String oncanplaythrough)	oncanplaythrough attribute.
Form	onchange(String onchange)	onchange attribute.
Form	onclick(String onclick)	onclick attribute.
Form	oncuechange(String oncuechange)	oncuechange attribute.
Form	ondblclick(String ondblclick)	ondblclick attribute.
Form	ondurationchange(String ondurationchange)	ondurationchange attribute.
Form	onemptied(String onemptied)	onemptied attribute.
Form	onended(String onended)	onended attribute.
Form	onerror(String onerror)	onerror attribute.
Form	onfocus(String onfocus)	onfocus attribute.
Form	oninput(String oninput)	oninput attribute.
Form	oninvalid(String oninvalid)	oninvalid attribute.
Form	onkeydown(String onkeydown)	onkeydown attribute.
Form	onkeypress(String onkeypress)	onkeypress attribute.
Form	onkeyup(String onkeyup)	onkeyup attribute.
Form	onload(String onload)	onload attribute.
Form	onloadeddata(String onloadeddata)	onloadeddata attribute.
Form	onloadedmetadata(String onloadedmetadata)	onloadedmetadata attribute.
Form	onloadstart(String onloadstart)	onloadstart attribute.
Form	onmousedown(String onmousedown)	onmousedown attribute.
Form	onmouseenter(String onmouseenter)	onmouseenter attribute.
Form	onmouseleave(String onmouseleave)	onmouseleave attribute.
Form	onmousemove(String onmousemove)	onmousemove attribute.
Form	onmouseout(String onmouseout)	onmouseout attribute.
Form	onmouseover(String onmouseover)	onmouseover attribute.
Form	onmouseup(String onmouseup)	onmouseup attribute.
Form	onmousewheel(String onmousewheel)	onmousewheel attribute.
Form	onpause(String onpause)	onpause attribute.
Form	onplay(String onplay)	onplay attribute.
Form	onplaying(String onplaying)	onplaying attribute.
Form	onprogress(String onprogress)	onprogress attribute.
Form	onratechange(String onratechange)	onratechange attribute.
Form	onreset(String onreset)	onreset attribute.
Form	onresize(String onresize)	onresize attribute.
Form	onscroll(String onscroll)	onscroll attribute.
Form	onseeked(String onseeked)	onseeked attribute.
Form	onseeking(String onseeking)	onseeking attribute.
Form	onselect(String onselect)	onselect attribute.
Form	onshow(String onshow)	onshow attribute.
Form	onstalled(String onstalled)	onstalled attribute.
Form	onsubmit(String onsubmit)	onsubmit attribute.
Form	onsuspend(String onsuspend)	onsuspend attribute.
Form	ontimeupdate(String ontimeupdate)	ontimeupdate attribute.
Form	ontoggle(String ontoggle)	ontoggle attribute.
Form	onvolumechange(String onvolumechange)	onvolumechange attribute.
Form	onwaiting(String onwaiting)	onwaiting attribute.
Form	spellcheck(Object spellcheck)	spellcheck attribute.
Form	style(String style)	style attribute.
Form	tabindex(Object tabindex)	tabindex attribute.
final Form	target(String target)	target attribute.
Form	title(String title)	title attribute.
Form	translate(Object translate)	translate attribute.

Methods inherited from class org.apache.juneau.dto.html5.HtmlElementMixed

getChild, getChild, getChild, getChildren, setChildren

Methods inherited from class org.apache.juneau.dto.html5.HtmlElement

attr, attrUri, deminimize, getAttr, getAttr, getAttrs, setAttrs, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Form

public Form()

Creates an empty Form element.

Form

public Form(String action)

Creates a Form element with the specified action(String) attribute.

Parameters:

action - The action(String) attribute.

Form

public Form(String action,
 Object... children)

Creates an Form element with the specified action(String) attribute and child nodes.

Parameters:

action - The action(String) attribute.

children - The child nodes.

Method Details

acceptcharset

public final Form acceptcharset(String acceptcharset)

accept-charset attribute.

Character encodings to use for form submission.

Parameters:

acceptcharset - The new value for this attribute.

Returns:

This object.

action

public final Form action(String action)

action attribute.

URL to use for form submission.

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:

action - The new value for this attribute.

Returns:

This object.

autocomplete

public final Form autocomplete(String autocomplete)

autocomplete attribute.

Default setting for auto-fill feature for controls in the form.

Parameters:

autocomplete - The new value for this attribute.

Returns:

This object.

enctype

public final Form enctype(String enctype)

enctype attribute.

Form data set encoding type to use for form submission.

Parameters:

enctype - The new value for this attribute.

Returns:

This object.

method

public final Form method(String method)

method attribute.

HTTP method to use for form submission.

Parameters:

method - The new value for this attribute.

Returns:

This object.

name

public final Form name(String name)

name attribute.

Name of form to use in the document.forms API.

Parameters:

name - The new value for this attribute.

Returns:

This object.

novalidate

public final Form novalidate(Boolean novalidate)

novalidate attribute.

Bypass form control validation for form submission.

Parameters:

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

Returns:

This object.

target

public final Form target(String target)

target attribute.

Browsing context for form submission.

Parameters:

target - The new value for this attribute.

Returns:

This object.

_class

public Form _class(String _class)

Description copied from class: HtmlElement

class attribute.

Overrides:

_class in class HtmlElementMixed

Parameters:

_class - The new value for this attribute.

Returns:

This object.

accesskey

public Form accesskey(String accesskey)

Description copied from class: HtmlElement

accesskey attribute.

Overrides:

accesskey in class HtmlElementMixed

Parameters:

accesskey - The new value for this attribute.

Returns:

This object.

contenteditable

public Form contenteditable(Object contenteditable)

Description copied from class: HtmlElement

contenteditable attribute.

Overrides:

contenteditable in class HtmlElementMixed

Parameters:

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

Returns:

This object.

dir

public Form dir(String dir)

Description copied from class: HtmlElement

dir attribute.

Overrides:

dir in class HtmlElementMixed

Parameters:

dir - The new value for this attribute.

Returns:

This object.

hidden

public Form hidden(Object hidden)

Description copied from class: HtmlElement

hidden attribute.

Overrides:

hidden in class HtmlElementMixed

Parameters:

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

Returns:

This object.

id

public Form id(String id)

Description copied from class: HtmlElement

id attribute.

Overrides:

id in class HtmlElementMixed

Parameters:

id - The new value for this attribute.

Returns:

This object.

lang

public Form lang(String lang)

Description copied from class: HtmlElement

lang attribute.

Overrides:

lang in class HtmlElementMixed

Parameters:

lang - The new value for this attribute.

Returns:

This object.

onabort

public Form onabort(String onabort)

Description copied from class: HtmlElement

onabort attribute.

Overrides:

onabort in class HtmlElementMixed

Parameters:

onabort - The new value for this attribute.

Returns:

This object.

onblur

public Form onblur(String onblur)

Description copied from class: HtmlElement

onblur attribute.

Overrides:

onblur in class HtmlElementMixed

Parameters:

onblur - The new value for this attribute.

Returns:

This object.

oncancel

public Form oncancel(String oncancel)

Description copied from class: HtmlElement

oncancel attribute.

Overrides:

oncancel in class HtmlElementMixed

Parameters:

oncancel - The new value for this attribute.

Returns:

This object.

oncanplay

public Form oncanplay(String oncanplay)

Description copied from class: HtmlElement

oncanplay attribute.

Overrides:

oncanplay in class HtmlElementMixed

Parameters:

oncanplay - The new value for this attribute.

Returns:

This object.

oncanplaythrough

public Form oncanplaythrough(String oncanplaythrough)

Description copied from class: HtmlElement

oncanplaythrough attribute.

Overrides:

oncanplaythrough in class HtmlElementMixed

Parameters:

oncanplaythrough - The new value for this attribute.

Returns:

This object.

onchange

public Form onchange(String onchange)

Description copied from class: HtmlElement

onchange attribute.

Overrides:

onchange in class HtmlElementMixed

Parameters:

onchange - The new value for this attribute.

Returns:

This object.

onclick

public Form onclick(String onclick)

Description copied from class: HtmlElement

onclick attribute.

Overrides:

onclick in class HtmlElementMixed

Parameters:

onclick - The new value for this attribute.

Returns:

This object.

oncuechange

public Form oncuechange(String oncuechange)

Description copied from class: HtmlElement

oncuechange attribute.

Overrides:

oncuechange in class HtmlElementMixed

Parameters:

oncuechange - The new value for this attribute.

Returns:

This object.

ondblclick

public Form ondblclick(String ondblclick)

Description copied from class: HtmlElement

ondblclick attribute.

Overrides:

ondblclick in class HtmlElementMixed

Parameters:

ondblclick - The new value for this attribute.

Returns:

This object.

ondurationchange

public Form ondurationchange(String ondurationchange)

Description copied from class: HtmlElement

ondurationchange attribute.

Overrides:

ondurationchange in class HtmlElementMixed

Parameters:

ondurationchange - The new value for this attribute.

Returns:

This object.

onemptied

public Form onemptied(String onemptied)

Description copied from class: HtmlElement

onemptied attribute.

Overrides:

onemptied in class HtmlElementMixed

Parameters:

onemptied - The new value for this attribute.

Returns:

This object.

onended

public Form onended(String onended)

Description copied from class: HtmlElement

onended attribute.

Overrides:

onended in class HtmlElementMixed

Parameters:

onended - The new value for this attribute.

Returns:

This object.

onerror

public Form onerror(String onerror)

Description copied from class: HtmlElement

onerror attribute.

Overrides:

onerror in class HtmlElementMixed

Parameters:

onerror - The new value for this attribute.

Returns:

This object.

onfocus

public Form onfocus(String onfocus)

Description copied from class: HtmlElement

onfocus attribute.

Overrides:

onfocus in class HtmlElementMixed

Parameters:

onfocus - The new value for this attribute.

Returns:

This object.

oninput

public Form oninput(String oninput)

Description copied from class: HtmlElement

oninput attribute.

Overrides:

oninput in class HtmlElementMixed

Parameters:

oninput - The new value for this attribute.

Returns:

This object.

oninvalid

public Form oninvalid(String oninvalid)

Description copied from class: HtmlElement

oninvalid attribute.

Overrides:

oninvalid in class HtmlElementMixed

Parameters:

oninvalid - The new value for this attribute.

Returns:

This object.

onkeydown

public Form onkeydown(String onkeydown)

Description copied from class: HtmlElement

onkeydown attribute.

Overrides:

onkeydown in class HtmlElementMixed

Parameters:

onkeydown - The new value for this attribute.

Returns:

This object.

onkeypress

public Form onkeypress(String onkeypress)

Description copied from class: HtmlElement

onkeypress attribute.

Overrides:

onkeypress in class HtmlElementMixed

Parameters:

onkeypress - The new value for this attribute.

Returns:

This object.

onkeyup

public Form onkeyup(String onkeyup)

Description copied from class: HtmlElement

onkeyup attribute.

Overrides:

onkeyup in class HtmlElementMixed

Parameters:

onkeyup - The new value for this attribute.

Returns:

This object.

onload

public Form onload(String onload)

Description copied from class: HtmlElement

onload attribute.

Overrides:

onload in class HtmlElementMixed

Parameters:

onload - The new value for this attribute.

Returns:

This object.

onloadeddata

public Form onloadeddata(String onloadeddata)

Description copied from class: HtmlElement

onloadeddata attribute.

Overrides:

onloadeddata in class HtmlElementMixed

Parameters:

onloadeddata - The new value for this attribute.

Returns:

This object.

onloadedmetadata

public Form onloadedmetadata(String onloadedmetadata)

Description copied from class: HtmlElement

onloadedmetadata attribute.

Overrides:

onloadedmetadata in class HtmlElementMixed

Parameters:

onloadedmetadata - The new value for this attribute.

Returns:

This object.

onloadstart

public Form onloadstart(String onloadstart)

Description copied from class: HtmlElement

onloadstart attribute.

Overrides:

onloadstart in class HtmlElementMixed

Parameters:

onloadstart - The new value for this attribute.

Returns:

This object.

onmousedown

public Form onmousedown(String onmousedown)

Description copied from class: HtmlElement

onmousedown attribute.

Overrides:

onmousedown in class HtmlElementMixed

Parameters:

onmousedown - The new value for this attribute.

Returns:

This object.

onmouseenter

public Form onmouseenter(String onmouseenter)

Description copied from class: HtmlElement

onmouseenter attribute.

Overrides:

onmouseenter in class HtmlElementMixed

Parameters:

onmouseenter - The new value for this attribute.

Returns:

This object.

onmouseleave

public Form onmouseleave(String onmouseleave)

Description copied from class: HtmlElement

onmouseleave attribute.

Overrides:

onmouseleave in class HtmlElementMixed

Parameters:

onmouseleave - The new value for this attribute.

Returns:

This object.

onmousemove

public Form onmousemove(String onmousemove)

Description copied from class: HtmlElement

onmousemove attribute.

Overrides:

onmousemove in class HtmlElementMixed

Parameters:

onmousemove - The new value for this attribute.

Returns:

This object.

onmouseout

public Form onmouseout(String onmouseout)

Description copied from class: HtmlElement

onmouseout attribute.

Overrides:

onmouseout in class HtmlElementMixed

Parameters:

onmouseout - The new value for this attribute.

Returns:

This object.

onmouseover

public Form onmouseover(String onmouseover)

Description copied from class: HtmlElement

onmouseover attribute.

Overrides:

onmouseover in class HtmlElementMixed

Parameters:

onmouseover - The new value for this attribute.

Returns:

This object.

onmouseup

public Form onmouseup(String onmouseup)

Description copied from class: HtmlElement

onmouseup attribute.

Overrides:

onmouseup in class HtmlElementMixed

Parameters:

onmouseup - The new value for this attribute.

Returns:

This object.

onmousewheel

public Form onmousewheel(String onmousewheel)

Description copied from class: HtmlElement

onmousewheel attribute.

Overrides:

onmousewheel in class HtmlElementMixed

Parameters:

onmousewheel - The new value for this attribute.

Returns:

This object.

onpause

public Form onpause(String onpause)

Description copied from class: HtmlElement

onpause attribute.

Overrides:

onpause in class HtmlElementMixed

Parameters:

onpause - The new value for this attribute.

Returns:

This object.

onplay

public Form onplay(String onplay)

Description copied from class: HtmlElement

onplay attribute.

Overrides:

onplay in class HtmlElementMixed

Parameters:

onplay - The new value for this attribute.

Returns:

This object.

onplaying

public Form onplaying(String onplaying)

Description copied from class: HtmlElement

onplaying attribute.

Overrides:

onplaying in class HtmlElementMixed

Parameters:

onplaying - The new value for this attribute.

Returns:

This object.

onprogress

public Form onprogress(String onprogress)

Description copied from class: HtmlElement

onprogress attribute.

Overrides:

onprogress in class HtmlElementMixed

Parameters:

onprogress - The new value for this attribute.

Returns:

This object.

onratechange

public Form onratechange(String onratechange)

Description copied from class: HtmlElement

onratechange attribute.

Overrides:

onratechange in class HtmlElementMixed

Parameters:

onratechange - The new value for this attribute.

Returns:

This object.

onreset

public Form onreset(String onreset)

Description copied from class: HtmlElement

onreset attribute.

Overrides:

onreset in class HtmlElementMixed

Parameters:

onreset - The new value for this attribute.

Returns:

This object.

onresize

public Form onresize(String onresize)

Description copied from class: HtmlElement

onresize attribute.

Overrides:

onresize in class HtmlElementMixed

Parameters:

onresize - The new value for this attribute.

Returns:

This object.

onscroll

public Form onscroll(String onscroll)

Description copied from class: HtmlElement

onscroll attribute.

Overrides:

onscroll in class HtmlElementMixed

Parameters:

onscroll - The new value for this attribute.

Returns:

This object.

onseeked

public Form onseeked(String onseeked)

Description copied from class: HtmlElement

onseeked attribute.

Overrides:

onseeked in class HtmlElementMixed

Parameters:

onseeked - The new value for this attribute.

Returns:

This object.

onseeking

public Form onseeking(String onseeking)

Description copied from class: HtmlElement

onseeking attribute.

Overrides:

onseeking in class HtmlElementMixed

Parameters:

onseeking - The new value for this attribute.

Returns:

This object.

onselect

public Form onselect(String onselect)

Description copied from class: HtmlElement

onselect attribute.

Overrides:

onselect in class HtmlElementMixed

Parameters:

onselect - The new value for this attribute.

Returns:

This object.

onshow

public Form onshow(String onshow)

Description copied from class: HtmlElement

onshow attribute.

Overrides:

onshow in class HtmlElementMixed

Parameters:

onshow - The new value for this attribute.

Returns:

This object.

onstalled

public Form onstalled(String onstalled)

Description copied from class: HtmlElement

onstalled attribute.

Overrides:

onstalled in class HtmlElementMixed

Parameters:

onstalled - The new value for this attribute.

Returns:

This object.

onsubmit

public Form onsubmit(String onsubmit)

Description copied from class: HtmlElement

onsubmit attribute.

Overrides:

onsubmit in class HtmlElementMixed

Parameters:

onsubmit - The new value for this attribute.

Returns:

This object.

onsuspend

public Form onsuspend(String onsuspend)

Description copied from class: HtmlElement

onsuspend attribute.

Overrides:

onsuspend in class HtmlElementMixed

Parameters:

onsuspend - The new value for this attribute.

Returns:

This object.

ontimeupdate

public Form ontimeupdate(String ontimeupdate)

Description copied from class: HtmlElement

ontimeupdate attribute.

Overrides:

ontimeupdate in class HtmlElementMixed

Parameters:

ontimeupdate - The new value for this attribute.

Returns:

This object.

ontoggle

public Form ontoggle(String ontoggle)

Description copied from class: HtmlElement

ontoggle attribute.

Overrides:

ontoggle in class HtmlElementMixed

Parameters:

ontoggle - The new value for this attribute.

Returns:

This object.

onvolumechange

public Form onvolumechange(String onvolumechange)

Description copied from class: HtmlElement

onvolumechange attribute.

Overrides:

onvolumechange in class HtmlElementMixed

Parameters:

onvolumechange - The new value for this attribute.

Returns:

This object.

onwaiting

public Form onwaiting(String onwaiting)

Description copied from class: HtmlElement

onwaiting attribute.

Overrides:

onwaiting in class HtmlElementMixed

Parameters:

onwaiting - The new value for this attribute.

Returns:

This object.

spellcheck

public Form spellcheck(Object spellcheck)

Description copied from class: HtmlElement

spellcheck attribute.

Overrides:

spellcheck in class HtmlElementMixed

Parameters:

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

Returns:

This object.

style

public Form style(String style)

Description copied from class: HtmlElement

style attribute.

Overrides:

style in class HtmlElementMixed

Parameters:

style - The new value for this attribute.

Returns:

This object.

tabindex

public Form tabindex(Object tabindex)

Description copied from class: HtmlElement

tabindex attribute.

Overrides:

tabindex in class HtmlElementMixed

Parameters:

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

Returns:

This object.

title

public Form title(String title)

Description copied from class: HtmlElement

title attribute.

Overrides:

title in class HtmlElementMixed

Parameters:

title - The new value for this attribute.

Returns:

This object.

translate

public Form translate(Object translate)

Description copied from class: HtmlElement

translate attribute.

Overrides:

translate in class HtmlElementMixed

Parameters:

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

Returns:

This object.

child

public Form child(Object child)

Description copied from class: HtmlElementMixed

Adds a child element to this element.

Overrides:

child in class HtmlElementMixed

Parameters:

child - The child to add as a child element. Can be a string or HtmlElement. Can also be a container of strings and elements.

Returns:

This object.

children

public Form children(Object... children)

Description copied from class: HtmlElementMixed

Adds one or more child elements to this element.

Overrides:

children in class HtmlElementMixed

Parameters:

children - The children to add as child elements. Can be a mixture of strings and HtmlElement objects. Can also be containers of strings and elements.

Returns:

This object.