Package org.apache.juneau.bean.html5

Class HtmlElementText

java.lang.Object
org.apache.juneau.bean.html5.HtmlElement
org.apache.juneau.bean.html5.HtmlElementText
Direct Known Subclasses:
Bdi, Option
public class HtmlElementText extends HtmlElement
A subclass of HTML elements that contain text only.
See Also:

  • Constructor Details

  • Method Details

    • _class

      public HtmlElementText _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 HtmlElement
      Parameters:
      value - Space-separated CSS class names (e.g., "btn btn-primary").
      Returns:
      This object.

    • accesskey

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - The keyboard shortcut character (e.g., "a", "1").
      Returns:
      This object.

    • attr

      public HtmlElementText attr(String key, Object val)
      Description copied from class: HtmlElement
      Adds an arbitrary attribute to this element.
      Overrides:
      attr in class HtmlElement
      Parameters:
      key - The attribute name.
      val - The attribute value.
      Returns:
      This object.

    • attrUri

      public HtmlElementText attrUri(String key, Object val)
      Description copied from class: HtmlElement
      Adds an arbitrary URI attribute to this element.

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

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

      URIs defined by UriResolver can be used for values.

      Overrides:
      attrUri in class HtmlElement
      Parameters:
      key - The attribute name.
      val - The attribute value.
      Returns:
      This object.

    • contenteditable

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - The editability state of the element.
      Returns:
      This object.

    • dir

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - The text direction for the element.
      Returns:
      This object.

    • getText

      @Xml(format=TEXT) @Beanp("c") public Object getText()
      Returns the inner text of this element.
      Returns:
      The inner text of this element, or null if no text is set.

    • hidden

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - The new value for this attribute. Typically a Boolean or String.
      Returns:
      This object.

    • id

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - A unique identifier for the element (e.g., "header", "main-content").
      Returns:
      This object.

    • lang

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - A language tag (e.g., "en", "en-US", "es", "fr-CA").
      Returns:
      This object.

    • onabort

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the abort event occurs.
      Returns:
      This object.

    • onblur

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the element loses focus.
      Returns:
      This object.

    • oncancel

      public HtmlElementText oncancel(String value)
      Description copied from class: HtmlElement
      oncancel attribute.

      Event handler for when a dialog is cancelled.

      Overrides:
      oncancel in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the cancel event occurs.
      Returns:
      This object.

    • oncanplay

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the canplay event occurs.
      Returns:
      This object.

    • oncanplaythrough

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the canplaythrough event occurs.
      Returns:
      This object.

    • onchange

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the change event occurs.
      Returns:
      This object.

    • onclick

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the click event occurs.
      Returns:
      This object.

    • oncuechange

      public HtmlElementText oncuechange(String value)
      Description copied from class: HtmlElement
      oncuechange attribute.

      Event handler for when a text track cue changes.

      Overrides:
      oncuechange in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the cuechange event occurs.
      Returns:
      This object.

    • ondblclick

      public HtmlElementText ondblclick(String value)
      Description copied from class: HtmlElement
      ondblclick attribute.

      Event handler for when the element is double-clicked.

      Overrides:
      ondblclick in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the dblclick event occurs.
      Returns:
      This object.

    • ondurationchange

      public HtmlElementText ondurationchange(String value)
      Description copied from class: HtmlElement
      ondurationchange attribute.

      Event handler for when the duration of the media changes.

      Overrides:
      ondurationchange in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the durationchange event occurs.
      Returns:
      This object.

    • onemptied

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the emptied event occurs.
      Returns:
      This object.

    • onended

      public HtmlElementText onended(String value)
      Description copied from class: HtmlElement
      onended attribute.

      Event handler for when the media playback reaches the end.

      Overrides:
      onended in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the ended event occurs.
      Returns:
      This object.

    • onerror

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the error event occurs.
      Returns:
      This object.

    • onfocus

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the focus event occurs.
      Returns:
      This object.

    • oninput

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the input event occurs.
      Returns:
      This object.

    • oninvalid

      public HtmlElementText oninvalid(String value)
      Description copied from class: HtmlElement
      oninvalid attribute.

      Event handler for when form validation fails.

      Overrides:
      oninvalid in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the invalid event occurs.
      Returns:
      This object.

    • onkeydown

      public HtmlElementText onkeydown(String value)
      Description copied from class: HtmlElement
      onkeydown attribute.

      Event handler for when a key is pressed down.

      Overrides:
      onkeydown in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the keydown event occurs.
      Returns:
      This object.

    • onkeypress

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the keypress event occurs.
      Returns:
      This object.

    • onkeyup

      public HtmlElementText onkeyup(String value)
      Description copied from class: HtmlElement
      onkeyup attribute.

      Event handler for when a key is released.

      Overrides:
      onkeyup in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the keyup event occurs.
      Returns:
      This object.

    • onload

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the load event occurs.
      Returns:
      This object.

    • onloadeddata

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the loadeddata event occurs.
      Returns:
      This object.

    • onloadedmetadata

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the loadedmetadata event occurs.
      Returns:
      This object.

    • onloadstart

      public HtmlElementText onloadstart(String value)
      Description copied from class: HtmlElement
      onloadstart attribute.

      Event handler for when the browser starts loading the media.

      Overrides:
      onloadstart in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the loadstart event occurs.
      Returns:
      This object.

    • onmousedown

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mousedown event occurs.
      Returns:
      This object.

    • onmouseenter

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mouseenter event occurs.
      Returns:
      This object.

    • onmouseleave

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mouseleave event occurs.
      Returns:
      This object.

    • onmousemove

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mousemove event occurs.
      Returns:
      This object.

    • onmouseout

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mouseout event occurs.
      Returns:
      This object.

    • onmouseover

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mouseover event occurs.
      Returns:
      This object.

    • onmouseup

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mouseup event occurs.
      Returns:
      This object.

    • onmousewheel

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the mousewheel event occurs.
      Returns:
      This object.

    • onpause

      public HtmlElementText onpause(String value)
      Description copied from class: HtmlElement
      onpause attribute.

      Event handler for when media playback is paused.

      Overrides:
      onpause in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the pause event occurs.
      Returns:
      This object.

    • onplay

      public HtmlElementText onplay(String value)
      Description copied from class: HtmlElement
      onplay attribute.

      Event handler for when media playback starts.

      Overrides:
      onplay in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the play event occurs.
      Returns:
      This object.

    • onplaying

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the playing event occurs.
      Returns:
      This object.

    • onprogress

      public HtmlElementText onprogress(String value)
      Description copied from class: HtmlElement
      onprogress attribute.

      Event handler for when the browser is downloading media data.

      Overrides:
      onprogress in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the progress event occurs.
      Returns:
      This object.

    • onratechange

      public HtmlElementText onratechange(String value)
      Description copied from class: HtmlElement
      onratechange attribute.

      Event handler for when the playback rate of media changes.

      Overrides:
      onratechange in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the ratechange event occurs.
      Returns:
      This object.

    • onreset

      public HtmlElementText onreset(String value)
      Description copied from class: HtmlElement
      onreset attribute.

      Event handler for when a form is reset.

      Overrides:
      onreset in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the reset event occurs.
      Returns:
      This object.

    • onresize

      public HtmlElementText onresize(String value)
      Description copied from class: HtmlElement
      onresize attribute.

      Event handler for when the element is resized.

      Overrides:
      onresize in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the resize event occurs.
      Returns:
      This object.

    • onscroll

      public HtmlElementText onscroll(String value)
      Description copied from class: HtmlElement
      onscroll attribute.

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

      Overrides:
      onscroll in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the scroll event occurs.
      Returns:
      This object.

    • onseeked

      public HtmlElementText onseeked(String value)
      Description copied from class: HtmlElement
      onseeked attribute.

      Event handler for when a seek operation completes.

      Overrides:
      onseeked in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the seeked event occurs.
      Returns:
      This object.

    • onseeking

      public HtmlElementText onseeking(String value)
      Description copied from class: HtmlElement
      onseeking attribute.

      Event handler for when a seek operation begins.

      Overrides:
      onseeking in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the seeking event occurs.
      Returns:
      This object.

    • onselect

      public HtmlElementText onselect(String value)
      Description copied from class: HtmlElement
      onselect attribute.

      Event handler for when text is selected in the element.

      Overrides:
      onselect in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the select event occurs.
      Returns:
      This object.

    • onshow

      public HtmlElementText onshow(String value)
      Description copied from class: HtmlElement
      onshow attribute.

      Event handler for when a context menu is shown.

      Overrides:
      onshow in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the show event occurs.
      Returns:
      This object.

    • onstalled

      public HtmlElementText onstalled(String value)
      Description copied from class: HtmlElement
      onstalled attribute.

      Event handler for when media loading is stalled.

      Overrides:
      onstalled in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the stalled event occurs.
      Returns:
      This object.

    • onsubmit

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the submit event occurs.
      Returns:
      This object.

    • onsuspend

      public HtmlElementText onsuspend(String value)
      Description copied from class: HtmlElement
      onsuspend attribute.

      Event handler for when media loading is suspended.

      Overrides:
      onsuspend in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the suspend event occurs.
      Returns:
      This object.

    • ontimeupdate

      public HtmlElementText ontimeupdate(String value)
      Description copied from class: HtmlElement
      ontimeupdate attribute.

      Event handler for when the current playback position changes.

      Overrides:
      ontimeupdate in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the timeupdate event occurs.
      Returns:
      This object.

    • ontoggle

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the toggle event occurs.
      Returns:
      This object.

    • onvolumechange

      public HtmlElementText onvolumechange(String value)
      Description copied from class: HtmlElement
      onvolumechange attribute.

      Event handler for when the volume of media changes.

      Overrides:
      onvolumechange in class HtmlElement
      Parameters:
      value - JavaScript code to execute when the volumechange event occurs.
      Returns:
      This object.

    • onwaiting

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - JavaScript code to execute when the waiting event occurs.
      Returns:
      This object.

    • setText

      @Beanp("c") public HtmlElement setText(Object text)
      Sets the inner text of this element.
      Parameters:
      text - The inner text of this element, or null if no text is set.
      Returns:
      This object.

    • spellcheck

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - Whether spell checking should be enabled.
      Returns:
      This object.

    • style

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - Inline CSS styles (e.g., "color: red; font-size: 14px;").
      Returns:
      This object.

    • tabindex

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - The tab order value for keyboard navigation.
      Returns:
      This object.

    • text

      public HtmlElement text(Object value)
      Sets the text node on this element.
      Parameters:
      value - The text node to add to this element.
      Returns:
      This object.

    • title

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - Tooltip text to display on hover (e.g., "Click to submit form").
      Returns:
      This object.

    • translate

      public HtmlElementText 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 HtmlElement
      Parameters:
      value - Whether the element content should be translated.
      Returns:
      This object.