HTML_Common
[ class tree: HTML_Common ] [ index: HTML_Common ] [ all elements ]

Class: HTML_QuickForm_autocomplete

Source Location: /pear/HTML/QuickForm/autocomplete.php

Class Overview

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

Class to dynamically create an HTML input text element that at every keypressed javascript event, check in an array of options if there's a match and autocomplete the text in case of match.


Author(s):

Version:

  • 1.0

Methods


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: HTML_Common

HTML_Common::HTML_Common()
Class constructor
HTML_Common::apiVersion()
Returns the current API version
HTML_Common::charset()
Sets the charset to use by htmlspecialchars() function
HTML_Common::display()
Displays the HTML to the screen
HTML_Common::getAttribute()
Returns the value of the given attribute
HTML_Common::getAttributes()
Returns the assoc array (default) or string of attributes
HTML_Common::getComment()
Returns the HTML comment
HTML_Common::getTabOffset()
Returns the tabOffset
HTML_Common::removeAttribute()
Removes an attribute
HTML_Common::setAttribute()
Sets the value of the attribute
HTML_Common::setAttributes()
Sets the HTML attributes
HTML_Common::setComment()
Sets the HTML comment to be displayed at the beginning of the HTML string
HTML_Common::setLineEnd()
Sets the line end style to Windows, Mac, Unix or a custom string.
HTML_Common::setTab()
Sets the string used to indent HTML
HTML_Common::setTabOffset()
Sets the tab offset
HTML_Common::toHtml()
Abstract method. Must be extended to return the objects HTML
HTML_Common::updateAttributes()
Updates the passed attributes without changing the other existing attributes

Class Details

[line 44]
Class to dynamically create an HTML input text element that at every keypressed javascript event, check in an array of options if there's a match and autocomplete the text in case of match.

Ex: $autocomplete =& $form->addElement('autocomplete', 'fruit', 'Favourite fruit:'); $options = array("Apple", "Orange", "Pear", "Strawberry"); $autocomplete->setOptions($options);




Tags:

author:  Matteo Di Giovinazzo <matteodg@infinito.it>
version:  1.0


[ Top ]


Class Methods


constructor HTML_QuickForm_autocomplete [line 78]

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

Class constructor



Tags:

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 ]

method setOptions [line 98]

void setOptions( array $options)

Sets the options for the autocomplete input text element



Tags:

access:  public


Parameters:

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

[ Top ]

method toHtml [line 112]

string toHtml( )

Returns Html for the autocomplete input text element



Tags:

access:  public


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

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:41 +0100 by phpDocumentor 1.4.3