PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TListBox

TListBox class

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

Since v3.0.3, TListBox starts to support optgroup. To specify an option group for a list item, set a Group attribute with it,

$listitem->Attributes->Group="Group Name";
// or <com:TListItem Attributes.Group="Group Name" .../> in template
TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TDataBoundControl
Extended by TListControl implements IDataRenderer
Extended by TListBox implements IPostBackDataHandler, IValidatable

Direct known subclasses

TActiveListBox
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TListBox.php
Methods summary
protected
# addAttributesToRender( THtmlWriter $writer )

Adds attribute name-value pairs to renderer. This method overrides the parent implementation with additional list box specific attributes.

Adds attribute name-value pairs to renderer. This method overrides the parent implementation with additional list box specific attributes.

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TListControl::addAttributesToRender()
protected string
# getClientClassName( )

Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.

Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.

Returns

string
the javascript class name

Overrides

TListControl::getClientClassName()
public
# onPreRender( mixed $param )

Registers the list control to load post data on postback. This method overrides the parent implementation.

Registers the list control to load post data on postback. This method overrides the parent implementation.

Parameters

$param
mixed
event parameter

Overrides

TDataBoundControl::onPreRender()
public boolean
# loadPostData( string $key, array $values )

Loads user input data. This method is primarly used by framework developers.

Loads user input data. This method is primarly used by framework developers.

Parameters

$key
string
the key that can be used to retrieve data from the input data collection
$values
array
the input data collection

Returns

boolean
whether the data of the component has been changed

Implementation of

IPostBackDataHandler::loadPostData()
public
# raisePostDataChangedEvent( )

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

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

Implementation of

IPostBackDataHandler::raisePostDataChangedEvent()
public boolean
# getDataChanged( )

Returns a value indicating whether postback has caused the control data change. This method is required by the IPostBackDataHandler interface.

Returns a value indicating whether postback has caused the control data change. This method is required by the IPostBackDataHandler interface.

Returns

boolean
whether postback has caused the control data change. False if the page is not in postback mode.

Implementation of

IPostBackDataHandler::getDataChanged()
protected boolean
# getIsMultiSelect( )

Returns

boolean
whether this control allows multiple selection

Overrides

TListControl::getIsMultiSelect()
public integer
# getRows( )

Returns

integer
the number of rows to be displayed in the list control
public
# setRows( integer $value )

Parameters

$value
integer
the number of rows to be displayed in the list control
public TListSelectionMode
# getSelectionMode( )

Returns

TListSelectionMode
the selection mode (Single, Multiple). Defaults to TListSelectionMode::Single.
public
# setSelectionMode( TListSelectionMode $value )

Parameters

$value
TListSelectionMode
the selection mode
public mixed
# getValidationPropertyValue( )

Returns the value to be validated. This methid is required by IValidatable interface.

Returns the value to be validated. This methid is required by IValidatable interface.

Returns

mixed
the value of the property to be validated.

Implementation of

IValidatable::getValidationPropertyValue()
public boolean
# getIsValid( )

Returns true if this control validated successfully. Defaults to true.

Returns true if this control validated successfully. Defaults to true.

Returns

boolean
wether this control validated successfully.

Implementation of

IValidatable::getIsValid()
public boolean
# setIsValid( boolean $value )

Parameters

$value
boolean
wether this control is valid.

Returns

boolean
wether this control's validators validated successfully

Implementation of

IValidatable::setIsValid()
Methods inherited from TListControl
addParsedObject(), clearSelection(), createListItemCollection(), formatDataValue(), getAppendDataBoundItems(), getAutoPostBack(), getCausesValidation(), getData(), getDataGroupField(), getDataTextField(), getDataTextFormatString(), getDataValueField(), getEnableClientScript(), getHasItems(), getItemCount(), getItems(), getPostBackOptions(), getPromptText(), getPromptValue(), getSelectedIndex(), getSelectedIndices(), getSelectedItem(), getSelectedValue(), getSelectedValues(), getTagName(), getText(), getValidationGroup(), loadState(), onSelectedIndexChanged(), onTextChanged(), performDataBinding(), renderClientControlScript(), renderContents(), renderPrompt(), saveState(), setAppendDataBoundItems(), setAutoPostBack(), setCausesValidation(), setData(), setDataGroupField(), setDataTextField(), setDataTextFormatString(), setDataValueField(), setEnableClientScript(), setPromptText(), setPromptValue(), setSelectedIndex(), setSelectedIndices(), setSelectedValue(), setSelectedValues(), setText(), setValidationGroup()
Methods inherited from TDataBoundControl
createPagedDataSource(), dataBind(), dataSourceViewChanged(), determineDataSource(), ensureDataBound(), getAllowCustomPaging(), getAllowPaging(), getCurrentPageIndex(), getDataMember(), getDataSource(), getDataSourceID(), getDataSourceView(), getInitialized(), getIsDataBound(), getPageCount(), getPageSize(), getRequiresDataBinding(), getSelectParameters(), getUsingDataSourceID(), getVirtualItemCount(), onDataBound(), onDataSourceChanged(), onInit(), pagePreLoad(), setAllowCustomPaging(), setAllowPaging(), setCurrentPageIndex(), setDataMember(), setDataSource(), setDataSourceID(), setInitialized(), setIsDataBound(), setPageSize(), setRequiresDataBinding(), setVirtualItemCount(), validateDataSource()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), render(), renderBeginTag(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__construct(), __get(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadStateRecursive(), onDataBinding(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO