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

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  javax.faces.component.html.HtmlInputText
                      org.apache.myfaces.component.html.ext.AbstractHtmlInputText
                          org.apache.myfaces.component.html.ext.HtmlInputText
                              org.apache.myfaces.custom.suggestajax.AbstractSuggestAjax
                                  org.apache.myfaces.custom.suggestajax.SuggestAjax
                                      org.apache.myfaces.custom.suggestajax.tablesuggestajax.AbstractTableSuggestAjax
                                          org.apache.myfaces.custom.suggestajax.tablesuggestajax.TableSuggestAjax

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 class TableSuggestAjax
extends AbstractTableSuggestAjax

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

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

TableSuggestAjax()

Method Summary

java.lang.Integer	getBetweenKeyUp() If the time between two keyup events is lower than this given value, the ajax request will not be fired.
java.lang.String	getComboBoxStyleClass() StyleClass for dropdown box and arrow.
java.lang.String	getEvenRowStyleClass() StyleClass which only applies to even rows in the suggested table.
java.lang.String	getFamily()
java.lang.String	getHoverRowStyleClass() StyleClass for the rows for onmouseover events.
java.lang.String	getOddRowStyleClass() StyleClass which only applies to odd rows in the suggested table.
java.lang.String	getPopupId() Id for the pop up window
java.lang.String	getPopupStyleClass() StyleClass for the window with a suggested list of items; pop up for each incoming Ajax response
java.lang.String	getRowStyleClass() StyleClass which applies to every row in the suggested table.
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.
java.lang.String	getTableStyleClass() StyleClass for the suggested table.
java.lang.String	getVar() Same principle as it can be found in dataTable.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setBetweenKeyUp(java.lang.Integer betweenKeyUp)
void	setComboBoxStyleClass(java.lang.String comboBoxStyleClass)
void	setEvenRowStyleClass(java.lang.String evenRowStyleClass)
void	setHoverRowStyleClass(java.lang.String hoverRowStyleClass)
void	setOddRowStyleClass(java.lang.String oddRowStyleClass)
void	setPopupId(java.lang.String popupId)
void	setPopupStyleClass(java.lang.String popupStyleClass)
void	setRowStyleClass(java.lang.String rowStyleClass)
void	setStartRequest(java.lang.Integer startRequest)
void	setTableStyleClass(java.lang.String tableStyleClass)
void	setVar(java.lang.String var)

Methods inherited from class org.apache.myfaces.custom.suggestajax.tablesuggestajax.AbstractTableSuggestAjax

encodeChildren, getRendersChildren

Methods inherited from class org.apache.myfaces.custom.suggestajax.SuggestAjax

getCharset, getImageLocation, getJavascriptLocation, getMaxSuggestedItems, getStyleLocation, 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, 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, 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, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, 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, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

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

TableSuggestAjax

public TableSuggestAjax()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class SuggestAjax

getBetweenKeyUp

public java.lang.Integer getBetweenKeyUp()

Description copied from class: AbstractTableSuggestAjax

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.

Specified by:

getBetweenKeyUp in class AbstractTableSuggestAjax

setBetweenKeyUp

public void setBetweenKeyUp(java.lang.Integer betweenKeyUp)

getStartRequest

public java.lang.Integer getStartRequest()

Description copied from class: AbstractTableSuggestAjax

The AJAX Request is only triggered if the number of chars typed in is equal or greater than this given value.

Specified by:

getStartRequest in class AbstractTableSuggestAjax

setStartRequest

public void setStartRequest(java.lang.Integer startRequest)

getVar

public java.lang.String getVar()

Description copied from class: AbstractTableSuggestAjax

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.

Specified by:

getVar in class AbstractTableSuggestAjax

setVar

public void setVar(java.lang.String var)

getTableStyleClass

public java.lang.String getTableStyleClass()

Description copied from class: AbstractTableSuggestAjax

StyleClass for the suggested table.

Specified by:

getTableStyleClass in class AbstractTableSuggestAjax

setTableStyleClass

public void setTableStyleClass(java.lang.String tableStyleClass)

getPopupId

public java.lang.String getPopupId()

Description copied from class: AbstractTableSuggestAjax

Id for the pop up window

Specified by:

getPopupId in class AbstractTableSuggestAjax

setPopupId

public void setPopupId(java.lang.String popupId)

getPopupStyleClass

public java.lang.String getPopupStyleClass()

Description copied from class: AbstractTableSuggestAjax

StyleClass for the window with a suggested list of items; pop up for each incoming Ajax response

Specified by:

getPopupStyleClass in class AbstractTableSuggestAjax

setPopupStyleClass

public void setPopupStyleClass(java.lang.String popupStyleClass)

getComboBoxStyleClass

public java.lang.String getComboBoxStyleClass()

Description copied from class: AbstractTableSuggestAjax

StyleClass for dropdown box and arrow.

Specified by:

getComboBoxStyleClass in class AbstractTableSuggestAjax

setComboBoxStyleClass

public void setComboBoxStyleClass(java.lang.String comboBoxStyleClass)

getRowStyleClass

public java.lang.String getRowStyleClass()

Description copied from class: AbstractTableSuggestAjax

StyleClass which applies to every row in the suggested table.

Specified by:

getRowStyleClass in class AbstractTableSuggestAjax

setRowStyleClass

public void setRowStyleClass(java.lang.String rowStyleClass)

getEvenRowStyleClass

public java.lang.String getEvenRowStyleClass()

Description copied from class: AbstractTableSuggestAjax

StyleClass which only applies to even rows in the suggested table.

Specified by:

getEvenRowStyleClass in class AbstractTableSuggestAjax

setEvenRowStyleClass

public void setEvenRowStyleClass(java.lang.String evenRowStyleClass)

getOddRowStyleClass

public java.lang.String getOddRowStyleClass()

Description copied from class: AbstractTableSuggestAjax

StyleClass which only applies to odd rows in the suggested table.

Specified by:

getOddRowStyleClass in class AbstractTableSuggestAjax

setOddRowStyleClass

public void setOddRowStyleClass(java.lang.String oddRowStyleClass)

getHoverRowStyleClass

public java.lang.String getHoverRowStyleClass()

Description copied from class: AbstractTableSuggestAjax

StyleClass for the rows for onmouseover events.

Specified by:

getHoverRowStyleClass in class AbstractTableSuggestAjax

setHoverRowStyleClass

public void setHoverRowStyleClass(java.lang.String hoverRowStyleClass)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class SuggestAjax

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class SuggestAjax