Top Description Inners Fields Constructors Methods
jakarta.faces.component.html

public Class HtmlInputText

extends UIInput
implements ClientBehaviorHolder
Class Inheritance
All Implemented Interfaces
jakarta.faces.component.behavior.ClientBehaviorHolder
Static Imports
jakarta.faces.component.html.HtmlComponentUtils.handleAttribute

Represents an HTML input element of type text.

By default, the rendererType property must be set to "jakarta.faces.Text". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum
HtmlInputText.PropertyKeys

The property keys.

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_TYPE

Hides jakarta.faces.component.UIInput.COMPONENT_TYPE.

The standard component type for this component.

private static final Collection<String>
Inherited from jakarta.faces.component.UIInput:
ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUECOMPONENT_FAMILYCONVERSION_MESSAGE_IDEMPTY_STRING_AS_NULL_PARAM_NAMEREQUIRED_MESSAGE_IDUPDATE_MESSAGE_IDVALIDATE_EMPTY_FIELDS_PARAM_NAME

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the property value

Contents: Access key that, when pressed, transfers focus to this element.

getAccesskey
()

Return the value of the accesskey property.

public String

Returns:

the property value

Contents: Alternate textual description of the element rendered by this component.

getAlt
()

Return the value of the alt property.

public String

Returns:

the property value

Contents: If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing.

getAutocomplete
()

Return the value of the autocomplete property.

public String
getDefaultEventName()

Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation.

public String

Returns:

the property value

Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.

getDir
()

Return the value of the dir property.

public Collection<String>
getEventNames()

Overrides jakarta.faces.component.UIComponentBase.getEventNames.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

public String

Returns:

the property value

Contents: A localized user presentable name for this component.

getLabel
()

Return the value of the label property.

public String

Returns:

the property value

Contents: Code describing the language used in the generated markup for this component.

getLang
()

Return the value of the lang property.

public int

Returns:

the property value

Contents: The maximum number of characters that may be entered in this field.

getMaxlength
()

Return the value of the maxlength property.

public String

Returns:

the property value

Contents: Javascript code executed when this element loses focus.

getOnblur
()

Return the value of the onblur property.

public String

Returns:

the property value

Contents: Javascript code executed when this element loses focus and its value has been modified since gaining focus.

getOnchange
()

Return the value of the onchange property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is clicked over this element.

getOnclick
()

Return the value of the onclick property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is double clicked over this element.

getOndblclick
()

Return the value of the ondblclick property.

public String

Returns:

the property value

Contents: Javascript code executed when this element receives focus.

getOnfocus
()

Return the value of the onfocus property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed down over this element.

getOnkeydown
()

Return the value of the onkeydown property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is pressed and released over this element.

getOnkeypress
()

Return the value of the onkeypress property.

public String

Returns:

the property value

Contents: Javascript code executed when a key is released over this element.

getOnkeyup
()

Return the value of the onkeyup property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is pressed down over this element.

getOnmousedown
()

Return the value of the onmousedown property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved within this element.

getOnmousemove
()

Return the value of the onmousemove property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved away from this element.

getOnmouseout
()

Return the value of the onmouseout property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is moved onto this element.

getOnmouseover
()

Return the value of the onmouseover property.

public String

Returns:

the property value

Contents: Javascript code executed when a pointer button is released over this element.

getOnmouseup
()

Return the value of the onmouseup property.

public String

Returns:

the property value

Contents: Javascript code executed when text within this element is selected by the user.

getOnselect
()

Return the value of the onselect property.

public String

Returns:

the property value

Contents:

Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to.

It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

getRole
()

Return the value of the role property.

public int

Returns:

the property value

Contents: The number of characters used to determine the width of this field.

getSize
()

Return the value of the size property.

public String

Returns:

the property value

Contents: CSS style(s) to be applied when this component is rendered.

getStyle
()

Return the value of the style property.

public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

getStyleClass
()

Return the value of the styleClass property.

public String

Returns:

the property value

Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.

getTabindex
()

Return the value of the tabindex property.

public String

Returns:

the property value

Contents: Advisory title information about markup elements generated for this component.

getTitle
()

Return the value of the title property.

public String

Returns:

the property value

Contents: Controls the data type and associated control of the element. Default value is text.

If a value is specified for which already a more specific component exist, such as hidden, password, checkbox, radio, file, submit, image, reset and button, and the ProjectStage is set to Development, then the renderer must add a warning message stating that the more specific component should be preferred.

getType
()

Return the value of the type property.

public boolean

Returns:

the property value

Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled".

isDisabled
()

Return the value of the disabled property.

public boolean

Returns:

the property value

Contents: Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly".

isReadonly
()

Return the value of the readonly property.

public void
setAccesskey(String
the new property value
accesskey
)

Set the value of the accesskey property.

public void
setAlt(String
the new property value
alt
)

Set the value of the alt property.

public void
setAutocomplete(String
the new property value
autocomplete
)

Set the value of the autocomplete property.

public void
setDir(String
the new property value
dir
)

Set the value of the dir property.

public void
setDisabled(boolean
the new property value
disabled
)

Set the value of the disabled property.

public void
setLabel(String
the new property value
label
)

Set the value of the label property.

public void
setLang(String
the new property value
lang
)

Set the value of the lang property.

public void
setMaxlength(int
the new property value
maxlength
)

Set the value of the maxlength property.

public void
setOnblur(String
the new property value
onblur
)

Set the value of the onblur property.

public void
setOnchange(String
the new property value
onchange
)

Set the value of the onchange property.

public void
setOnclick(String
the new property value
onclick
)

Set the value of the onclick property.

public void
setOndblclick(String
the new property value
ondblclick
)

Set the value of the ondblclick property.

public void
setOnfocus(String
the new property value
onfocus
)

Set the value of the onfocus property.

public void
setOnkeydown(String
the new property value
onkeydown
)

Set the value of the onkeydown property.

public void
setOnkeypress(String
the new property value
onkeypress
)

Set the value of the onkeypress property.

public void
setOnkeyup(String
the new property value
onkeyup
)

Set the value of the onkeyup property.

public void
setOnmousedown(String
the new property value
onmousedown
)

Set the value of the onmousedown property.

public void
setOnmousemove(String
the new property value
onmousemove
)

Set the value of the onmousemove property.

public void
setOnmouseout(String
the new property value
onmouseout
)

Set the value of the onmouseout property.

public void
setOnmouseover(String
the new property value
onmouseover
)

Set the value of the onmouseover property.

public void
setOnmouseup(String
the new property value
onmouseup
)

Set the value of the onmouseup property.

public void
setOnselect(String
the new property value
onselect
)

Set the value of the onselect property.

public void
setReadonly(boolean
the new property value
readonly
)

Set the value of the readonly property.

public void
setRole(String
the new property value
role
)

Set the value of the role property.

public void
setSize(int
the new property value
size
)

Set the value of the size property.

public void
setStyle(String
the new property value
style
)

Set the value of the style property.

public void
setStyleClass(String
the new property value
styleClass
)

Set the value of the styleClass property.

public void
setTabindex(String
the new property value
tabindex
)

Set the value of the tabindex property.

public void
setTitle(String
the new property value
title
)

Set the value of the title property.

public void
setType(String
the new property value
type
)

Set the value of the type property.

Inherited from jakarta.faces.component.UIInput:
addValidatoraddValueChangeListenerclearInitialStatecompareValuesdecodegetConvertedValuegetConverterMessagegetFamilygetRequiredMessagegetSubmittedValuegetValidatorMessagegetValidatorsgetValuegetValueChangeListenersisEmptyisImmediateisLocalValueSetisRequiredisValidmarkInitialStateprocessDecodesprocessUpdatesprocessValidatorsremoveValidatorremoveValueChangeListenerresetValuerestoreStatesaveStatesetConverterMessagesetImmediatesetLocalValueSetsetRequiredsetRequiredMessagesetSubmittedValuesetValidsetValidatorMessagesetValueupdateModelvalidatevalidateValue