Package org.apache.juneau.bean.html5

Class Kbd

java.lang.Object

org.apache.juneau.bean.html5.HtmlElement

org.apache.juneau.bean.html5.HtmlElementMixed

org.apache.juneau.bean.html5.Kbd

@Bean(typeName="kbd")
public class Kbd
extends HtmlElementMixed

DTO for an HTML <kbd> element.

The kbd element represents user input, typically keyboard input but can also represent other types of input such as voice commands or menu selections. It is commonly styled with a monospace font to distinguish it from regular text and often appears in documentation, tutorials, and help pages.

Examples:

// Simple keyboard shortcut Kbd simple = kbd("Ctrl+S"); // Keyboard combination with nested kbd elements P shortcut = p( "Press ", kbd("Ctrl"), " + ", kbd("C"), " to copy." ); // Menu selection instruction P menu = p( "Select ", kbd("File"), " → ", kbd("Save As...") ); // Command line input P command = p( "Type ", kbd("npm install"), " to install dependencies." ); // With styling Kbd styled = kbd("Enter") ._class("key-highlight") .title("Press Enter to submit"); // Multiple key sequence P sequence = p( "To exit, press ", kbd("Esc"), " or ", kbd("Ctrl"), " + ", kbd("Q") );

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

• HtmlBuilder
  • kbd()
  • kbd(Object, Object...)

See Also:

• juneau-bean-html5

Constructor Summary

Constructors

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

Method Summary

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

Kbd

public Kbd()

Creates an empty Kbd element.

Kbd

public Kbd(Object... children)

Creates a Kbd element with the specified child nodes.

Parameters:

children - The child nodes.

Method Details

_class

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