Package org.apache.juneau.bean.html5

Class Label

java.lang.Object

org.apache.juneau.bean.html5.HtmlElement

org.apache.juneau.bean.html5.HtmlElementMixed

org.apache.juneau.bean.html5.Label

@Bean(typeName="label")
public class Label
extends HtmlElementMixed

DTO for an HTML <label> element.

The label element represents a caption for a form control. It provides a programmatic association between the label and the form control, improving accessibility and user experience. When a label is associated with a form control, clicking the label will focus or activate the control.

Examples:

import static org.apache.juneau.bean.html5.HtmlBuilder.*; // Label with explicit association Label label1 = label("Username:") ._for("username"); // Label wrapping form control Label label2 = label( input("checkbox").name("agree"), span("I agree to the terms and conditions") ); // Label with form association Label label3 = label("Email Address:") ._for("email") .form("contactForm"); // Label with styling Label label4 = label("Password:") ._for("password") ._class("required");

See Also:

• juneau-bean-html5

Constructor Summary

Constructors

Constructor	Description
Label()	Creates an empty Label element.
Label(Object... children)	Creates a Label element with the specified child nodes.

Method Summary

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

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

getChild, getChild, getChild, getChildren, setChildren

Methods inherited from class org.apache.juneau.bean.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

Label

public Label()

Creates an empty Label element.

Label

public Label(Object... children)

Creates a Label element with the specified child nodes.

Parameters:

children - The child nodes.

Method Details

_for

public Label _for(String value)

for attribute.

Associates the label with a form control by specifying the control's ID. This creates a programmatic relationship between the label and the form control for accessibility.

The value should match the ID of a form control element in the same document.

Parameters:

_for - The ID of the form control to associate with this label.

Returns:

This object.

form

public Label form(String value)

form attribute.

Associates the label with a form element by specifying the form's ID. This allows the label to be placed outside the form element while still being part of the form.

The value should match the ID of a form element in the same document.

Parameters:

form - The ID of the form element to associate with this label.

Returns:

This object.

_class

public Label _class(String value)

Description copied from class: HtmlElement

class attribute.

Specifies one or more CSS class names for the element, separated by spaces. These classes can be used for styling and JavaScript selection.

Overrides:

_class in class HtmlElementMixed

Returns:

This object.

accesskey

public Label accesskey(String value)

Description copied from class: HtmlElement

accesskey attribute.

Defines a keyboard shortcut to activate or focus an element. The value should be a single character that, when pressed with a modifier key (usually Alt), activates the element.

Overrides:

accesskey in class HtmlElementMixed

Returns:

This object.

contenteditable

public Label contenteditable(Object value)

Description copied from class: HtmlElement

contenteditable attribute.

Indicates whether the element's content is editable by the user.

Possible values:

• "true" or empty string - Element content is editable
• "false" - Element content is not editable
• "plaintext-only" - Element content is editable, but rich text formatting is disabled

Overrides:

contenteditable in class HtmlElementMixed

Returns:

This object.

dir

public Label dir(String value)

Description copied from class: HtmlElement

dir attribute.

Specifies the text direction of the element's content.

Possible values:

• "ltr" - Left-to-right text direction
• "rtl" - Right-to-left text direction
• "auto" - Browser determines direction based on content

Overrides:

dir in class HtmlElementMixed

Returns:

This object.

hidden

public Label hidden(Object value)

Description copied from class: HtmlElement

hidden attribute.

This attribute uses deminimized values:

• false - Attribute is not added
• true - Attribute is added as "hidden"
• Other values - Passed through as-is

Overrides:

hidden in class HtmlElementMixed

Returns:

This object.

id

public Label id(String value)

Description copied from class: HtmlElement

id attribute.

Specifies a unique identifier for the element. The ID must be unique within the document and can be used for CSS styling, JavaScript selection, and anchor links.

Overrides:

id in class HtmlElementMixed

Returns:

This object.

lang

public Label lang(String value)

Description copied from class: HtmlElement

lang attribute.

Specifies the primary language of the element's content using a language tag. This helps with accessibility, search engines, and browser features like spell checking.

Overrides:

lang in class HtmlElementMixed

Returns:

This object.

onabort

public Label onabort(String value)

Description copied from class: HtmlElement

onabort attribute.

Event handler for when an operation is aborted (e.g., image loading is cancelled).

Overrides:

onabort in class HtmlElementMixed

Returns:

This object.

onblur

public Label onblur(String value)

Description copied from class: HtmlElement

onblur attribute.

Event handler for when the element loses focus.

Note:

If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:

• If using single quotes for attributes: onblur("validate(\"email\")")
• If using double quotes for attributes: onblur("validate('email')")

Overrides:

onblur in class HtmlElementMixed

Returns:

This object.

oncancel

public Label oncancel(String value)

Description copied from class: HtmlElement

oncancel attribute.

Event handler for when a dialog is cancelled.

Overrides:

oncancel in class HtmlElementMixed

Returns:

This object.

oncanplay

public Label oncanplay(String value)

Description copied from class: HtmlElement

oncanplay attribute.

Event handler for when the media can start playing (enough data has been buffered).

Overrides:

oncanplay in class HtmlElementMixed

Returns:

This object.

oncanplaythrough

public Label oncanplaythrough(String value)

Description copied from class: HtmlElement

oncanplaythrough attribute.

Event handler for when the media can play through to the end without buffering.

Overrides:

oncanplaythrough in class HtmlElementMixed

Returns:

This object.

onchange

public Label onchange(String value)

Description copied from class: HtmlElement

onchange attribute.

Event handler for when the value of a form element changes and loses focus.

Note:

If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:

• If using single quotes for attributes: onchange("validate(\"field\")")
• If using double quotes for attributes: onchange("validate('field')")

Overrides:

onchange in class HtmlElementMixed

Returns:

This object.

onclick

public Label onclick(String value)

Description copied from class: HtmlElement

onclick attribute.

Event handler for when the element is clicked.

Note:

If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:

• If using single quotes for attributes: onclick("alert(\"Hello\")")
• If using double quotes for attributes: onclick("alert('Hello')")

Overrides:

onclick in class HtmlElementMixed

Returns:

This object.

oncuechange

public Label oncuechange(String value)

Description copied from class: HtmlElement

oncuechange attribute.

Event handler for when a text track cue changes.

Overrides:

oncuechange in class HtmlElementMixed

Returns:

This object.

ondblclick

public Label ondblclick(String value)

Description copied from class: HtmlElement

ondblclick attribute.

Event handler for when the element is double-clicked.

Overrides:

ondblclick in class HtmlElementMixed

Returns:

This object.

ondurationchange

public Label ondurationchange(String value)

Description copied from class: HtmlElement

ondurationchange attribute.

Event handler for when the duration of the media changes.

Overrides:

ondurationchange in class HtmlElementMixed

Returns:

This object.

onemptied

public Label onemptied(String value)

Description copied from class: HtmlElement

onemptied attribute.

Event handler for when the media element becomes empty (e.g., network error).

Overrides:

onemptied in class HtmlElementMixed

Returns:

This object.

onended

public Label onended(String value)

Description copied from class: HtmlElement

onended attribute.

Event handler for when the media playback reaches the end.

Overrides:

onended in class HtmlElementMixed

Returns:

This object.

onerror

public Label onerror(String value)

Description copied from class: HtmlElement

onerror attribute.

Event handler for when an error occurs (e.g., failed resource loading).

Overrides:

onerror in class HtmlElementMixed

Returns:

This object.

onfocus

public Label onfocus(String value)

Description copied from class: HtmlElement

onfocus attribute.

Event handler for when the element receives focus.

Note:

If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:

• If using single quotes for attributes: onfocus("highlight(\"field\")")
• If using double quotes for attributes: onfocus("highlight('field')")

Overrides:

onfocus in class HtmlElementMixed

Returns:

This object.

oninput

public Label oninput(String value)

Description copied from class: HtmlElement

oninput attribute.

Event handler for when the value of an input element changes (fires on every keystroke).

Overrides:

oninput in class HtmlElementMixed

Returns:

This object.

oninvalid

public Label oninvalid(String value)

Description copied from class: HtmlElement

oninvalid attribute.

Event handler for when form validation fails.

Overrides:

oninvalid in class HtmlElementMixed

Returns:

This object.

onkeydown

public Label onkeydown(String value)

Description copied from class: HtmlElement

onkeydown attribute.

Event handler for when a key is pressed down.

Overrides:

onkeydown in class HtmlElementMixed

Returns:

This object.

onkeypress

public Label onkeypress(String value)

Description copied from class: HtmlElement

onkeypress attribute.

Event handler for when a key is pressed (deprecated, use onkeydown instead).

Overrides:

onkeypress in class HtmlElementMixed

Returns:

This object.

onkeyup

public Label onkeyup(String value)

Description copied from class: HtmlElement

onkeyup attribute.

Event handler for when a key is released.

Overrides:

onkeyup in class HtmlElementMixed

Returns:

This object.

onload

public Label onload(String value)

Description copied from class: HtmlElement

onload attribute.

Event handler for when the element and its resources have finished loading.

Note:

If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:

• If using single quotes for attributes: onload("init(\"config\")")
• If using double quotes for attributes: onload("init('config')")

Overrides:

onload in class HtmlElementMixed

Returns:

This object.

onloadeddata

public Label onloadeddata(String value)

Description copied from class: HtmlElement

onloadeddata attribute.

Event handler for when the first frame of media has finished loading.

Overrides:

onloadeddata in class HtmlElementMixed

Returns:

This object.

onloadedmetadata

public Label onloadedmetadata(String value)

Description copied from class: HtmlElement

onloadedmetadata attribute.

Event handler for when metadata (duration, dimensions, etc.) has been loaded.

Overrides:

onloadedmetadata in class HtmlElementMixed

Returns:

This object.

onloadstart

public Label onloadstart(String value)

Description copied from class: HtmlElement

onloadstart attribute.

Event handler for when the browser starts loading the media.

Overrides:

onloadstart in class HtmlElementMixed

Returns:

This object.

onmousedown

public Label onmousedown(String value)

Description copied from class: HtmlElement

onmousedown attribute.

Event handler for when a mouse button is pressed down on the element.

Overrides:

onmousedown in class HtmlElementMixed

Returns:

This object.

onmouseenter

public Label onmouseenter(String value)

Description copied from class: HtmlElement

onmouseenter attribute.

Event handler for when the mouse pointer enters the element (does not bubble).

Overrides:

onmouseenter in class HtmlElementMixed

Returns:

This object.

onmouseleave

public Label onmouseleave(String value)

Description copied from class: HtmlElement

onmouseleave attribute.

Event handler for when the mouse pointer leaves the element (does not bubble).

Overrides:

onmouseleave in class HtmlElementMixed

Returns:

This object.

onmousemove

public Label onmousemove(String value)

Description copied from class: HtmlElement

onmousemove attribute.

Event handler for when the mouse pointer moves over the element.

Overrides:

onmousemove in class HtmlElementMixed

Returns:

This object.

onmouseout

public Label onmouseout(String value)

Description copied from class: HtmlElement

onmouseout attribute.

Event handler for when the mouse pointer moves out of the element (bubbles).

Overrides:

onmouseout in class HtmlElementMixed

Returns:

This object.

onmouseover

public Label onmouseover(String value)

Description copied from class: HtmlElement

onmouseover attribute.

Event handler for when the mouse pointer moves over the element (bubbles).

Note:

If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:

• If using single quotes for attributes: onmouseover("showTooltip(\"info\")")
• If using double quotes for attributes: onmouseover("showTooltip('info')")

Overrides:

onmouseover in class HtmlElementMixed

Returns:

This object.

onmouseup

public Label onmouseup(String value)

Description copied from class: HtmlElement

onmouseup attribute.

Event handler for when a mouse button is released over the element.

Overrides:

onmouseup in class HtmlElementMixed

Returns:

This object.

onmousewheel

public Label onmousewheel(String value)

Description copied from class: HtmlElement

onmousewheel attribute.

Event handler for when the mouse wheel is rotated over the element (deprecated, use onwheel).

Overrides:

onmousewheel in class HtmlElementMixed

Returns:

This object.

onpause

public Label onpause(String value)

Description copied from class: HtmlElement

onpause attribute.

Event handler for when media playback is paused.

Overrides:

onpause in class HtmlElementMixed

Returns:

This object.

onplay

public Label onplay(String value)

Description copied from class: HtmlElement

onplay attribute.

Event handler for when media playback starts.

Overrides:

onplay in class HtmlElementMixed

Returns:

This object.

onplaying

public Label onplaying(String value)

Description copied from class: HtmlElement

onplaying attribute.

Event handler for when media playback starts after being paused or delayed.

Overrides:

onplaying in class HtmlElementMixed

Returns:

This object.

onprogress

public Label onprogress(String value)

Description copied from class: HtmlElement

onprogress attribute.

Event handler for when the browser is downloading media data.

Overrides:

onprogress in class HtmlElementMixed

Returns:

This object.

onratechange

public Label onratechange(String value)

Description copied from class: HtmlElement

onratechange attribute.

Event handler for when the playback rate of media changes.

Overrides:

onratechange in class HtmlElementMixed

Returns:

This object.

onreset

public Label onreset(String value)

Description copied from class: HtmlElement

onreset attribute.

Event handler for when a form is reset.

Overrides:

onreset in class HtmlElementMixed

Returns:

This object.

onresize

public Label onresize(String value)

Description copied from class: HtmlElement

onresize attribute.

Event handler for when the element is resized.

Overrides:

onresize in class HtmlElementMixed

Returns:

This object.

onscroll

public Label onscroll(String value)

Description copied from class: HtmlElement

onscroll attribute.

Event handler for when the element's scrollbar is scrolled.

Overrides:

onscroll in class HtmlElementMixed

Returns:

This object.

onseeked

public Label onseeked(String value)

Description copied from class: HtmlElement

onseeked attribute.

Event handler for when a seek operation completes.

Overrides:

onseeked in class HtmlElementMixed

Returns:

This object.

onseeking

public Label onseeking(String value)

Description copied from class: HtmlElement

onseeking attribute.

Event handler for when a seek operation begins.

Overrides:

onseeking in class HtmlElementMixed

Returns:

This object.

onselect

public Label onselect(String value)

Description copied from class: HtmlElement

onselect attribute.

Event handler for when text is selected in the element.

Overrides:

onselect in class HtmlElementMixed

Returns:

This object.

onshow

public Label onshow(String value)

Description copied from class: HtmlElement

onshow attribute.

Event handler for when a context menu is shown.

Overrides:

onshow in class HtmlElementMixed

Returns:

This object.

onstalled

public Label onstalled(String value)

Description copied from class: HtmlElement

onstalled attribute.

Event handler for when media loading is stalled.

Overrides:

onstalled in class HtmlElementMixed

Returns:

This object.

onsubmit

public Label onsubmit(String value)

Description copied from class: HtmlElement

onsubmit attribute.

Event handler for when a form is submitted.

Note:

If your HTML serializer is configured to use single quotes for attribute values, you should use double quotes in your JavaScript code, and vice versa. Otherwise, the quotes will be converted to HTML entities. For example:

• If using single quotes for attributes: onsubmit("return validate(\"form\")")
• If using double quotes for attributes: onsubmit("return validate('form')")

Overrides:

onsubmit in class HtmlElementMixed

Returns:

This object.

onsuspend

public Label onsuspend(String value)

Description copied from class: HtmlElement

onsuspend attribute.

Event handler for when media loading is suspended.

Overrides:

onsuspend in class HtmlElementMixed

Returns:

This object.

ontimeupdate

public Label ontimeupdate(String value)

Description copied from class: HtmlElement

ontimeupdate attribute.

Event handler for when the current playback position changes.

Overrides:

ontimeupdate in class HtmlElementMixed

Returns:

This object.

ontoggle

public Label ontoggle(String value)

Description copied from class: HtmlElement

ontoggle attribute.

Event handler for when a details element is opened or closed.

Overrides:

ontoggle in class HtmlElementMixed

Returns:

This object.

onvolumechange

public Label onvolumechange(String value)

Description copied from class: HtmlElement

onvolumechange attribute.

Event handler for when the volume of media changes.

Overrides:

onvolumechange in class HtmlElementMixed

Returns:

This object.

onwaiting

public Label onwaiting(String value)

Description copied from class: HtmlElement

onwaiting attribute.

Event handler for when media playback stops to buffer more data.

Overrides:

onwaiting in class HtmlElementMixed

Returns:

This object.

spellcheck

public Label spellcheck(Object value)

Description copied from class: HtmlElement

spellcheck attribute.

Indicates whether the element should have its spelling and grammar checked.

Possible values:

• "true" - Enable spell checking for this element
• "false" - Disable spell checking for this element

Overrides:

spellcheck in class HtmlElementMixed

Returns:

This object.

style

public Label style(String value)

Description copied from class: HtmlElement

style attribute.

Specifies inline CSS styles for the element. The value should be valid CSS property-value pairs separated by semicolons.

Overrides:

style in class HtmlElementMixed

Returns:

This object.

tabindex

public Label tabindex(Object value)

Description copied from class: HtmlElement

tabindex attribute.

Specifies the tab order of the element when navigating with the keyboard.

Possible values:

• Positive integer - Element is focusable and participates in tab order
• "0" - Element is focusable but not in tab order
• Negative integer - Element is not focusable

Overrides:

tabindex in class HtmlElementMixed

Returns:

This object.

title

public Label title(String value)

Description copied from class: HtmlElement

title attribute.

Specifies additional information about the element, typically displayed as a tooltip when the user hovers over the element.

Overrides:

title in class HtmlElementMixed

Returns:

This object.

translate

public Label translate(Object value)

Description copied from class: HtmlElement

translate attribute.

Specifies whether the element's content should be translated when the page is localized.

Possible values:

• "yes" - Content should be translated (default)
• "no" - Content should not be translated

Overrides:

translate in class HtmlElementMixed

Returns:

This object.

child

public Label child(Object value)

Description copied from class: HtmlElementMixed

Adds a child element to this element.

Overrides:

child in class HtmlElementMixed

Returns:

This object.

children

public Label children(Object... value)

Description copied from class: HtmlElementMixed

Adds one or more child elements to this element.

Overrides:

children in class HtmlElementMixed

Returns:

This object.