Class HtmlInputSecret
- java.lang.Object
- 
- jakarta.faces.component.UIComponent
- 
- jakarta.faces.component.UIComponentBase
- 
- jakarta.faces.component.UIOutput
- 
- jakarta.faces.component.UIInput
- 
- jakarta.faces.component.html.HtmlInputSecret
 
 
 
 
 
- 
- All Implemented Interfaces:
- ClientBehaviorHolder,- EditableValueHolder,- PartialStateHolder,- StateHolder,- TransientStateHolder,- ValueHolder,- ComponentSystemEventListener,- FacesListener,- SystemEventListenerHolder,- EventListener
 
 public class HtmlInputSecret extends UIInput implements ClientBehaviorHolder Represents an HTML inputelement of typepassword. On a redisplay, any previously entered value will not be rendered (for security reasons) unless theredisplayproperty is set totrue.By default, the rendererTypeproperty must be set to "jakarta.faces.Secret". This value can be changed by calling thesetRendererType()method.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description protected static classHtmlInputSecret.PropertyKeysProperties used by this component
 - 
Field SummaryFields Modifier and Type Field Description static StringCOMPONENT_TYPEThe standard component type for this component.- 
Fields inherited from class jakarta.faces.component.UIInputALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME
 - 
Fields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
 
- 
 - 
Constructor SummaryConstructors Constructor Description HtmlInputSecret()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StringgetAccesskey()Return the value of theaccesskeyproperty.StringgetAlt()Deprecated, for removal: This API element is subject to removal in a future version.This attribute is actually not specified in HTML.StringgetAutocomplete()Return the value of theautocompleteproperty.StringgetDefaultEventName()This is a default implementation ofClientBehaviorHolder.getDefaultEventName().StringgetDir()Return the value of thedirproperty.Collection<String>getEventNames()This is a default implementation ofClientBehaviorHolder.getEventNames().StringgetLabel()Return the value of thelabelproperty.StringgetLang()Return the value of thelangproperty.intgetMaxlength()Return the value of themaxlengthproperty.StringgetOnblur()Return the value of theonblurproperty.StringgetOnchange()Return the value of theonchangeproperty.StringgetOnclick()Return the value of theonclickproperty.StringgetOndblclick()Return the value of theondblclickproperty.StringgetOnfocus()Return the value of theonfocusproperty.StringgetOnkeydown()Return the value of theonkeydownproperty.StringgetOnkeypress()Return the value of theonkeypressproperty.StringgetOnkeyup()Return the value of theonkeyupproperty.StringgetOnmousedown()Return the value of theonmousedownproperty.StringgetOnmousemove()Return the value of theonmousemoveproperty.StringgetOnmouseout()Return the value of theonmouseoutproperty.StringgetOnmouseover()Return the value of theonmouseoverproperty.StringgetOnmouseup()Return the value of theonmouseupproperty.StringgetOnselect()Return the value of theonselectproperty.StringgetRole()Return the value of theroleproperty.intgetSize()Return the value of thesizeproperty.StringgetStyle()Return the value of thestyleproperty.StringgetStyleClass()Return the value of thestyleClassproperty.StringgetTabindex()Return the value of thetabindexproperty.StringgetTitle()Return the value of thetitleproperty.booleanisDisabled()Return the value of thedisabledproperty.booleanisReadonly()Return the value of thereadonlyproperty.booleanisRedisplay()Return the value of theredisplayproperty.voidsetAccesskey(String accesskey)Set the value of theaccesskeyproperty.voidsetAlt(String alt)Deprecated, for removal: This API element is subject to removal in a future version.This attribute is actually not specified in HTML.voidsetAutocomplete(String autocomplete)Set the value of theautocompleteproperty.voidsetDir(String dir)Set the value of thedirproperty.voidsetDisabled(boolean disabled)Set the value of thedisabledproperty.voidsetLabel(String label)Set the value of thelabelproperty.voidsetLang(String lang)Set the value of thelangproperty.voidsetMaxlength(int maxlength)Set the value of themaxlengthproperty.voidsetOnblur(String onblur)Set the value of theonblurproperty.voidsetOnchange(String onchange)Set the value of theonchangeproperty.voidsetOnclick(String onclick)Set the value of theonclickproperty.voidsetOndblclick(String ondblclick)Set the value of theondblclickproperty.voidsetOnfocus(String onfocus)Set the value of theonfocusproperty.voidsetOnkeydown(String onkeydown)Set the value of theonkeydownproperty.voidsetOnkeypress(String onkeypress)Set the value of theonkeypressproperty.voidsetOnkeyup(String onkeyup)Set the value of theonkeyupproperty.voidsetOnmousedown(String onmousedown)Set the value of theonmousedownproperty.voidsetOnmousemove(String onmousemove)Set the value of theonmousemoveproperty.voidsetOnmouseout(String onmouseout)Set the value of theonmouseoutproperty.voidsetOnmouseover(String onmouseover)Set the value of theonmouseoverproperty.voidsetOnmouseup(String onmouseup)Set the value of theonmouseupproperty.voidsetOnselect(String onselect)Set the value of theonselectproperty.voidsetReadonly(boolean readonly)Set the value of thereadonlyproperty.voidsetRedisplay(boolean redisplay)Set the value of theredisplayproperty.voidsetRole(String role)Set the value of theroleproperty.voidsetSize(int size)Set the value of thesizeproperty.voidsetStyle(String style)Set the value of thestyleproperty.voidsetStyleClass(String styleClass)Set the value of thestyleClassproperty.voidsetTabindex(String tabindex)Set the value of thetabindexproperty.voidsetTitle(String title)Set the value of thetitleproperty.- 
Methods inherited from class jakarta.faces.component.UIInputaddValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidatorMessage, getValidators, getValue, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidatorMessage, setValue, updateModel, validate, validateValue
 - 
Methods inherited from class jakarta.faces.component.UIOutputgetConverter, getLocalValue, setConverter
 - 
Methods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent
 - 
Methods inherited from class jakarta.faces.component.UIComponentencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolderaddClientBehavior, getClientBehaviors
 - 
Methods inherited from interface jakarta.faces.component.ValueHoldergetConverter, getLocalValue, setConverter
 
- 
 
- 
- 
- 
Field Detail- 
COMPONENT_TYPEpublic static final String COMPONENT_TYPE The standard component type for this component. - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getAccesskeypublic String getAccesskey() Return the value of the accesskeyproperty.- Returns:
- the property value
 Contents: Access key that, when pressed, transfers focus to this element. 
 
 - 
setAccesskeypublic void setAccesskey(String accesskey) Set the value of the accesskeyproperty.- Parameters:
- accesskey- the new property value
 
 - 
getAlt@Deprecated(since="4.0", forRemoval=true) public String getAlt() Deprecated, for removal: This API element is subject to removal in a future version.This attribute is actually not specified in HTML. Do not use it on this component.Return the value of the altproperty.- Returns:
- the property value
 Contents: Alternate textual description of the element rendered by this component. 
 
 - 
setAlt@Deprecated(since="4.0", forRemoval=true) public void setAlt(String alt) Deprecated, for removal: This API element is subject to removal in a future version.This attribute is actually not specified in HTML. Do not use it on this component.Set the value of the altproperty.- Parameters:
- alt- the new property value
 
 - 
getAutocompletepublic String getAutocomplete() Return the value of the autocompleteproperty.- 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. 
 
 - 
setAutocompletepublic void setAutocomplete(String autocomplete) Set the value of the autocompleteproperty.- Parameters:
- autocomplete- the new property value
 
 - 
getDirpublic String getDir() Return the value of the dirproperty.- 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. 
 
 - 
setDirpublic void setDir(String dir) Set the value of the dirproperty.- Parameters:
- dir- the new property value
 
 - 
isDisabledpublic boolean isDisabled() Return the value of the disabledproperty.- 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". 
 
 - 
setDisabledpublic void setDisabled(boolean disabled) Set the value of the disabledproperty.- Parameters:
- disabled- the new property value
 
 - 
getLabelpublic String getLabel() Return the value of the labelproperty.- Returns:
- the property value
 Contents: A localized user presentable name for this component. 
 
 - 
setLabelpublic void setLabel(String label) Set the value of the labelproperty.- Parameters:
- label- the new property value
 
 - 
getLangpublic String getLang() Return the value of the langproperty.- Returns:
- the property value
 Contents: Code describing the language used in the generated markup for this component. 
 
 - 
setLangpublic void setLang(String lang) Set the value of the langproperty.- Parameters:
- lang- the new property value
 
 - 
getMaxlengthpublic int getMaxlength() Return the value of the maxlengthproperty.- Returns:
- the property value
 Contents: The maximum number of characters that may be entered in this field. 
 
 - 
setMaxlengthpublic void setMaxlength(int maxlength) Set the value of the maxlengthproperty.- Parameters:
- maxlength- the new property value
 
 - 
getOnblurpublic String getOnblur() Return the value of the onblurproperty.- Returns:
- the property value
 Contents: Javascript code executed when this element loses focus. 
 
 - 
setOnblurpublic void setOnblur(String onblur) Set the value of the onblurproperty.- Parameters:
- onblur- the new property value
 
 - 
getOnchangepublic String getOnchange() Return the value of the onchangeproperty.- Returns:
- the property value
 Contents: Javascript code executed when this element loses focus and its value has been modified since gaining focus. 
 
 - 
setOnchangepublic void setOnchange(String onchange) Set the value of the onchangeproperty.- Parameters:
- onchange- the new property value
 
 - 
getOnclickpublic String getOnclick() Return the value of the onclickproperty.- Returns:
- the property value
 Contents: Javascript code executed when a pointer button is clicked over this element. 
 
 - 
setOnclickpublic void setOnclick(String onclick) Set the value of the onclickproperty.- Parameters:
- onclick- the new property value
 
 - 
getOndblclickpublic String getOndblclick() Return the value of the ondblclickproperty.- Returns:
- the property value
 Contents: Javascript code executed when a pointer button is double clicked over this element. 
 
 - 
setOndblclickpublic void setOndblclick(String ondblclick) Set the value of the ondblclickproperty.- Parameters:
- ondblclick- the new property value
 
 - 
getOnfocuspublic String getOnfocus() Return the value of the onfocusproperty.- Returns:
- the property value
 Contents: Javascript code executed when this element receives focus. 
 
 - 
setOnfocuspublic void setOnfocus(String onfocus) Set the value of the onfocusproperty.- Parameters:
- onfocus- the new property value
 
 - 
getOnkeydownpublic String getOnkeydown() Return the value of the onkeydownproperty.- Returns:
- the property value
 Contents: Javascript code executed when a key is pressed down over this element. 
 
 - 
setOnkeydownpublic void setOnkeydown(String onkeydown) Set the value of the onkeydownproperty.- Parameters:
- onkeydown- the new property value
 
 - 
getOnkeypresspublic String getOnkeypress() Return the value of the onkeypressproperty.- Returns:
- the property value
 Contents: Javascript code executed when a key is pressed and released over this element. 
 
 - 
setOnkeypresspublic void setOnkeypress(String onkeypress) Set the value of the onkeypressproperty.- Parameters:
- onkeypress- the new property value
 
 - 
getOnkeyuppublic String getOnkeyup() Return the value of the onkeyupproperty.- Returns:
- the property value
 Contents: Javascript code executed when a key is released over this element. 
 
 - 
setOnkeyuppublic void setOnkeyup(String onkeyup) Set the value of the onkeyupproperty.- Parameters:
- onkeyup- the new property value
 
 - 
getOnmousedownpublic String getOnmousedown() Return the value of the onmousedownproperty.- Returns:
- the property value
 Contents: Javascript code executed when a pointer button is pressed down over this element. 
 
 - 
setOnmousedownpublic void setOnmousedown(String onmousedown) Set the value of the onmousedownproperty.- Parameters:
- onmousedown- the new property value
 
 - 
getOnmousemovepublic String getOnmousemove() Return the value of the onmousemoveproperty.- Returns:
- the property value
 Contents: Javascript code executed when a pointer button is moved within this element. 
 
 - 
setOnmousemovepublic void setOnmousemove(String onmousemove) Set the value of the onmousemoveproperty.- Parameters:
- onmousemove- the new property value
 
 - 
getOnmouseoutpublic String getOnmouseout() Return the value of the onmouseoutproperty.- Returns:
- the property value
 Contents: Javascript code executed when a pointer button is moved away from this element. 
 
 - 
setOnmouseoutpublic void setOnmouseout(String onmouseout) Set the value of the onmouseoutproperty.- Parameters:
- onmouseout- the new property value
 
 - 
getOnmouseoverpublic String getOnmouseover() Return the value of the onmouseoverproperty.- Returns:
- the property value
 Contents: Javascript code executed when a pointer button is moved onto this element. 
 
 - 
setOnmouseoverpublic void setOnmouseover(String onmouseover) Set the value of the onmouseoverproperty.- Parameters:
- onmouseover- the new property value
 
 - 
getOnmouseuppublic String getOnmouseup() Return the value of the onmouseupproperty.- Returns:
- the property value
 Contents: Javascript code executed when a pointer button is released over this element. 
 
 - 
setOnmouseuppublic void setOnmouseup(String onmouseup) Set the value of the onmouseupproperty.- Parameters:
- onmouseup- the new property value
 
 - 
getOnselectpublic String getOnselect() Return the value of the onselectproperty.- Returns:
- the property value
 Contents: Javascript code executed when text within this element is selected by the user. 
 
 - 
setOnselectpublic void setOnselect(String onselect) Set the value of the onselectproperty.- Parameters:
- onselect- the new property value
 
 - 
isReadonlypublic boolean isReadonly() Return the value of the readonlyproperty.- 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". 
 
 - 
setReadonlypublic void setReadonly(boolean readonly) Set the value of the readonlyproperty.- Parameters:
- readonly- the new property value
 
 - 
isRedisplaypublic boolean isRedisplay() Return the value of the redisplayproperty.- Returns:
- the property value
 Contents: Flag indicating that any existing value in this field should be rendered when the form is created. Because this is a potential security risk, password values are not displayed by default. 
 
 - 
setRedisplaypublic void setRedisplay(boolean redisplay) Set the value of the redisplayproperty.- Parameters:
- redisplay- the new property value
 
 - 
getRolepublic String getRole() Return the value of the roleproperty.- 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. 
 
 - 
setRolepublic void setRole(String role) Set the value of the roleproperty.- Parameters:
- role- the new property value
 
 - 
getSizepublic int getSize() Return the value of the sizeproperty.- Returns:
- the property value
 Contents: The number of characters used to determine the width of this field. 
 
 - 
setSizepublic void setSize(int size) Set the value of the sizeproperty.- Parameters:
- size- the new property value
 
 - 
getStylepublic String getStyle() Return the value of the styleproperty.- Returns:
- the property value
 Contents: CSS style(s) to be applied when this component is rendered. 
 
 - 
setStylepublic void setStyle(String style) Set the value of the styleproperty.- Parameters:
- style- the new property value
 
 - 
getStyleClasspublic String getStyleClass() Return the value of the styleClassproperty.- 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. 
 
 - 
setStyleClasspublic void setStyleClass(String styleClass) Set the value of the styleClassproperty.- Parameters:
- styleClass- the new property value
 
 - 
getTabindexpublic String getTabindex() Return the value of the tabindexproperty.- 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. 
 
 - 
setTabindexpublic void setTabindex(String tabindex) Set the value of the tabindexproperty.- Parameters:
- tabindex- the new property value
 
 - 
getTitlepublic String getTitle() Return the value of the titleproperty.- Returns:
- the property value
 Contents: Advisory title information about markup elements generated for this component. 
 
 - 
setTitlepublic void setTitle(String title) Set the value of the titleproperty.- Parameters:
- title- the new property value
 
 - 
getEventNamespublic Collection<String> getEventNames() Description copied from class:UIComponentBaseThis is a default implementation of ClientBehaviorHolder.getEventNames().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must override this method to return a non-EmptyCollectionof the client event names that the component supports.- Specified by:
- getEventNamesin interface- ClientBehaviorHolder
- Overrides:
- getEventNamesin class- UIComponentBase
- Returns:
- the collection of event names.
 
 - 
getDefaultEventNamepublic String getDefaultEventName() Description copied from class:UIComponentBaseThis is a default implementation of ClientBehaviorHolder.getDefaultEventName().UIComponentdoes not implement theClientBehaviorHolderinterface, but provides default implementations for the methods defined byClientBehaviorHolderto simplify subclass implementations. Subclasses that wish to support theClientBehaviorHoldercontract must declare that the subclass implementsClientBehaviorHolder, and must provide an implementation ofClientBehaviorHolder.getEventNames().- Specified by:
- getDefaultEventNamein interface- ClientBehaviorHolder
- Overrides:
- getDefaultEventNamein class- UIComponentBase
- Returns:
- the default event name.
 
 
- 
 
-