Package org.apache.juneau.bean.html5

Class Legend

java.lang.Object

org.apache.juneau.bean.html5.HtmlElement

org.apache.juneau.bean.html5.HtmlElementMixed

org.apache.juneau.bean.html5.Legend

@Bean(typeName="legend")
public class Legend
extends HtmlElementMixed

DTO for an HTML <legend> element.

The legend element represents a caption for the content of its parent fieldset element. It is used to provide a title or description for a group of form controls that are contained within a fieldset. The legend element should be placed as the first child of a fieldset element and is typically rendered above or to the side of the fieldset content, often with special styling to distinguish it from the form controls.

Examples:

import static org.apache.juneau.bean.html5.HtmlBuilder.*; // Simple legend Legend simple = legend("Personal Information"); // Legend with styling Legend styled = legend("Contact Details") ._class("form-legend"); // Legend with complex content Legend complex = legend( "Step 1: ", strong("Basic Information"), " ", em("(Required)") ); // Legend with ID Legend withId = legend("Form Legend") .id("form-legend"); // Legend with styling Legend styled2 = legend("Styled Legend") .style("color: #333; font-weight: bold; padding: 0 10px;"); // Legend with multiple elements Legend multiple = legend( "Section 1: ", span("User Details")._class("section-title"), " ", small("(All fields required)") ); // Legend with links Legend withLinks = legend( "Help: ", a("/help/forms", "Form Guide") );

The following convenience methods are provided for constructing instances of this bean:

• HtmlBuilder
  • legend()
  • legend(Object, Object...)

See Also:

• juneau-bean-html5

Constructor Summary

Constructors

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

Method Summary

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

Legend

public Legend()

Creates an empty Legend element.

Legend

public Legend(Object... children)

Creates a Legend element with the specified child nodes.

Parameters:

children - The child nodes.

Method Details

_class

public Legend _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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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 Legend 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.