ICEfaces ACE Components
Tag textEntry


TextEntry is a text input component that can display some placeholder text inside the input field when the component doesn't have a value and is not focussed. It also has custom styling for invalid state and required status.

For more information, see the TextEntry Wiki Documentation.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
blurFired when the text input field loses focus (default event).javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
charCountFired when the number of characters entered in the component changes, either by the user typing a new character, deleting one or more characters, or cutting/pasting characters into the component.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
valueChangeFired when the component detects value is changed.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.textentry.TextEntryTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
altnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
autoTabnotruebooleanWhen true the component will automatically tab to the next component once the maxLength number of characters have been entered.
autocapitalizenotruejava.lang.StringAn HTML5 feature supported by mobile browsers which will automatically capitalize the first character of the field. Alternatively, the Mojarra HTML5 'autocapitalize' passthrough attribute may also be used with this component. Default = 'off'.
autocompletenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
autocorrectnotruejava.lang.StringThe autocorrect is an HTML5 attribute that may correct spelling errors in the field if supported in the browser. Alternatively, the Mojarra HTML5 'autocorrect' passthrough attribute may also be used with this component. Default = 'off'.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
converternotruejavax.faces.convert.ConverterConverter is an interface describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects and a String representation of those objects that is suitable for rendering.
converterMessagenotruejava.lang.StringIf present, will be used as the text of the converter message, replacing any message that comes from the converter.
dirnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
disablednotruebooleanFlag 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". Default = 'false'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediatenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
indicatorPositionnotruejava.lang.StringPosition of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "inField", "right" otherwise.
labelnotruejava.lang.StringA localized user presentable name for this component.
labelPositionnotruejava.lang.StringPosition of label relative to input field. Supported values are "left/right/top/bottom/inField/none". Default is "none".
langnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
maxnotrueintMaximum value is an html5 passthrough attribute, and only applicable to type number. Will not be rendered if attribute is not present. Alternatively, the Mojarra HTML5 'max' passthrough attribute may be used with this component. Default = 'Integer.MIN_VALUE'.
maxlengthnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
minnotrueintMinimum value is an HTML5 passthrough attribute and only applicable to type number. Will not be rendered if not present. Alternatively, the Mojarra HTML5 'min' passthrough attribute may be used with this component. Default = 'Integer.MIN_VALUE'.
namenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onblurnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onchangenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onclicknotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
ondblclicknotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onfocusnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onkeydownnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onkeypressnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onkeyupnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmousedownnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmousemovenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmouseoutnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmouseovernotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
onmouseupnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
optionalIndicatornotruejava.lang.StringIndicator indicating that the user is NOT required to provide a submitted value for this input component.
patternnotruejava.lang.StringThe HTML5 pattern attribute specifies a regular expression against which the control's value, or, when the multiple attribute applies and is set, the control's values, are to be checked. Alternatively, the Mojarra HTML5 'pattern' passthrough attribute may also be used with this component.
placeholdernotruejava.lang.StringThe HTML5 placeholder attribute represents a short hint (a word or short phrase) intended to aid the user with data entry when the input element has no value. Alternatively, the Mojarra HTML5 'placeholder' passthrough attribute may also be used with this component.
readonlynotruebooleanFlag 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". Default = 'false'.
redisplaynotruebooleanIf false, the component will not redisplay its value when the page reloads. The main purpose of this attribute is to be used when the 'secret' attribute is set to true, to avoid redisplaying the secret input. Default = 'true'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
requirednotruebooleanA flag indicating whether the user required to provide a non-empty submitted value for this component. Default = 'false'.
requiredIndicatornotruejava.lang.StringIndicator indicating that the user is required to provide a submitted value for this input component.
requiredMessagenotruejava.lang.StringIf present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
resultsnotrueintMagnifying glass for webkit used to show last three searches on a search field. Alternatively, the Mojarra HTML5 'results' passthrough attribute may also be used with this component. Default = '3'.
rowsnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
secretnotruebooleanIf true, when the user types a string into this field, a row of asterisks will be displayed instead of the text the user typed. Default = 'false'.
sizenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
stepnotrueintThe HTML5 step attributeto increase/decrease the value of the number input. Requires min and max atribute. Applicable only to type "number". Alternatively, the Mojarra HTML5 'step' passthrough attribute may also be used with this component. Default = 'Integer.MIN_VALUE'.
stylenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
styleClassnotruejava.lang.StringSpace-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.
tabindexnotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
titlenotruejava.lang.StringRenders the provided value as an HTML attribute with the same name on the root element of the component.
typenotruejava.lang.StringThe HTML5 type attribute for the input element. Currently supports text, phone, url, email, number, date, time, datetime. Depending on browser and/or device capability, a type-specific keyboard may be displayed and various other attributes may apply for the html5 input element. It is up to the developer to ensure that the browsers and devices they are targetting are supported properly. Alternatively, the Mojarra HTML5 'type' passthrough attribute may also be used with this component. Default = 'text'.
validatornotruejavax.el.MethodExpressionMethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void.
validatorMessagenotruejava.lang.StringIf present, will be used as the text of the validator message, replacing any message that comes from the validator.
valuenotruejava.lang.ObjectThe current value of the simple component. The value to be rendered.
valueChangeListenernotruejavax.el.MethodExpressionMethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed".

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.