Class TActiveListControlAdapter

TComponent
   |
   --TApplicationComponent
      |
      --TControlAdapter
         |
         --TActiveControlAdapter
            |
            --TActiveListControlAdapter

TActiveListControlAdapter class.

Adapte the list controls to allows the selections on the client-side to be altered during callback response.

Method Summary
protected boolean	canUpdateClientSide ()
void	clearSelection () Clears all existing selections on the client side.
void	setSelectedIndex ( integer $index) Selects an item based on zero-base index on the client side.
void	setSelectedIndices ( array $indices) Selects a list of item based on zero-base indices on the client side.
void	setSelectedValue ( string $value) Sets selection by item value on the client side.
void	setSelectedValues ( array $values) Sets selection by a list of item values on the client side.
void	updateListItems () Update the client-side list options.

Methods Inherited From TActiveControlAdapter
TActiveControlAdapter::getBaseActiveControl(), TActiveControlAdapter::getIsTrackingPageState(), TActiveControlAdapter::getStateTracker(), TActiveControlAdapter::onLoad(), TActiveControlAdapter::render(), TActiveControlAdapter::renderCallbackClientScripts(), TActiveControlAdapter::saveState(), TActiveControlAdapter::setBaseActiveControl(), TActiveControlAdapter::setBaseControlClass()

Methods Inherited From TControlAdapter
TControlAdapter::createChildControls(), TControlAdapter::getControl(), TControlAdapter::getPage(), TControlAdapter::loadState(), TControlAdapter::onInit(), TControlAdapter::onLoad(), TControlAdapter::onPreRender(), TControlAdapter::onUnload(), TControlAdapter::render(), TControlAdapter::renderChildren(), TControlAdapter::saveState()

Methods Inherited From TApplicationComponent
TApplicationComponent::getApplication(), TApplicationComponent::getRequest(), TApplicationComponent::getResponse(), TApplicationComponent::getService(), TApplicationComponent::getSession(), TApplicationComponent::getUser(), TApplicationComponent::publishAsset(), TApplicationComponent::publishFilePath()

Methods 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()

Method Details

canUpdateClientSide

protected boolean canUpdateClientSide

()

Output
boolean	true if can update client-side attributes.
Exception

clearSelection

public void clearSelection

()

Clears all existing selections on the client side.

setSelectedIndex

public void setSelectedIndex

(integer $index )

Selects an item based on zero-base index on the client side.

Input
integer	$index	the index (zero-based) of the item to be selected
Output
Exception

setSelectedIndices

public void setSelectedIndices

(array $indices )

Selects a list of item based on zero-base indices on the client side.

Input
array	$indices	list of index of items to be selected
Output
Exception

setSelectedValue

public void setSelectedValue

(string $value )

Sets selection by item value on the client side.

Input
string	$value	the value of the item to be selected.
Output
Exception

setSelectedValues

public void setSelectedValues

(array $values )

Sets selection by a list of item values on the client side.

Input
array	$values	list of the selected item values
Output
Exception

updateListItems

public void updateListItems

()

Update the client-side list options.