Class TListBox

Description

Implements interfaces:

TListBox class

TListBox displays a list box on a Web page that allows single or multiple selection. The list box allows multiple selections if SelectionMode is 'Multiple'. It takes single selection only if 'Single'. The property Rows specifies how many rows of options are visible at a time. See TListControl for inherited properties.

Located in /Web/UI/WebControls/TListBox.php (line 32)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TDataBoundControl
               |
               --TListControl
                  |
                  --TListBox
Method Summary
boolean getIsMultiSelect ()
integer getRows ()
string getSelectionMode ()
boolean loadPostData (string $key, array $values)
void onPreRender (mixed $param)
void setRows (integer $value)
void setSelectionMode (string $value)
Methods
addAttributesToRender (line 39)

Adds attribute name-value pairs to renderer.

This method overrides the parent implementation with additional list box specific attributes.

  • access: protected
void addAttributesToRender (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:
TListControl::addAttributesToRender()
Adds attributes to renderer.
getIsMultiSelect (line 142)
  • return: whether this control allows multiple selection
  • access: protected
boolean getIsMultiSelect ()

Redefinition of:
TListControl::getIsMultiSelect()
getRows (line 150)
  • return: the number of rows to be displayed in the list control
  • access: public
integer getRows ()
getSelectionMode (line 169)
  • return: the selection mode (Single, Multiple). Defaults to 'Single'.
  • access: public
string getSelectionMode ()
getValidationPropertyValue (line 188)

Returns the value to be validated.

This methid is required by IValidatable interface.

  • return: the value of the property to be validated.
  • access: public
mixed getValidationPropertyValue ()
loadPostData (line 69)

Loads user input data.

This method is primarly used by framework developers.

  • return: whether the data of the component has been changed
  • access: public
boolean loadPostData (string $key, array $values)
  • string $key: the key that can be used to retrieve data from the input data collection
  • array $values: the input data collection
onPreRender (line 55)

Registers the list control to load post data on postback.

This method overrides the parent implementation.

  • access: public
void onPreRender (mixed $param)
  • mixed $param: event parameter

Redefinition of:
TDataBoundControl::onPreRender()
Ensures any pending databind is performed.
raisePostDataChangedEvent (line 132)

Raises postdata changed event.

This method is required by IPostBackDataHandler interface. It is invoked by the framework when SelectedIndices property is changed on postback. This method is primarly used by framework developers.

  • access: public
void raisePostDataChangedEvent ()
setRows (line 158)
  • access: public
void setRows (integer $value)
  • integer $value: the number of rows to be displayed in the list control
setSelectionMode (line 178)

Sets the selection mode of the list control (Single, Multiple)

  • access: public
void setSelectionMode (string $value)
  • string $value: the selection mode

Inherited Methods

Inherited From TListControl

TListControl::addAttributesToRender()
TListControl::addParsedObject()
TListControl::clearSelection()
TListControl::createListItemCollection()
TListControl::formatDataValue()
TListControl::getAppendDataBoundItems()
TListControl::getAutoPostBack()
TListControl::getCausesValidation()
TListControl::getDataTextField()
TListControl::getDataTextFormatString()
TListControl::getDataValueField()
TListControl::getHasItems()
TListControl::getIsMultiSelect()
TListControl::getItemCount()
TListControl::getItems()
TListControl::getPostBackOptions()
TListControl::getSelectedIndex()
TListControl::getSelectedIndices()
TListControl::getSelectedItem()
TListControl::getSelectedValue()
TListControl::getSelectedValues()
TListControl::getTagName()
TListControl::getText()
TListControl::getValidationGroup()
TListControl::loadState()
TListControl::onSelectedIndexChanged()
TListControl::onTextChanged()
TListControl::performDataBinding()
TListControl::renderContents()
TListControl::saveState()
TListControl::setAppendDataBoundItems()
TListControl::setAutoPostBack()
TListControl::setCausesValidation()
TListControl::setDataTextField()
TListControl::setDataTextFormatString()
TListControl::setDataValueField()
TListControl::setSelectedIndex()
TListControl::setSelectedIndices()
TListControl::setSelectedValue()
TListControl::setSelectedValues()
TListControl::setText()
TListControl::setValidationGroup()

Inherited From TDataBoundControl

TDataBoundControl::dataBind()
TDataBoundControl::dataSourceViewChanged()
TDataBoundControl::determineDataSource()
TDataBoundControl::ensureDataBound()
TDataBoundControl::getData()
TDataBoundControl::getDataMember()
TDataBoundControl::getDataSource()
TDataBoundControl::getDataSourceID()
TDataBoundControl::getDataSourceView()
TDataBoundControl::getInitialized()
TDataBoundControl::getIsDataBound()
TDataBoundControl::getRequiresDataBinding()
TDataBoundControl::getSelectParameters()
TDataBoundControl::getUsingDataSourceID()
TDataBoundControl::onDataBound()
TDataBoundControl::onDataSourceChanged()
TDataBoundControl::onInit()
TDataBoundControl::onPreRender()
TDataBoundControl::pagePreLoad()
TDataBoundControl::performDataBinding()
TDataBoundControl::setDataMember()
TDataBoundControl::setDataSource()
TDataBoundControl::setDataSourceID()
TDataBoundControl::setInitialized()
TDataBoundControl::setIsDataBound()
TDataBoundControl::setRequiresDataBinding()
TDataBoundControl::validateDataSource()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::broadcastEventInternal()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::createChildControls()
TControl::createControlCollection()
TControl::createdOnTemplate()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasControls()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants

Inherited Constants

Inherited from TControl

Documentation generated on Sun, 04 Jun 2006 18:59:45 -0400 by phpDocumentor 1.3.0RC4