Docs For Class TActiveDropDownList

Description

Implements interfaces:

TActiveDropDownList class.

The active control counter part to drop down list control. The AutoPostBack property is set to true by default. Thus, when the drop down list selection is changed the OnCallback event is raised after OnSelectedIndexChanged event.

With ActiveControl.EnabledUpdate set to true (default is true), changes to the selection, after OnLoad event has been raised, will be updated. on the client side.

List items can be changed dynamically during a callback request.

since: 3.1
version: $Id: TActiveDropDownList.php 1458 2006-10-06 03:46:05Z wei $
author: Wei Zhuo <weizhuo[at]gmail[dot]com>

Located in /Web/UI/ActiveControls/TActiveDropDownList.php (line 39)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TDataBoundControl
               |
               --TListControl
                  |
                  --TDropDownList
                     |
                     --TActiveDropDownList

Method Summary

TActiveDropDownList __construct ()

void addAttributesToRender (mixed $writer)

TActiveListItemCollection createListItemCollection ()

TBaseActiveCallbackControl getActiveControl ()

null getClientClassName ()

TCallbackClientSide getClientSide ()

void onCallback (TCallbackEventParameter $param)

void onPreRender (mixed $param)

void raiseCallbackEvent (TCallbackEventParameter $param)

void renderClientControlScript (mixed $writer)

Methods

Constructor __construct (line 46)

Creates a new callback control, sets the adapter to TActiveListControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

access: public

TActiveDropDownList __construct ()

Redefinition of:

TControl::__construct(): Constructor.

addAttributesToRender (line 105)

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

access: protected

void addAttributesToRender (mixed $writer)

Redefinition of:

TDropDownList::addAttributesToRender(): Adds attributes to renderer.

createListItemCollection (line 86)

Creates a collection object to hold list items. A specialized TActiveListItemCollection is created to allow the drop down list options to be added.

This method may be overriden to create a customized collection.

return: the collection object
access: protected

TActiveListItemCollection createListItemCollection ()

Redefinition of:

TListControl::createListItemCollection(): Creates a collection object to hold list items.

getActiveControl (line 56)

return: standard callback control options.
access: public

TBaseActiveCallbackControl getActiveControl ()

getClientClassName (line 74)

No client class for this control.

This method overrides the parent implementation.

return: no javascript class name.
access: protected

null getClientClassName ()

Redefinition of:

TDropDownList::getClientClassName(): Gets the name of the javascript class responsible for performing postback for this control.

getClientSide (line 64)

return: client side request options.
access: public

TCallbackClientSide getClientSide ()

onCallback (line 131)

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

access: public

void onCallback (TCallbackEventParameter $param)

TCallbackEventParameter $param: event parameter to be passed to the event handlers

onPreRender (line 139)

Updates the client-side options if the item list has changed after the OnLoad event.

access: public

void onPreRender (mixed $param)

Redefinition of:

TDataBoundControl::onPreRender(): Ensures any pending databind is performed.

raiseCallbackEvent (line 119)

Raises the callback event. This method is required by ICallbackEventHandler interface.

This method is mainly used by framework and control developers.

access: public

void raiseCallbackEvent (TCallbackEventParameter $param)

TCallbackEventParameter $param: the event parameter

renderClientControlScript (line 97)

Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in addAttributesToRender.

access: protected

void renderClientControlScript (mixed $writer)

Redefinition of:

TListControl::renderClientControlScript(): Renders the javascript for list control.

Inherited Methods

Inherited From TDropDownList

TDropDownList::addAttributesToRender()
TDropDownList::getClientClassName()
TDropDownList::getSelectedIndex()
TDropDownList::getValidationPropertyValue()
TDropDownList::loadPostData()
TDropDownList::raisePostDataChangedEvent()
TDropDownList::setSelectedIndices()

Inherited From TListControl

TListControl::addAttributesToRender()
TListControl::addParsedObject()
TListControl::clearSelection()
TListControl::createListItemCollection()
TListControl::formatDataValue()
TListControl::getAppendDataBoundItems()
TListControl::getAutoPostBack()
TListControl::getCausesValidation()
TListControl::getClientClassName()
TListControl::getDataGroupField()
TListControl::getDataTextField()
TListControl::getDataTextFormatString()
TListControl::getDataValueField()
TListControl::getEnableClientScript()
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::renderClientControlScript()
TListControl::renderContents()
TListControl::saveState()
TListControl::setAppendDataBoundItems()
TListControl::setAutoPostBack()
TListControl::setCausesValidation()
TListControl::setDataGroupField()
TListControl::setDataTextField()
TListControl::setDataTextFormatString()
TListControl::setDataValueField()
TListControl::setEnableClientScript()
TListControl::setSelectedIndex()
TListControl::setSelectedIndices()
TListControl::setSelectedValue()
TListControl::setSelectedValues()
TListControl::setText()
TListControl::setValidationGroup()

Inherited From TDataBoundControl

TDataBoundControl::createPagedDataSource()
TDataBoundControl::dataBind()
TDataBoundControl::dataSourceViewChanged()
TDataBoundControl::determineDataSource()
TDataBoundControl::ensureDataBound()
TDataBoundControl::getAllowCustomPaging()
TDataBoundControl::getAllowPaging()
TDataBoundControl::getCurrentPageIndex()
TDataBoundControl::getData()
TDataBoundControl::getDataMember()
TDataBoundControl::getDataSource()
TDataBoundControl::getDataSourceID()
TDataBoundControl::getDataSourceView()
TDataBoundControl::getInitialized()
TDataBoundControl::getIsDataBound()
TDataBoundControl::getPageCount()
TDataBoundControl::getPageSize()
TDataBoundControl::getRequiresDataBinding()
TDataBoundControl::getSelectParameters()
TDataBoundControl::getUsingDataSourceID()
TDataBoundControl::getVirtualItemCount()
TDataBoundControl::onDataBound()
TDataBoundControl::onDataSourceChanged()
TDataBoundControl::onInit()
TDataBoundControl::onPreRender()
TDataBoundControl::pagePreLoad()
TDataBoundControl::performDataBinding()
TDataBoundControl::setAllowCustomPaging()
TDataBoundControl::setAllowPaging()
TDataBoundControl::setCurrentPageIndex()
TDataBoundControl::setDataMember()
TDataBoundControl::setDataSource()
TDataBoundControl::setDataSourceID()
TDataBoundControl::setInitialized()
TDataBoundControl::setIsDataBound()
TDataBoundControl::setPageSize()
TDataBoundControl::setRequiresDataBinding()
TDataBoundControl::setVirtualItemCount()
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::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::createChildControls()
TControl::createControlCollection()
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::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
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::setCustomData()
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::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
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

TControl::AUTOMATIC_ID_PREFIX
TControl::CLIENT_ID_SEPARATOR
TControl::CS_CHILD_INITIALIZED
TControl::CS_CONSTRUCTED
TControl::CS_INITIALIZED
TControl::CS_LOADED
TControl::CS_PRERENDERED
TControl::CS_STATE_LOADED
TControl::ID_FORMAT
TControl::ID_SEPARATOR
TControl::IS_CHILD_CREATED
TControl::IS_CREATING_CHILD
TControl::IS_DISABLE_THEMING
TControl::IS_DISABLE_VIEWSTATE
TControl::IS_ID_SET
TControl::IS_SKIN_APPLIED
TControl::IS_STYLESHEET_APPLIED
TControl::RF_ADAPTER
TControl::RF_AUTO_BINDINGS
TControl::RF_CHILD_STATE
TControl::RF_CONTROLS
TControl::RF_CONTROLSTATE
TControl::RF_DATA_BINDINGS
TControl::RF_EVENTS
TControl::RF_NAMED_CONTROLS
TControl::RF_NAMED_CONTROLS_ID
TControl::RF_NAMED_OBJECTS
TControl::RF_SKIN_ID