ICEfaces-EE 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 argument
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.AjaxBehaviorEvent
blurFired when the text input field loses focus (default event).javax.faces.event.AjaxBehaviorEvent
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.StringAccess key that, when pressed, transfers focus to this element.
altnotruejava.lang.StringAlternate textual description of the element rendered by this component.
autoTabnotruebooleanWhen true the component will automatically tab to the next component once the maxLength number of characters have been entered.
autocompletenotruejava.lang.StringIf 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.
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.StringDirection indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
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.
immediatenotruebooleanA flag indicating that conversion and validation of this component's value should occur during Apply Request Values phase instead of Process Validations phase. Default = 'false'.
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.StringCode describing the language used in the generated markup for this component.
maxlengthnotrueintThe maximum number of characters that may be entered in this field.
onblurnotruejava.lang.StringJavascript code executed when this element loses focus.
onchangenotruejava.lang.StringJavascript code executed when this element loses focus and its value has been modified since gaining focus.
onclicknotruejava.lang.StringJavascript code executed when a pointer button is clicked over this element.
ondblclicknotruejava.lang.StringJavascript code executed when a pointer button is double clicked over this element.
onfocusnotruejava.lang.StringJavascript code executed when this element receives focus.
onkeydownnotruejava.lang.StringJavascript code executed when a key is pressed down over this element.
onkeypressnotruejava.lang.StringJavascript code executed when a key is pressed and released over this element.
onkeyupnotruejava.lang.StringJavascript code executed when a key is released over this element.
onmousedownnotruejava.lang.StringJavascript code executed when a pointer button is pressed down over this element.
onmousemovenotruejava.lang.StringJavascript code executed when a pointer button is moved within this element.
onmouseoutnotruejava.lang.StringJavascript code executed when a pointer button is moved away from this element.
onmouseovernotruejava.lang.StringJavascript code executed when a pointer button is moved onto this element.
onmouseupnotruejava.lang.StringJavascript code executed when a pointer button is released over this element.
onselectnotruejava.lang.StringJavascript code executed when text within this element is selected by the user.
optionalIndicatornotruejava.lang.StringIndicator indicating that the user is NOT required to provide a submitted value for this input 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.
secretnotruebooleanIf true, when the user types a string into this field, a row of asterisks will be displayed instead of the text the user types. Default = 'false'.
sizenotrueintThe number of characters used to determine the width of this field.
stylenotruejava.lang.StringCSS style(s) to be applied when this component is rendered.
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.StringPosition of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
titlenotruejava.lang.StringAdvisory title information about markup elements generated for this component.
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".
widgetVarnotruejava.lang.StringName of the widget variable to access client-side API.

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.