Class: HTML_QuickForm_autocomplete

Source Location: /HTML_QuickForm-3.2.14/QuickForm/autocomplete.php

Class Overview

HTML_Common
   |
   --HTML_QuickForm_element
      |
      --HTML_QuickForm_input
         |
         --HTML_QuickForm_text
            |
            --HTML_QuickForm_autocomplete

HTML class for an autocomplete element

Author(s):

Matteo Di Giovinazzo <matteodg at infinito.it>

Version:

Release: 3.2.14

Methods

Inherited Variables

Inherited Methods

Class: HTML_QuickForm_text

HTML_QuickForm_text::HTML_QuickForm_text(): Class constructor
HTML_QuickForm_text::setMaxlength(): Sets maxlength of text field
HTML_QuickForm_text::setSize(): Sets size of text field

Class: HTML_QuickForm_input

HTML_QuickForm_input::HTML_QuickForm_input(): Class constructor
HTML_QuickForm_input::exportValue(): We don't need values from button-type elements (except submit) and files
HTML_QuickForm_input::getName(): Returns the element name
HTML_QuickForm_input::getValue(): Returns the value of the form element
HTML_QuickForm_input::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_input::setName(): Sets the input field name
HTML_QuickForm_input::setType(): Sets the element type
HTML_QuickForm_input::setValue(): Sets the value of the form element
HTML_QuickForm_input::toHtml(): Returns the input field in HTML

Class: HTML_QuickForm_element

HTML_QuickForm_element::HTML_QuickForm_element(): Class constructor
HTML_QuickForm_element::accept(): Accepts a renderer
HTML_QuickForm_element::apiVersion(): Returns the current API version
HTML_QuickForm_element::exportValue(): Returns a 'safe' element's value
HTML_QuickForm_element::freeze(): Freeze the element so that only its value is returned
HTML_QuickForm_element::getFrozenHtml(): Returns the value of field without HTML tags
HTML_QuickForm_element::getLabel(): Returns display text for the element
HTML_QuickForm_element::getName(): Returns the element name
HTML_QuickForm_element::getType(): Returns element type
HTML_QuickForm_element::getValue(): Returns the value of the form element
HTML_QuickForm_element::isFrozen(): Returns whether or not the element is frozen
HTML_QuickForm_element::onQuickFormEvent(): Called by HTML_QuickForm whenever form event is made on this element
HTML_QuickForm_element::setLabel(): Sets display text for the element
HTML_QuickForm_element::setName(): Sets the input field name
HTML_QuickForm_element::setPersistantFreeze(): Sets wether an element value should be kept in an hidden field when the element is frozen or not
HTML_QuickForm_element::setValue(): Sets the value of the form element
HTML_QuickForm_element::unfreeze(): Unfreezes the element so that it becomes editable

Class Details

[line 53]
HTML class for an autocomplete element

Creates an HTML input text element that at every keypressed javascript event checks in an array of options if there's a match and autocompletes the text in case of match.

For the JavaScript code thanks to Martin Honnen and Nicholas C. Zakas See http://www.faqts.com/knowledge_base/view.phtml/aid/13562 and http://www.sitepoint.com/article/1220

Example:

 $autocomplete =& $form->addElement('autocomplete', 'fruit', 'Favourite fruit:');

 $options = array("Apple", "Orange", "Pear", "Strawberry");
 $autocomplete->setOptions($options);

Author: Matteo Di Giovinazzo <matteodg@infinito.it>
Version: Release: 3.2.14
Since: 3.2

[ Top ]

Method Detail

HTML_QuickForm_autocomplete (Constructor) [line 87]

void HTML_QuickForm_autocomplete(
[string
$elementName = null], [string
$elementLabel = null], [array
$options = null], [mixed
$attributes = null])

Class constructor

Access: public

Parameters:

string	`$elementName`	—	(optional)Input field name attribute
string	`$elementLabel`	—	(optional)Input field label in form
array	`$options`	—	(optional)Autocomplete options
mixed	`$attributes`	—	(optional)Either a typical HTML attribute string or an associative array. Date format is passed along the attributes.

[ Top ]

setOptions [line 107]

void setOptions(
array
$options)

Sets the options for the autocomplete input text element

Access: public

Parameters:

array $options — Array of options for the autocomplete input text element

[ Top ]

toHtml [line 121]

string toHtml(
)

Returns Html for the autocomplete input text element

Access: public

Overrides HTML_QuickForm_input::toHtml() (Returns the input field in HTML)

[ Top ]