Class we_ui_controls_Select

Description

Class to display a Select

Located in /ui/controls/Select.php (line 30)

we_core_AbstractObject
   |
   --we_ui_abstract_AbstractElement
      |
      --we_ui_abstract_AbstractFormElement
         |
         --we_ui_controls_Select
Class Constant Summary
 kSelectClass = 'we_ui_controls_Select'
 kSelectClassDisabled = 'we_ui_controls_Select_disabled'
Variable Summary
boolean $_multiple
string $_onChange
array $_optgroups
array $_options
integer $_size
Method Summary
void addOption (string $value, string $text)
void addOptions (array $options)
boolean getMultiple ()
string getOnChange ()
array getOptGroups ()
int getOptionNum ()
array getOptions ()
string getOptionsHTML ()
string getSelectedValue ()
integer getSize ()
void __construct ([array $properties = null])
void setMultiple (boolean $_multiple)
void setOnChange (string $_onChange)
void setOptGroups (array $_optgroups)
void setOptions (array $_options)
void setSelectedValue (string $_selectedValue)
void setSize (integer $_size)
string _renderHTML ()
Variables
boolean $_multiple = '' (line 83)

multiple attribute

  • access: protected
string $_onChange = '' (line 55)

onChange attribute

  • access: protected
array $_optgroups = array() (line 69)

option groups of select

  • access: protected
array $_options = array() (line 62)

options of select

  • access: protected
string $_selectedValue = '' (line 76)

selected value of select

  • access: protected
integer $_size = '' (line 48)

size attribute

  • access: protected

Inherited Variables

Inherited from we_ui_abstract_AbstractFormElement

we_ui_abstract_AbstractFormElement::$_name

Inherited from we_ui_abstract_AbstractElement

we_ui_abstract_AbstractElement::$_class
we_ui_abstract_AbstractElement::$_CSSFiles
we_ui_abstract_AbstractElement::$_disabled
we_ui_abstract_AbstractElement::$_height
we_ui_abstract_AbstractElement::$_hidden
we_ui_abstract_AbstractElement::$_id
we_ui_abstract_AbstractElement::$_JSFiles
we_ui_abstract_AbstractElement::$_lang
we_ui_abstract_AbstractElement::$_left
we_ui_abstract_AbstractElement::$_overflow
we_ui_abstract_AbstractElement::$_position
we_ui_abstract_AbstractElement::$_style
we_ui_abstract_AbstractElement::$_title
we_ui_abstract_AbstractElement::$_top
we_ui_abstract_AbstractElement::$_width
Methods
addOption (line 243)

The function add new option to a select box

void addOption (string $value, string $text)
  • string $value
  • string $text
addOptions (line 255)

The function adds one or more options to a select box

void addOptions (array $options)
  • array $options
getMultiple (line 150)

Retrieve multiple attribute

  • access: public
boolean getMultiple ()
getOnChange (line 110)

Retrieve onChange attribute

  • access: public
string getOnChange ()
getOptGroups (line 210)

Retrieve option groups of select

  • access: public
array getOptGroups ()
getOptionNum (line 230)

The function returns number of options

int getOptionNum ()
getOptions (line 190)

Retrieve options of select

  • access: public
array getOptions ()
getOptionsHTML (line 271)

Renders and returns HTML of options

  • access: public
string getOptionsHTML ()
getSelectedValue (line 170)

Retrieve selected value

  • access: public
string getSelectedValue ()
getSize (line 130)

Retrieve size attribute

  • access: public
integer getSize ()
Constructor __construct (line 93)

Constructor

Sets object properties if set in $properties array

  • access: public
void __construct ([array $properties = null])
  • array $properties: associative array containing named object properties

Redefinition of:
we_core_AbstractObject::__construct()
Constructor
setMultiple (line 160)

Set multiple attribute

  • access: public
void setMultiple (boolean $_multiple)
  • boolean $_multiple
setOnChange (line 120)

Set onChange attribute

  • access: public
void setOnChange (string $_onChange)
  • string $_onChange
setOptGroups (line 220)

Set option groups of select

  • access: public
void setOptGroups (array $_optgroups)
  • array $_optgroups
setOptions (line 200)

Set options of select

  • access: public
void setOptions (array $_options)
  • array $_options
setSelectedValue (line 180)

Set selected value

  • access: public
void setSelectedValue (string $_selectedValue)
  • string $_selectedValue
setSize (line 140)

Set size attribute

  • access: public
void setSize (integer $_size)
  • integer $_size
_renderHTML (line 311)

Renders and returns HTML of select

  • access: protected
string _renderHTML ()

Redefinition of:
we_ui_abstract_AbstractElement::_renderHTML()
Renders and returns HTML of ui element

Inherited Methods

Inherited From we_ui_abstract_AbstractFormElement

we_ui_abstract_AbstractFormElement::getName()
we_ui_abstract_AbstractFormElement::setName()

Inherited From we_ui_abstract_AbstractElement

we_ui_abstract_AbstractElement::addCSSFile()
we_ui_abstract_AbstractElement::addCSSFiles()
we_ui_abstract_AbstractElement::addJSFile()
we_ui_abstract_AbstractElement::addJSFiles()
we_ui_abstract_AbstractElement::computeJSURL()
we_ui_abstract_AbstractElement::getClass()
we_ui_abstract_AbstractElement::getCSSFiles()
we_ui_abstract_AbstractElement::getDisabled()
we_ui_abstract_AbstractElement::getHeight()
we_ui_abstract_AbstractElement::getHidden()
we_ui_abstract_AbstractElement::getHTML()
we_ui_abstract_AbstractElement::getId()
we_ui_abstract_AbstractElement::getJSFiles()
we_ui_abstract_AbstractElement::getJSHTML()
we_ui_abstract_AbstractElement::getLang()
we_ui_abstract_AbstractElement::getLeft()
we_ui_abstract_AbstractElement::getOverflow()
we_ui_abstract_AbstractElement::getPosition()
we_ui_abstract_AbstractElement::getStyle()
we_ui_abstract_AbstractElement::getTitle()
we_ui_abstract_AbstractElement::getTop()
we_ui_abstract_AbstractElement::getWidth()
we_ui_abstract_AbstractElement::setClass()
we_ui_abstract_AbstractElement::setDisabled()
we_ui_abstract_AbstractElement::setHeight()
we_ui_abstract_AbstractElement::setHidden()
we_ui_abstract_AbstractElement::setId()
we_ui_abstract_AbstractElement::setLang()
we_ui_abstract_AbstractElement::setLeft()
we_ui_abstract_AbstractElement::setOverflow()
we_ui_abstract_AbstractElement::setPosition()
we_ui_abstract_AbstractElement::setStyle()
we_ui_abstract_AbstractElement::setTitle()
we_ui_abstract_AbstractElement::setTop()
we_ui_abstract_AbstractElement::setWidth()
we_ui_abstract_AbstractElement::_didRenderHTML()
we_ui_abstract_AbstractElement::_getBooleanAttribs()
we_ui_abstract_AbstractElement::_getComputedClassAttrib()
we_ui_abstract_AbstractElement::_getComputedStyleAttrib()
we_ui_abstract_AbstractElement::_getNonBooleanAttribs()
we_ui_abstract_AbstractElement::_renderHTML()
we_ui_abstract_AbstractElement::_willRenderHTML()

Inherited From we_core_AbstractObject

we_core_AbstractObject::__construct()
Class Constants
kSelectClass = 'we_ui_controls_Select' (line 36)

Default class name for Select

kSelectClassDisabled = 'we_ui_controls_Select_disabled' (line 41)

class name for disabled Select

Documentation generated on Mon, 01 Sep 2008 11:35:43 +0200 by phpDocumentor 1.4.0