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

Class: HTML_QuickForm_ComboBox

Source Location: /combobox.php

Class Overview

HTML_QuickForm_text
   |
   --HTML_QuickForm_ComboBox

This class represents a combobox element of HTML_QuickForm framework.


Author(s):

Version:

  • @package_version@

Methods



Class Details

[line 37]
This class represents a combobox element of HTML_QuickForm framework.



Tags:

license:  PHP
version:  @package_version@
author:  Fabio Ambrosanio <fabio@ambrosanio.com>


[ Top ]


Class Methods


constructor HTML_QuickForm_ComboBox [line 126]

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

Class constructor



Tags:

return:  

With $options you can specify the CSS class to use with different aspects of the combobox. The compobox's aspects that you can change assigning different CSS class are:

    Aspect            Description                                    Default class
  boxClass        external box                                comboBox
     inputClass        input textfield                                comboBoxInput
    buttonClass        dropdown button (if used)                    comboBoxButton
    arrowClass        dropdown arrow (if used)                    comboBoxArrow
    containerClass    dropdown container                            comboBoxContainer
    optionClass        single option inside dropdown container        comboBoxOption
    optionClassOver    single option when mouse is over            comboBoxOptionOver

You can change the button (value)label with buttonValue option, es.: butonValue => 'V' or specify images to use to render the button:

    arrowImage            image used to render the button in normal state
    arrowImageOver        image used when the mouse is over the button
    arrowImageDown        image used when the button in clicked

access:  public


Parameters:

string   $elementName   (required)Input field name attribute.
string   $elementLabel   (required)Input field label in form.
array   $elements   (optional)Combobox elements.
array   $options   (optional)An associative array which elements specify different aspects of the combobox.
mixed   $attributes   (optional)Either a typical HTML attribute string or an associative array. Date format is passed along the attributes.

[ Top ]

method setCSS [line 236]

void setCSS( string $filename, [string $path = false], [string $options = false])

Sets new CSS file



Parameters:

string   $filename   filename of CSS file
string   $path   path of CSS file
string   $options   associative array which elements specify CSS classes for different aspects cf the combobox

[ Top ]

method toHtml [line 156]

string toHtml( )

Returns Html for the Combobox input element



Tags:

return:  the HTML string representing the combobox
access:  public


[ Top ]


Documentation generated on Wed, 29 Nov 2006 22:46:18 +0100 by phpDocumentor 1.3.0RC3