Tomahawk sandbox tag library.
Tag tableSuggestAjax


Provides an input textbox with "suggest" functionality, using an ajax request to the server. The popUp contains a table where each column value can be set to a specific dom node (through dom node id).


Tag Information
Tag Classorg.apache.myfaces.custom.suggestajax.tablesuggestajax.TableSuggestAjaxTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
betweenKeyUpfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
If the time between two keyup events is lower than this given value, the ajax request will not be fired. In milliseconds. Prevents stressing the server with too much user inputs. In driven tests the component seems to be more stable if this value is set. A recommended value in which case the component works very well is about 300ms.
startRequestfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
The AJAX Request is only triggered if the number of chars typed in is equal or greater than this given value.
varfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Same principle as it can be found in dataTable. SuggestedItemsMethod returns a list of objects, where the class variables can be accessed with the alias after the dot of the var.
tableStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass for the suggested table.
popupIdfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Id for the pop up window
popupStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass for the window with a suggested list of items; pop up for each incoming Ajax response
comboBoxStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass for dropdown box and arrow.
rowStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass which applies to every row in the suggested table.
evenRowStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass which only applies to even rows in the suggested table.
oddRowStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass which only applies to odd rows in the suggested table.
hoverRowStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
StyleClass for the rows for onmouseover events.
suggestedItemsMethodfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Reference to the method which returns the suggested items
maxSuggestedItemsfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Integer)
optional attribute to identify the max size of suggested Values. If specified in tableSuggestAjax, paginator functionality is used.
charsetfalsefalsejava.lang.StringForce the charset of the Response
javascriptLocationfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
An alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter.
imageLocationfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
An alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter.
styleLocationfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
An alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter.
disabledOnClientSidefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
If true the input is rendered disabled on the client side and a hidden input is used to actualy submit his value back to the server.
autocompletefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Non HTML standard attribute to disable browser's autocomplete function.
displayValueOnlyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Boolean)
If true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Style used when displayValueOnly is true.
displayValueOnlyStyleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Style class used when displayValueOnly is true.
enabledOnUserRolefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
forceIdfalsefalsejava.lang.StringIf true, this component will force the use of the specified id when rendering.
forceIdIndexfalsefalsejava.lang.StringIf false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
datafldfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Reserved for future use.
datasrcfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Reserved for future use.
dataformatasfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Reserved for future use.
alignfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.
maxlengthfalsefalsejavax.el.ValueExpression
(must evaluate to int)
HTML: The maximum number of characters allowed to be entered.
sizefalsefalsejavax.el.ValueExpression
(must evaluate to int)
HTML: The initial width of this control, in characters.
labelfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
A display name for this component.
stylefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: CSS styling instructions.
styleClassfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
The CSS class for this element. Corresponds to the HTML 'class' attribute.
altfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies alternative text that can be used by a browser that can't show this element.
tabindexfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies the position of this element within the tab order of the document.
onblurfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies a script to be invoked when the element loses focus.
onfocusfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies a script to be invoked when the element receives focus.
accesskeyfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Sets the access key for this element.
onclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the element is double-clicked.
onkeydownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when a key is pressed down over this element.
onkeypressfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when a key is pressed over this element.
onkeyupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when a key is released over this element.
onmousedownfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemovefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseoverfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is moved into this element.
onmouseupfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Script to be invoked when the pointing device is released over this element.
onchangefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies a script to be invoked when the element is modified.
onselectfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: Specifies a script to be invoked when the element is selected.
dirfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: The base language of this document.
titlefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
HTML: An advisory title for this element. Often used by the user agent as a tooltip.
disabledfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
HTML: When true, this element cannot receive focus.
readonlyfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.
immediatefalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
A boolean value that identifies the phase during which action events should fire.

During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.

requiredfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
A boolean value that indicates whether an input value is required.

If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails.

Default value: false.

converterMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails.

requiredMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank).
validatorfalsefalsejavax.el.MethodExpression
(signature must match void myMethod( javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object ))
A method-binding EL expression which is invoked during the validation phase for this component.

The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component.

The method is expected to have the prototype

public void aMethod(FacesContext, UIComponent,Object)
validatorMessagefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Text which will be shown if validation fails.
valueChangeListenerfalsefalsejavax.el.MethodExpression
(signature must match void myMethod( javax.faces.event.ValueChangeEvent ))
A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns.

The phase in which this method is invoked can be controlled via the immediate attribute.

valuefalsefalsejavax.el.ValueExpression
(must evaluate to java.lang.Object)
Gets The initial value of this component.
converterfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
An expression that specifies the Converter for this component.

The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.

idfalsetruejava.lang.StringGet a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.
renderedfalsefalsejavax.el.ValueExpression
(must evaluate to boolean)
A boolean value that indicates whether this component should be rendered. Default value: true.
bindingfalsefalsejavax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

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.