• Главная
• Prado
• Web
• UI
• JuiControls
• TJuiAutoComplete

PHP Класс Prado\Web\UI\JuiControls\TJuiAutoComplete

TJuiAutoComplete is a textbox that provides a list of suggestion on the current partial word typed in the textbox. The suggestions are requested using callbacks, and raises the {@link onSuggestion OnSuggestion} event. The events of the TActiveText (from which TJuiAutoComplete is extended from) and {@link onSuggestion OnSuggestion} are mutually exculsive. That is, if {@link onTextChange OnTextChange} and/or {@link onCallback OnCallback} events are raise, then {@link onSuggestion OnSuggestion} will not be raise, and vice versa. The list of suggestions should be set in the {@link onSuggestion OnSuggestion} event handler. The partial word to match the suggestion is in the {@link TCallbackEventParameter::getCallbackParameter TCallbackEventParameter::CallbackParameter} property. The datasource of the TJuiAutoComplete must be set using {@link setDataSource} method. This sets the datasource for the suggestions repeater, available through the {@link getSuggestions Suggestions} property. Header, footer templates and other properties of the repeater can be access via the {@link getSuggestions Suggestions} property and its sub-properties. The {@link setTextCssClass TextCssClass} property if set is used to find the element within the Suggestions.ItemTemplate and Suggestions.AlternatingItemTemplate that contains the actual text for the suggestion selected. That is, only text inside elements with CSS class name equal to {@link setTextCssClass TextCssClass} will be used as suggestions. To return the list of suggestions back to the browser, supply a non-empty data source and call databind. For example, function autocomplete_suggestion($sender, $param) { $token = $param->getToken(); //the partial word to match $sender->setDataSource($this->getSuggestionsFor($token)); //set suggestions $sender->dataBind(); } The suggestion will be rendered when the {@link dataBind()} method is called during a callback request. When an suggestion is selected, that is, when the use has clicked, pressed the "Enter" key, or pressed the "Tab" key, the {@link onSuggestionSelected OnSuggestionSelected} event is raised. The {@link TCallbackEventParameter::getCallbackParameter TCallbackEventParameter::CallbackParameter} property contains the index of the selected suggestion. TJuiAutoComplete allows multiple suggestions within one textbox with each word or phrase separated by any characters specified in the {@link setSeparator Separator} property. The {@link setFrequency Frequency} and {@link setMinChars MinChars} properties sets the delay and minimum number of characters typed, respectively, before requesting for sugggestions. Use {@link onTextChange OnTextChange} and/or {@link onCallback OnCallback} events to handle post backs due to {@link setAutoPostBack AutoPostBack}. In the {@link getSuggestions Suggestions} TRepater item template, all HTML text elements are considered as text for the suggestion. Text within HTML elements with CSS class name "informal" are ignored as text for suggestions. Показать файл Открыть проект

Открытые методы

Метод	Описание
__construct ( )	Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
dataBind ( )	Overrides parent implementation. Callback {@link renderSuggestions()} when page's IsCallback property is true.
getFrequency ( ) : float
getMinChars ( ) : integer
getOptions ( ) : TJuiControlOptions	Object containing defined javascript options
getResultPanel ( ) : TPanel
getSeparator ( ) : string
getSuggestions ( ) : TRepeater
getTextCssClass ( ) : string
getValidEvents ( ) : array()	Array containing valid javascript events
getValidOptions ( ) : array()	Array containing valid javascript options
getWidget ( ) : string
getWidgetID ( ) : string
onSuggest ( $param )	This method is invoked when an autocomplete suggestion is requested.
onSuggestionSelected ( $param )	This method is invoked when an autocomplete suggestion is selected.
raiseCallbackEvent ( $param )	Raises the callback event. This method is overrides the parent implementation.
renderCallback ( $writer )	Renders the suggestions during a callback respones.
renderEndTag ( $writer )	Renders the end tag and registers javascript effects library.
renderSuggestions ( $writer )	Renders the suggestions repeater.
setDataSource ( $data )
setFrequency ( $value )
setMinChars ( $value )
setSeparator ( $value )
setTextCssClass ( $value )

Защищенные методы

Метод	Описание
createRepeater ( ) : TRepeater
createResultPanel ( ) : TPanel
getClientClassName ( ) : string
getPostBackOptions ( ) : array
renderClientControlScript ( $writer )	Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in {@link addAttributesToRender}.
renderResultPanel ( $writer )	Renders the result panel.

Описание методов