| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.InputPhone |
| Handler Class | None |
| Renderer Type | org.primefaces.extensions.component.InputPhoneRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
accesskey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Access key to transfer focus to the input element. |
allowDropdown | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Whether or not to allow the dropdown. If disabled, there is no dropdown arrow, and the selected flag is not clickable. Also, we display the selected flag on the right instead because it is just a country marker. |
alt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description of the input element. |
autocomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Controls browser autocomplete behavior. |
autoHideDialCode | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| If there is just a dial code in the input: remove it on blur or submit. This is to prevent just a dial code getting submitted with the form. Requires nationalMode to be set to false. |
autoPlaceholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Set the input's placeholder to an example number for the selected country, and update it if the country changes. You can specify the number type using the placeholderNumberType attribute. By default it is set to "polite", which means it will only set the placeholder if the input doesn't already have one. You can also set it to "aggressive", which will replace any existing placeholder, or "off". Loads the utils script. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
converter | false | jakarta.el.ValueExpression
(must evaluate to java.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines text direction, valid values are "ltr" (default) and "rtl". |
disabled | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Disables the input element, default is false. |
excludeCountries | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| In the dropdown, display all countries except the ones you specify here. Either a comma separated string or collection of ISO 2 country codes. Default is none. |
fixDropdownWidth | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Fix the dropdown width to the input width (rather than being as wide as the longest country name). Defaul false. |
formatAsYouType | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Format the number as the user types. This will automatically be disabled if the user types their own formatting characters. Requires the `utilsScript` option. Default true. |
formatOnDisplay | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Format the input value (according to the nationalMode option) during initialisation, and on setNumber. Loads the utils script. Default true. |
geoIpLookup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| When setting initialCountry to "auto", you must use this attribute to specify a custom function that looks up the user's location, and then calls the success callback with the relevant country code. See showcase for an example. Default null. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component. Default is false. |
initialCountry | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Set the initial country selection by specifying its country code. If you leave initialCountry blank, it will default to the first country in the list. Default is "us". |
inputmode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| HTML5 inputmode attribute for hinting at the type of data this control has for touch devices to display appropriate virtual keyboard. |
inputStyle | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the input element. |
inputStyleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the input element. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup. |
localizedCountries | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Localized countries map (key ISO 2 code, value name), or JSON string, example "{'de':'Deutschland'}". Default null. |
maxlength | false | jakarta.el.ValueExpression
(must evaluate to int)
| Maximum number of characters that may be entered in this field. |
nationalMode | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Allow users to enter national numbers (and not have to think about international dial codes). Formatting, JS validation and placeholders still work. Defaults is true. |
onblur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus and its value has been modified since gaining focus. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is clicked. |
oncontextmenu | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a context menu is triggered. |
oncopy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user cuts the content of an element. |
oncut | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user copies the content of an element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is double-clicked. |
ondrag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is dragged. |
ondragend | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the end of a drag operation. |
ondragenter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element has been dragged to a valid drop target. |
ondragleave | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element leaves a valid drop target. |
ondragover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is being dragged over a valid drop target. |
ondragstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the start of a drag operation. |
ondrop | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when dragged element is being dropped. |
onfocus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element receives focus. |
oninput | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element gets user input. |
oninvalid | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is invalid. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed down over input element. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed and released over input element. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is released over input element. |
onlyCountries | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| In the dropdown, display only the countries you specify here. Either a comma separated string or collection of ISO 2 country codes. Default is null (so all countries). |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is pressed down over input element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved within input element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved away from input element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved onto input element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is released over input element. |
onpaste | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user pastes some content in an element. |
onreset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the Reset button in a form is clicked. |
onscroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element's scrollbar is being scrolled. |
onsearch | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user writes something in a search field. |
onselect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when text within input element is selected by user. |
onwheel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the mouse wheel rolls up or down over an element. |
placeholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The placeholder attribute specifies a short hint that describes the expected value of an input field. |
placeholderNumberType | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Specify one of "fixed_line", "mobile", "toll_free", "shared_cost", "voip", "personal_number", "pager", "uan", "voicemail" or "unknown". Default is "mobile". |
preferredCountries | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Specify the countries to appear at the top of the list. Either a comma separated string or collection of ISO 2 country codes. Default is none. |
readonly | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this input element will prevent changes by the user. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
separateDialCode | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Display the country dial code next to the selected flag, so it's not part of the typed number. Note that this will disable nationalMode because technically we are dealing with international numbers, but with the dial code separated. Default false. |
size | false | jakarta.el.ValueExpression
(must evaluate to int)
| Number of characters used to determine the width of the input element. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
type | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Input field type. Default "tel". |
validator | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validationg the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.