org.apache.myfaces.custom.suggestajax.tablesuggestajax
Class AbstractTableSuggestAjax

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by javax.faces.component.html.HtmlInputText
                      extended by org.apache.myfaces.component.html.ext.AbstractHtmlInputText
                          extended by org.apache.myfaces.component.html.ext.HtmlInputText
                              extended by org.apache.myfaces.custom.suggestajax.AbstractSuggestAjax
                                  extended by org.apache.myfaces.custom.suggestajax.SuggestAjax
                                      extended by org.apache.myfaces.custom.suggestajax.tablesuggestajax.AbstractTableSuggestAjax
All Implemented Interfaces:
javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.AlignProperty, org.apache.myfaces.component.DataProperties, org.apache.myfaces.component.DisplayValueOnlyAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.LocationAware, org.apache.myfaces.component.UserRoleAware, AjaxComponent, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

public abstract class AbstractTableSuggestAjax
extends SuggestAjax

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).

Author:
Gerald Muellan Date: 25.03.2006 Time: 17:04:58

Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class org.apache.myfaces.custom.suggestajax.SuggestAjax
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIInput
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable
DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR
 
Constructor Summary
AbstractTableSuggestAjax()
           
 
Method Summary
 void encodeChildren(javax.faces.context.FacesContext context)
           
abstract  java.lang.Integer getBetweenKeyUp()
          If the time between two keyup events is lower than this given value, the ajax request will not be fired.
abstract  java.lang.String getComboBoxStyleClass()
          StyleClass for dropdown box and arrow.
abstract  java.lang.String getEvenRowStyleClass()
          StyleClass which only applies to even rows in the suggested table.
abstract  java.lang.String getHoverRowStyleClass()
          StyleClass for the rows for onmouseover events.
abstract  java.lang.String getOddRowStyleClass()
          StyleClass which only applies to odd rows in the suggested table.
abstract  java.lang.String getPopupId()
          Id for the pop up window
abstract  java.lang.String getPopupStyleClass()
          StyleClass for the window with a suggested list of items; pop up for each incoming Ajax response
 boolean getRendersChildren()
           
abstract  java.lang.String getRowStyleClass()
          StyleClass which applies to every row in the suggested table.
abstract  java.lang.Integer getStartRequest()
          The AJAX Request is only triggered if the number of chars typed in is equal or greater than this given value.
abstract  java.lang.String getTableStyleClass()
          StyleClass for the suggested table.
abstract  java.lang.String getVar()
          Same principle as it can be found in dataTable.
 
Methods inherited from class org.apache.myfaces.custom.suggestajax.SuggestAjax
getCharset, getFamily, getImageLocation, getJavascriptLocation, getMaxSuggestedItems, getStyleLocation, restoreState, saveState, setCharset, setImageLocation, setJavascriptLocation, setMaxSuggestedItems, setStyleLocation
 
Methods inherited from class org.apache.myfaces.custom.suggestajax.AbstractSuggestAjax
decodeAjax, encodeAjax, getSuggestedItemsMethod, setSuggestedItemsMethod
 
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlInputText
getAlign, getAutocomplete, getDatafld, getDataformatas, getDatasrc, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getVisibleOnUserRole, isDisabledOnClientSide, isForceId, isForceIdIndex, setAlign, setAutocomplete, setDatafld, setDataformatas, setDatasrc, setDisabledOnClientSide, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setVisibleOnUserRole
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlInputText
getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly
 
Methods inherited from class javax.faces.component.html.HtmlInputText
getAccesskey, getAlt, getDir, getLabel, getLang, getMaxlength, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getSize, getStyle, getStyleClass, getTabindex, getTitle, isDisabled, isReadonly, setAccesskey, setAlt, setDir, setDisabled, setLabel, setLang, setMaxlength, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setSize, setStyle, setStyleClass, setTabindex, setTitle
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, broadcast, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, encodeBegin, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, setConverter
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

AbstractTableSuggestAjax

public AbstractTableSuggestAjax()
Method Detail

getRendersChildren

public boolean getRendersChildren()
Overrides:
getRendersChildren in class javax.faces.component.UIComponentBase

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context)
                    throws java.io.IOException
Overrides:
encodeChildren in class AbstractSuggestAjax
Throws:
java.io.IOException

getBetweenKeyUp

public abstract java.lang.Integer getBetweenKeyUp()
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.


getStartRequest

public abstract java.lang.Integer getStartRequest()
The AJAX Request is only triggered if the number of chars typed in is equal or greater than this given value.


getVar

public abstract java.lang.String getVar()
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.


getTableStyleClass

public abstract java.lang.String getTableStyleClass()
StyleClass for the suggested table.


getPopupId

public abstract java.lang.String getPopupId()
Id for the pop up window


getPopupStyleClass

public abstract java.lang.String getPopupStyleClass()
StyleClass for the window with a suggested list of items; pop up for each incoming Ajax response


getComboBoxStyleClass

public abstract java.lang.String getComboBoxStyleClass()
StyleClass for dropdown box and arrow.


getRowStyleClass

public abstract java.lang.String getRowStyleClass()
StyleClass which applies to every row in the suggested table.


getEvenRowStyleClass

public abstract java.lang.String getEvenRowStyleClass()
StyleClass which only applies to even rows in the suggested table.


getOddRowStyleClass

public abstract java.lang.String getOddRowStyleClass()
StyleClass which only applies to odd rows in the suggested table.


getHoverRowStyleClass

public abstract java.lang.String getHoverRowStyleClass()
StyleClass for the rows for onmouseover events.



Copyright © 2011 The Apache Software Foundation. All Rights Reserved.