|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.richfaces.component.UISuggestionBox
org.richfaces.component.html.HtmlSuggestionBox
public class HtmlSuggestionBox
Component-Type org.richfaces.SuggestionBox Component-Family org.richfaces.SuggestionBox Renderer-Type org.richfaces.SuggestionBox This element adds "on-keypress" suggestions capabilites to any input text component (like <h:inputText>). It creates a pop-up window for a input field component pointed to by the "for" attribute. For an ordinary request, render a hidden HTML <div> element and the necessary JavaScript code. When input to the target field exceeds the "minChars" property (default is 1), perform an AJAX request with the value current entered. If the AJAX request is detected and the request parameters map contains the client ID of this component, call a method defined by suggestionAction, and use it to return a value as data for render table, same as <h:dataTable>. In this case, the component then works the same as an ordinary dataTable. The rendered table is inserted in the pop-up area and is used for suggestion prompts for input element. If a user clicks on such a table row, its text (or value defined by fetchValue) is inserted as the value of the input field.
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
Fields inherited from interface org.ajax4jsf.component.AjaxComponent |
---|
AJAX_COMPONETT_PARAMETER |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
HtmlSuggestionBox()
Constructor to init default renderers |
Method Summary | |
---|---|
java.lang.String |
getAlign()
align Getter for align |
java.lang.String |
getBgcolor()
Deprecated. |
java.lang.String |
getBorder()
This attributes specifies the width (in pixels only) of the frame around a table Getter for border |
java.lang.String |
getCellpadding()
This attribute specifies the amount of space between the border of the cell and its contents. |
java.lang.String |
getCellspacing()
This attribute specifies how much space the user agent should leave between the table and the column on all four sides. |
javax.faces.convert.Converter |
getConverter()
Id of Converter to be used or reference to a Converter Getter for converter |
java.lang.Object |
getData()
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. |
java.lang.String |
getDir()
Direction indication for text that does not inherit directionality. |
java.lang.String |
getEntryClass()
Name of the CSS class for a suggestion entry element (table row) Getter for entryClass |
java.lang.String |
getEventsQueue()
Name of requests queue to avoid send next request before complete other from same event. |
java.lang.String |
getFamily()
|
java.lang.Object |
getFetchValue()
A value to set in the target input element on a choice suggestion that isn't shown in the suggestion table. |
java.lang.String |
getFocus()
id of element to set focus after request completed on client side Getter for focus |
java.lang.String |
getFor()
id (or full path of id's) of target components, for which this element must provide support. |
java.lang.String |
getFrame()
void|above|below|hsides|lhs|rhs|vsides|box|border [CI] This attribute specifies which sides of the frame surrounding a table will be visible. |
double |
getFrequency()
Delay (in seconds) before activating the suggestion pop-up Getter for frequency |
java.lang.String |
getHeight()
Height of the pop-up window in pixels Getter for height |
java.lang.String |
getLang()
Code describing the language used in the generated markup for this component Getter for lang |
java.lang.String |
getMinChars()
Minimal number of chars in input to activate suggestion pop-up Getter for minChars |
java.lang.String |
getNothingLabel()
"nothingLabel" is inserted to popup list if the autocomplete returns empty list. |
java.lang.String |
getOnbeforedomupdate()
JavaScript code for call before DOM has been updated on client side Getter for onbeforedomupdate |
java.lang.String |
getOncomplete()
JavaScript code for call after request completed on client side Getter for oncomplete |
java.lang.String |
getOnselect()
JavaScript code for call on select suggestion, after update value of target element Getter for onselect |
java.lang.String |
getOnsubmit()
JavaScript code for call before submission of ajax event Getter for onsubmit |
java.lang.String |
getParam()
Name the HTTP request parameter with the value of input element token. |
java.lang.String |
getPopupClass()
HTML CSS class attribute of element for pop-up suggestion content Getter for popupClass |
java.lang.String |
getPopupStyle()
HTML CSS style attribute of element for pop-up suggestion content Getter for popupStyle |
int |
getRequestDelay()
Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. |
java.lang.Object |
getReRender()
Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. |
java.lang.String |
getRowClasses()
A comma-delimited list of CSS style classes that is applied to popup table rows. |
java.lang.String |
getRules()
This attribute specifies which rules will appear between cells within a table. |
java.lang.String |
getSelectedClass()
Name of the CSS class for a selected suggestion entry element (table row) Getter for selectedClass |
java.lang.String |
getSelectValueClass()
Name of the CSS class for a selected suggestion entry element (table cell) Getter for selectValueClass |
java.lang.String |
getShadowDepth()
Pop-up shadow depth for suggestion content Getter for shadowDepth |
java.lang.String |
getShadowOpacity()
Attribute defines shadow opacity for suggestion content Getter for shadowOpacity |
java.lang.String |
getStatus()
ID (in format of call UIComponent.findComponent()) of Request status component Getter for status |
java.lang.String |
getStyle()
CSS style(s) is/are to be applied when this component is rendered Getter for style |
java.lang.String |
getStyleClass()
Corresponds to the HTML class attribute Getter for styleClass |
java.lang.Object |
getSubmitedValue()
submitedValue Getter for submitedValue |
javax.faces.el.MethodBinding |
getSuggestionAction()
Method calls an expression to get a collection of suggestion data on request. |
java.lang.String |
getSummary()
This attribute provides a summary of the table's purpose and structure for user agents rendering to non-visual media such as speech and Braille Getter for summary |
int |
getTimeout()
Response waiting time on a particular request. |
java.lang.String |
getTitle()
Advisory title information about markup elements generated for this component Getter for title |
java.lang.Object |
getTokens()
The list (or single value) of symbols which can be used for division chosen of suggestion pop-up values in a target element. |
java.lang.String |
getWidth()
Width of the pop-up window in pixels Getter for width |
int |
getZindex()
Attribute is similar to the standard HTML attribute and can specify window placement relative to the content Getter for zindex |
boolean |
isAjaxSingle()
if "true", submit ONLY one field/link, instead of all form controls Getter for ajaxSingle |
boolean |
isBypassUpdates()
If "true", after process validations phase it skips updates of model beans on a force render response. |
boolean |
isIgnoreDupResponses()
Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. |
boolean |
isImmediate()
A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase. |
boolean |
isLimitToList()
If "true", updates on client side ONLY elements from this 'reRender' property. |
boolean |
isSelfRendered()
If "true", forces active Ajax region render response directly from stored components tree, bypasses page processing. |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setAjaxSingle(boolean __ajaxSingle)
if "true", submit ONLY one field/link, instead of all form controls Setter for ajaxSingle |
void |
setAlign(java.lang.String __align)
align Setter for align |
void |
setBgcolor(java.lang.String __bgcolor)
Deprecated. |
void |
setBorder(java.lang.String __border)
This attributes specifies the width (in pixels only) of the frame around a table Setter for border |
void |
setBypassUpdates(boolean __bypassUpdates)
If "true", after process validations phase it skips updates of model beans on a force render response. |
void |
setCellpadding(java.lang.String __cellpadding)
This attribute specifies the amount of space between the border of the cell and its contents. |
void |
setCellspacing(java.lang.String __cellspacing)
This attribute specifies how much space the user agent should leave between the table and the column on all four sides. |
void |
setConverter(javax.faces.convert.Converter __converter)
Id of Converter to be used or reference to a Converter Setter for converter |
void |
setData(java.lang.Object __data)
Serialized (on default with JSON) data passed on the client by a developer on AJAX request. |
void |
setDir(java.lang.String __dir)
Direction indication for text that does not inherit directionality. |
void |
setEntryClass(java.lang.String __entryClass)
Name of the CSS class for a suggestion entry element (table row) Setter for entryClass |
void |
setEventsQueue(java.lang.String __eventsQueue)
Name of requests queue to avoid send next request before complete other from same event. |
void |
setFetchValue(java.lang.Object __fetchValue)
A value to set in the target input element on a choice suggestion that isn't shown in the suggestion table. |
void |
setFocus(java.lang.String __focus)
id of element to set focus after request completed on client side Setter for focus |
void |
setFor(java.lang.String __for)
id (or full path of id's) of target components, for which this element must provide support. |
void |
setFrame(java.lang.String __frame)
void|above|below|hsides|lhs|rhs|vsides|box|border [CI] This attribute specifies which sides of the frame surrounding a table will be visible. |
void |
setFrequency(double __frequency)
Delay (in seconds) before activating the suggestion pop-up Setter for frequency |
void |
setHeight(java.lang.String __height)
Height of the pop-up window in pixels Setter for height |
void |
setIgnoreDupResponses(boolean __ignoreDupResponses)
Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. |
void |
setImmediate(boolean __immediate)
A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase. |
void |
setLang(java.lang.String __lang)
Code describing the language used in the generated markup for this component Setter for lang |
void |
setLimitToList(boolean __limitToList)
If "true", updates on client side ONLY elements from this 'reRender' property. |
void |
setMinChars(java.lang.String __minChars)
Minimal number of chars in input to activate suggestion pop-up Setter for minChars |
void |
setNothingLabel(java.lang.String __nothingLabel)
"nothingLabel" is inserted to popup list if the autocomplete returns empty list. |
void |
setOnbeforedomupdate(java.lang.String __onbeforedomupdate)
JavaScript code for call before DOM has been updated on client side Setter for onbeforedomupdate |
void |
setOncomplete(java.lang.String __oncomplete)
JavaScript code for call after request completed on client side Setter for oncomplete |
void |
setOnselect(java.lang.String __onselect)
JavaScript code for call on select suggestion, after update value of target element Setter for onselect |
void |
setOnsubmit(java.lang.String __onsubmit)
JavaScript code for call before submission of ajax event Setter for onsubmit |
void |
setParam(java.lang.String __param)
Name the HTTP request parameter with the value of input element token. |
void |
setPopupClass(java.lang.String __popupClass)
HTML CSS class attribute of element for pop-up suggestion content Setter for popupClass |
void |
setPopupStyle(java.lang.String __popupStyle)
HTML CSS style attribute of element for pop-up suggestion content Setter for popupStyle |
void |
setRequestDelay(int __requestDelay)
Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. |
void |
setReRender(java.lang.Object __reRender)
Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. |
void |
setRowClasses(java.lang.String __rowClasses)
A comma-delimited list of CSS style classes that is applied to popup table rows. |
void |
setRules(java.lang.String __rules)
This attribute specifies which rules will appear between cells within a table. |
void |
setSelectedClass(java.lang.String __selectedClass)
Name of the CSS class for a selected suggestion entry element (table row) Setter for selectedClass |
void |
setSelectValueClass(java.lang.String __selectValueClass)
Name of the CSS class for a selected suggestion entry element (table cell) Setter for selectValueClass |
void |
setSelfRendered(boolean __selfRendered)
If "true", forces active Ajax region render response directly from stored components tree, bypasses page processing. |
void |
setShadowDepth(java.lang.String __shadowDepth)
Pop-up shadow depth for suggestion content Setter for shadowDepth |
void |
setShadowOpacity(java.lang.String __shadowOpacity)
Attribute defines shadow opacity for suggestion content Setter for shadowOpacity |
void |
setStatus(java.lang.String __status)
ID (in format of call UIComponent.findComponent()) of Request status component Setter for status |
void |
setStyle(java.lang.String __style)
CSS style(s) is/are to be applied when this component is rendered Setter for style |
void |
setStyleClass(java.lang.String __styleClass)
Corresponds to the HTML class attribute Setter for styleClass |
void |
setSubmitedValue(java.lang.Object __submitedValue)
submitedValue Setter for submitedValue |
void |
setSuggestionAction(javax.faces.el.MethodBinding __suggestionAction)
Method calls an expression to get a collection of suggestion data on request. |
void |
setSummary(java.lang.String __summary)
This attribute provides a summary of the table's purpose and structure for user agents rendering to non-visual media such as speech and Braille Setter for summary |
void |
setTimeout(int __timeout)
Response waiting time on a particular request. |
void |
setTitle(java.lang.String __title)
Advisory title information about markup elements generated for this component Setter for title |
void |
setTokens(java.lang.Object __tokens)
The list (or single value) of symbols which can be used for division chosen of suggestion pop-up values in a target element. |
void |
setWidth(java.lang.String __width)
Width of the pop-up window in pixels Setter for width |
void |
setZindex(int __zindex)
Attribute is similar to the standard HTML attribute and can specify window placement relative to the content Setter for zindex |
Methods inherited from class org.richfaces.component.UISuggestionBox |
---|
addAjaxListener, broadcast, getAjaxListeners, getRowNumber, isSubmitted, processDecodes, queueEvent, removeAjaxListener, setRowNumber, setSubmitted, setupValue |
Methods inherited from class javax.faces.component.UIData |
---|
encodeBegin, getClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processUpdates, processValidators, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueBinding, setVar |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
Constructor Detail |
---|
public HtmlSuggestionBox()
Method Detail |
---|
public void setWidth(java.lang.String __width)
width
- - new valuepublic java.lang.String getWidth()
public void setFocus(java.lang.String __focus)
focus
- - new valuepublic java.lang.String getFocus()
public void setSubmitedValue(java.lang.Object __submitedValue)
setSubmitedValue
in class UISuggestionBox
submitedValue
- - new valuepublic java.lang.Object getSubmitedValue()
getSubmitedValue
in class UISuggestionBox
public void setDir(java.lang.String __dir)
dir
- - new valuepublic java.lang.String getDir()
public void setBypassUpdates(boolean __bypassUpdates)
bypassUpdates
- - new valuepublic boolean isBypassUpdates()
public void setPopupClass(java.lang.String __popupClass)
popupClass
- - new valuepublic java.lang.String getPopupClass()
public void setLimitToList(boolean __limitToList)
limitToList
- - new valuepublic boolean isLimitToList()
public void setStyle(java.lang.String __style)
style
- - new valuepublic java.lang.String getStyle()
public void setShadowOpacity(java.lang.String __shadowOpacity)
shadowOpacity
- - new valuepublic java.lang.String getShadowOpacity()
public void setFor(java.lang.String __for)
setFor
in class UISuggestionBox
for
- - new valuepublic java.lang.String getFor()
getFor
in class UISuggestionBox
public void setNothingLabel(java.lang.String __nothingLabel)
setNothingLabel
in class UISuggestionBox
nothingLabel
- - new valuepublic java.lang.String getNothingLabel()
getNothingLabel
in class UISuggestionBox
public void setSummary(java.lang.String __summary)
summary
- - new valuepublic java.lang.String getSummary()
public void setTimeout(int __timeout)
timeout
- - new valuepublic int getTimeout()
public void setConverter(javax.faces.convert.Converter __converter)
setConverter
in class UISuggestionBox
converter
- - new valuepublic javax.faces.convert.Converter getConverter()
getConverter
in class UISuggestionBox
public void setLang(java.lang.String __lang)
lang
- - new valuepublic java.lang.String getLang()
public void setCellspacing(java.lang.String __cellspacing)
cellspacing
- - new valuepublic java.lang.String getCellspacing()
public void setShadowDepth(java.lang.String __shadowDepth)
shadowDepth
- - new valuepublic java.lang.String getShadowDepth()
public void setFetchValue(java.lang.Object __fetchValue)
fetchValue
- - new valuepublic java.lang.Object getFetchValue()
public void setZindex(int __zindex)
setZindex
in class UISuggestionBox
zindex
- - new valuepublic int getZindex()
getZindex
in class UISuggestionBox
public void setEntryClass(java.lang.String __entryClass)
setEntryClass
in class UISuggestionBox
entryClass
- - new valuepublic java.lang.String getEntryClass()
getEntryClass
in class UISuggestionBox
public void setOnselect(java.lang.String __onselect)
onselect
- - new valuepublic java.lang.String getOnselect()
public void setSelfRendered(boolean __selfRendered)
setSelfRendered
in class UISuggestionBox
selfRendered
- - new valuepublic boolean isSelfRendered()
isSelfRendered
in class UISuggestionBox
public void setCellpadding(java.lang.String __cellpadding)
setCellpadding
in class UISuggestionBox
cellpadding
- - new valuepublic java.lang.String getCellpadding()
getCellpadding
in class UISuggestionBox
public void setTitle(java.lang.String __title)
title
- - new valuepublic java.lang.String getTitle()
public void setRowClasses(java.lang.String __rowClasses)
setRowClasses
in class UISuggestionBox
rowClasses
- - new valuepublic java.lang.String getRowClasses()
getRowClasses
in class UISuggestionBox
public void setOncomplete(java.lang.String __oncomplete)
oncomplete
- - new valuepublic java.lang.String getOncomplete()
public void setRules(java.lang.String __rules)
rules
- - new valuepublic java.lang.String getRules()
public void setPopupStyle(java.lang.String __popupStyle)
popupStyle
- - new valuepublic java.lang.String getPopupStyle()
public void setSuggestionAction(javax.faces.el.MethodBinding __suggestionAction)
setSuggestionAction
in class UISuggestionBox
suggestionAction
- - new valuepublic javax.faces.el.MethodBinding getSuggestionAction()
getSuggestionAction
in class UISuggestionBox
public void setReRender(java.lang.Object __reRender)
reRender
- - new valuepublic java.lang.Object getReRender()
public void setStyleClass(java.lang.String __styleClass)
styleClass
- - new valuepublic java.lang.String getStyleClass()
public void setHeight(java.lang.String __height)
height
- - new valuepublic java.lang.String getHeight()
public void setAjaxSingle(boolean __ajaxSingle)
ajaxSingle
- - new valuepublic boolean isAjaxSingle()
public void setAlign(java.lang.String __align)
align
- - new valuepublic java.lang.String getAlign()
public void setSelectedClass(java.lang.String __selectedClass)
selectedClass
- - new valuepublic java.lang.String getSelectedClass()
public void setOnsubmit(java.lang.String __onsubmit)
onsubmit
- - new valuepublic java.lang.String getOnsubmit()
public void setBorder(java.lang.String __border)
setBorder
in class UISuggestionBox
border
- - new valuepublic java.lang.String getBorder()
getBorder
in class UISuggestionBox
public void setBgcolor(java.lang.String __bgcolor)
bgcolor
- - new valuepublic java.lang.String getBgcolor()
public void setSelectValueClass(java.lang.String __selectValueClass)
setSelectValueClass
in class UISuggestionBox
selectValueClass
- - new valuepublic java.lang.String getSelectValueClass()
getSelectValueClass
in class UISuggestionBox
public void setFrequency(double __frequency)
frequency
- - new valuepublic double getFrequency()
public void setTokens(java.lang.Object __tokens)
tokens
- - new valuepublic java.lang.Object getTokens()
public void setStatus(java.lang.String __status)
status
- - new valuepublic java.lang.String getStatus()
public void setRequestDelay(int __requestDelay)
requestDelay
- - new valuepublic int getRequestDelay()
public void setEventsQueue(java.lang.String __eventsQueue)
eventsQueue
- - new valuepublic java.lang.String getEventsQueue()
public void setFrame(java.lang.String __frame)
frame
- - new valuepublic java.lang.String getFrame()
public void setImmediate(boolean __immediate)
setImmediate
in class UISuggestionBox
immediate
- - new valuepublic boolean isImmediate()
isImmediate
in class UISuggestionBox
public void setData(java.lang.Object __data)
data
- - new valuepublic java.lang.Object getData()
public void setParam(java.lang.String __param)
param
- - new valuepublic java.lang.String getParam()
public void setOnbeforedomupdate(java.lang.String __onbeforedomupdate)
onbeforedomupdate
- - new valuepublic java.lang.String getOnbeforedomupdate()
public void setMinChars(java.lang.String __minChars)
minChars
- - new valuepublic java.lang.String getMinChars()
public void setIgnoreDupResponses(boolean __ignoreDupResponses)
ignoreDupResponses
- - new valuepublic boolean isIgnoreDupResponses()
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIData
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIData
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIData
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |