| |||||||
FRAMES NO FRAMES |
Tag Information | |
Tag Class | org.openfaces.taglib.jsp.input.SuggestionFieldJspTag |
TagExtraInfo Class | None |
Body Content | JSP |
Display Name | None |
Attributes | |||||
Name | Required | Binding Type | EL | Default | Description |
accesskey | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | An access key for the SuggestionField component. |
autoComplete | false | javax.el.ValueExpression
(must evaluate to boolean )
| true | true | Specifies whether the field completes incompletely entered text as the user types it. The text is completed to the first drop-down item that starts with the typed text. The part that was added as a result of auto-completion is marked as selected. See also the suggestionMinChars and suggestionDelay attributes which define when auto-completion starts. |
binding | false | javax.el.ValueExpression
(must evaluate to org.openfaces.component.input.SuggestionField )
| only | null | A value-binding expression that associates the SuggestionField with a backing bean property. |
converter | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A converter for the SuggestionField's value. Should be specified as a value-binding expression or converter identifier. |
customValueAllowed | false | javax.el.ValueExpression
(must evaluate to boolean )
| true | true | A flag that indicates whether it is possible to specify only a value that exists in the list of this component's drop-down items ("false"), or whether it is possible to enter any value ("true"). |
disabled | false | javax.el.ValueExpression
(must evaluate to boolean )
| true | false | A flag that enables or disables the component. |
disabledClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the entire SuggestionField component in the disabled state. |
disabledStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the entire SuggestionField component in the disabled state. |
focusedClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name of the SuggestionField component when it is focused. |
focusedStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style of the SuggestionField component when it is focused. |
footerHorizSeparator | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for a line that separates the footer from the drop-down items. Should be specified as the CSS "border" property but without the prefix "border:". |
footerVertSeparator | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for vertical lines between column footers. Should be specified as the CSS "border" property but without the prefix "border:". |
headerHorizSeparator | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for a line that separates the header from the drop-down items. Should be specified as the CSS "border" property but without the prefix "border:". |
headerVertSeparator | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for vertical lines between column headers. Should be specified as the CSS "border" property but without the prefix "border:". |
horizontalGridLines | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for horizontal lines in the drop-down list. Should be specified as the CSS "border" property but without the prefix "border:". |
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| false | null | The component identifier. |
immediate | false | javax.el.ValueExpression
(must evaluate to boolean )
| true | false | A flag that indicates whether or not valueChangeListener should be executed immediately (during the Apply Request Values phase of the request processing lifecycle instead of Process Validations phase) and the component's input should be converted and validated immediately (during the Apply Request Values phase of the request processing lifecycle instead of the Process Validations phase). |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A localized user presentable name for this component. Used when constructing validation messages for this component in the same way as for the standard |
listAlignment | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
| true | "left" | Defines how items in the drop-down list are aligned. Available values are: "left" "right" |
listClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the drop-down list. |
listFooterRowClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the footer row in the drop-down list. |
listFooterRowStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the footer row in the drop-down list. |
listHeaderRowClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the header row in the drop-down list. |
listHeaderRowStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the header row in the drop-down list. |
listItemClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for a list item. |
listItemStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for a list item. |
listStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the drop-down list. |
manualListOpeningAllowed | false | javax.el.ValueExpression
(must evaluate to boolean )
| true | false | A flag that indicates whether a drop-down suggestion list can be opened using the "Down Arrow" key. |
maxlength | false | javax.el.ValueExpression
(must evaluate to int )
| true | Integer.MIN_VALUE | The maximum number of characters that can be entered in the SuggestionField. It is still possible to select any text from the drop-down list no matter how long it is |
multiFooterSeparator | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for a line that separates multiple footer rows when column groups are used. |
multiHeaderSeparator | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for a line that separates multiple header rows when column groups are used. |
oddListItemClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for an odd list item, if different from listItemClass. |
oddListItemStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for an odd list item, if different from listItemStyle. |
onblur | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the SuggestionField loses focus. |
onchange | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed on the client when the SuggestionField's value has changed. |
onclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed on the client when the user clicks the left mouse button over the SuggestionField. |
oncloseup | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed on the client when the drop-down list has closed. |
oncontextmenu | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user presses right mouse button over the component (or performs the other context menu invocation action depending on the platform). |
ondblclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed on the client when the user double-clicks the left mouse button over the SuggestionField. |
ondropdown | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed on the client when the drop-down list has opened. |
onfocus | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the SuggestionField receives focus. |
onkeydown | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user presses a key over the SuggestionField. |
onkeypress | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed on the client when the user presses and releases a key over the SuggestionField. |
onkeyup | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user releases a key over the SuggestionField. |
onmousedown | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user clicks over the SuggestionField with either mouse button. |
onmousemove | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user moves the mouse pointer over the SuggestionField. |
onmouseout | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user moves the mouse pointer away from the SuggestionField. |
onmouseover | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user moves the mouse pointer onto the SuggestionField. |
onmouseup | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | JavaScript code that should be executed when the user releases the mouse button over the SuggestionField. |
promptText | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | This prompt text will be shown when value of component is empty. |
promptTextClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the prompt text. |
promptTextStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the prompt text. |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean )
| true | false | A flag that indicates whether or not the component is visible. |
required | false | javax.el.ValueExpression
(must evaluate to boolean )
| true | false | A flag that indicates whether or not the SuggestionField requires a value. |
rolloverClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the entire SuggestionField component in the rollover state. |
rolloverListClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the drop-down list in the rollover state. |
rolloverListItemClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for a list item in the rollover state. |
rolloverListItemStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for a list item in the rollover state. |
rolloverListStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the drop-down list in the rollover state. |
rolloverStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the entire SuggestionField component in the rollover state. |
size | false | javax.el.ValueExpression
(must evaluate to int )
| true | Integer.MIN_VALUE | The width of the SuggestionField component in characters. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for the entire SuggestionField component. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A CSS class name for the entire SuggestionField component. |
suggestionDelay | false | javax.el.ValueExpression
(must evaluate to int )
| true | 350 | The time period in milliseconds that specifies the delay after the last key press that should pass before starting auto-completion or auto-suggestion. This delay can be used to avoid too much Ajax requests to be sent to the server when the user is typing text, and only send one request when the user has stopped typing. |
suggestionMinChars | false | javax.el.ValueExpression
(must evaluate to int )
| true | 2 | The minimal number of characters that should be typed for auto-completion and auto-suggestion features to be activated. |
suggestionMode | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
| true | "stringStart" | Specifies whether and how the drop-down list with suggestions should be shown when typing in the field. Any value except "none" means that suggestions are displayed. See also the suggestionMinChars and suggestionDelay attributes which define when auto-suggestion starts. Available values are: "stringStart" — works on the client side. Shows suggestions that begin with the entered value "substring" — works on the client side. Shows suggestions that contain the entered value "stringEnd" — works on the client side. Shows suggestions that end with the entered value "custom" — works on the server side using Ajax. Sends an Ajax request when entering a value and returns a list of suggestions from the server "all" — works on the client side. Shows all drop-down items in the list of suggestions "none" — suggestion mode is turned off |
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | Position of the component in the focus transition chain for the current document. |
timeout | false | javax.el.ValueExpression
(must evaluate to int )
| true | -1 | A time period after which the drop-down list is closed automatically. The value "-1" means that the list does not close automatically. |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | An advisory title for the SuggestionField component. |
validator | false | javax.el.MethodExpression
(signature must match void validate(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object) )
| only | null | A MethodBinding that should point to the method in the backing bean that is called to validate the SuggestionField's value. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object )
| true | null | The value of the suggestionField component that is displayed in the text field. |
valueChangeListener | false | javax.el.MethodExpression
(signature must match void valueChange(javax.faces.event.ValueChangeEvent) )
| only | null | A MethodBinding that should point to the method that accepts a ValueChangeEvent. If the value of the SuggestionField changes, this method is executed. |
var | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| false | null | The name of a request-scope variable under which the current item object is available when specifying child components. |
verticalGridLines | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| true | null | A style for vertical lines in the drop-down list. Should be specified as the CSS "border" property but without the prefix "border:". |
Variables | No Variables Defined. |
| |||||||
FRAMES NO FRAMES |