webuijsf
Tag passwordField


Use the webuijsf:passwordField tag to create an input field where the characters entered are echoed back with a replacement character, so as to mask the input. PasswordField can be bound to the server side expressions, but for the security purposes it will never render server-side data as part of the field but will display empty field instead.

HTML Elements and Layout

PasswordField inherits most of the functionality(with the exception of refresh, submit and autoValidate) and attributes from TextField. See webuijsf:textField component description for details and examples.

Configuring the webuijsf:passwordField Tag

See webuijsf:textField component description for additional details and examples. With the exception for refresh, submit and autoValidate, all of the usage and attribute examples for textField can be used with editField by replacing tag into webuijsf:textField .

Client Side Javascript Functions

When the component is rendered, a DOM object corresponding to the component is created. To manipulate the component on the client side, you may invoke functions on the DOM object. With reference to the DOM id, to disable the component, invoke document.getElementById(id).setProps({disabled: true}).

getInputElement() Use this function to access the HTML <input> element that is rendered by the component.
getProps() Use this function to get widget properties. Please see setProps() function for a list of supported properties.
setProps(props) Use this function to change any of the following supported properties:
  • accesskey
  • autoSave
  • className
  • dir
  • disabled
  • id
  • label
  • lang
  • onClick
  • onDblClick
  • onFocus
  • onKeyDown
  • onKeyPress
  • onKeyUp
  • onMouseDown
  • onMouseMove
  • onMouseOut
  • onMouseOver
  • onMouseUp
  • readOnly
  • required
  • size
  • style
  • tabIndex
  • title
  • valid
  • value
  • visible
subscribe(topic, obj, func) Use this function to subscribe to an event topic.
  • topic: The event topic to subscribe to.
  • obj: The object in which a function will be invoked, or null for default scope.
  • func The name of a function in context, or a function reference to invoke when topic is published.


Examples

Example 1: Update client-side editableField properties using the getProps and setProps functions

This example shows how to toggle the disabled state of a editable field client side using the getProps and setProps functions. When the user clicks the radio button, the text field is either disabled or enabled.
<webuijsf:radioButton id="rb1" name="rb1" label="Toggle Field Disabled" onClick="toggleDisabled()"/>
<webuijsf:passwordField id="field1" text="My Text Field" />

<webuijsf:script>
function toggleDisabled() {
var domNode = document.getElementById("form1:field1"); // Get field
return domNode.setProps({disabled: !domNode.getProps().disabled}); // Toggle disabled state
}
</webuijsf:script>


Tag Information
Tag Classcom.sun.webui.jsf.component.PasswordFieldTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejava.lang.String A ValueExpression that resolves to the UIComponent that corresponds to this tag. This attribute allows the Java bean that contains the UIComponent to manipulate the UIComponent, its properties, and its children.
passwordfalsefalsejava.lang.String

Value binding. While no password data will be rendered on the client side, if this property is specified by a value binding expression, the corresponding value will be updated if validation succeeds.

submitFormfalsefalsejava.lang.String

Flag indicating whether pressing enter in this text field would allow browser to submit the enclosing form ( for all input fields with the exception of TextArea which uses enter key to open a new line)
If set to false, the browser will be prevented from submitting the form on enter in all circumstances. If set to true, the form will be submitted on enter in all circumstances. The default value for this attribute is "false", i.e. default browser auto submit feature will be disabled.

onDblClickfalsefalsejava.lang.String

Scripting code executed when a mouse double click occurs over this component.

trimfalsefalsejava.lang.String

Flag indicating that any leading and trailing blanks will be trimmed prior to conversion to the destination data type. Default value is true.

onKeyPressfalsefalsejava.lang.String

Scripting code executed when the user presses and releases a key while the component has focus.

onSelectfalsefalsejava.lang.String

Scripting code executed when some text in this component value is selected.

onFocusfalsefalsejava.lang.String

Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.

renderedfalsefalsejava.lang.String Indicates whether the HTML code for the component should be included in the rendered HTML page. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.
columnsfalsefalsejava.lang.String

Number of character columns used to render this field. The default is 20.

idfalsetruejava.lang.StringNo Description
onKeyUpfalsefalsejava.lang.String

Scripting code executed when the user releases a key while the component has focus.

onMouseUpfalsefalsejava.lang.String

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

styleClassfalsefalsejava.lang.String

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

stylefalsefalsejava.lang.String

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

onClickfalsefalsejava.lang.String

Scripting code executed when a mouse click occurs over this component.

onBlurfalsefalsejava.lang.String

Scripting code executed when this element loses focus.

onMouseDownfalsefalsejava.lang.String

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

toolTipfalsefalsejava.lang.String

Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.

maxLengthfalsefalsejava.lang.String

The maximum number of characters that can be entered for this field.

converterfalsefalsejava.lang.String Specifies a method to translate native property values to String and back for this component. The converter attribute value must be one of the following:
  • A JavaServer Faces EL expression that resolves to a backing bean or bean property that implements the javax.faces.converter.Converter interface; or
  • the ID of a registered converter (a String).
requiredfalsefalsejava.lang.String Flag indicating that an input value for this field is mandatory, and failure to provide one will trigger a validation error.
disabledfalsefalsejava.lang.String

Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.

validatorExpressionfalsefalsejava.lang.String Used to specify a method in a backing bean to validate input to the component. The value must be a JavaServer Faces EL expression that resolves to a public method with return type void. The method must take three parameters:
  • a javax.faces.context.FacesContext
  • a javax.faces.component.UIComponent (the component whose data is to be validated)
  • a java.lang.Object containing the data to be validated.

The backing bean where the method is defined must implement java.io.Serializable or javax.faces.component.StateHolder.

The method is invoked during the Process Validations Phase.

onMouseOutfalsefalsejava.lang.String

Scripting code executed when a mouse out movement occurs over this component.

onMouseOverfalsefalsejava.lang.String

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

htmlTemplatefalsefalsejava.lang.String Alternative HTML template to be used by this component.
onMouseMovefalsefalsejava.lang.String

Scripting code executed when the user moves the mouse pointer while over the component.

immediatefalsefalsejava.lang.String Flag indicating that event handling for this component should be handled immediately (in Apply Request Values phase) rather than waiting until Invoke Application phase.
labelfalsefalsejava.lang.String

If set, a label is rendered adjacent to the component with the value of this attribute as the label text.

onChangefalsefalsejava.lang.String

Scripting code executed when the element value of this component is changed.

visiblefalsefalsejava.lang.String

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

onKeyDownfalsefalsejava.lang.String

Scripting code executed when the user presses down on a key while the component has focus.

readOnlyfalsefalsejava.lang.String

Flag indicating that modification of this component by the user is not currently permitted, but that it will be included when the form is submitted.

labelLevelfalsefalsejava.lang.String

Sets the style level for the generated label, provided the label attribute has been set. Valid values are 1 (largest), 2 and 3 (smallest). The default value is 2.

valueChangeListenerExpressionfalsefalsejava.lang.String Specifies a method to handle a value-change event that is triggered when the user enters data in the input component. The attribute value must be a JavaServer Faces EL expression that resolves to a backing bean method. The method must take a single parameter of type javax.faces.event.ValueChangeEvent, and its return type must be void. The backing bean where the method is defined must implement java.io.Serializable or javax.faces.component.StateHolder.
tabIndexfalsefalsejava.lang.String

Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.


Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.