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 TActiveListItemCollection

TActiveListItemCollection class.

Allows TActiveDropDownList and TActiveListBox to add new options during callback response. New options can only be added after the TControl::onLoad OnLoad event.

The getListHasChanged ListHasChanged property is true when the list items has changed. The control responsible for the list needs to repopulate the client-side options.

TComponent
Extended by TList implements IteratorAggregate, ArrayAccess, Countable
Extended by TListItemCollection
Extended by TActiveListItemCollection
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1
Located at Web/UI/ActiveControls/TActiveListControlAdapter.php
Methods summary
protected boolean
# canUpdateClientSide( )

Returns

boolean
true if active controls can update client-side and the onLoad event has already been raised.
public
# setControl( IActiveControl $control )

Parameters

$control
IActiveControl
a active list control.
public IActiveControl
# getControl( )

Returns

IActiveControl
active control using the collection.
public boolean
# getListHasChanged( )

Returns

boolean
true if the list has changed after onLoad event.
public
# updateClientSide( )

Update client-side list items.

Update client-side list items.

public
# insertAt( integer $index, TListItem $value )

Inserts an item into the collection. The new option is added on the client-side during callback.

Inserts an item into the collection. The new option is added on the client-side during callback.

Parameters

$index
integer
the location where the item will be inserted. The current item at the place and the following ones will be moved backward.
$value
TListItem
the item to be inserted.

Throws

TInvalidDataTypeException
if the item being inserted is neither a string nor TListItem

Overrides

TListItemCollection::insertAt()
public mixed
# removeAt( integer $index )

Removes an item from at specified index.

Removes an item from at specified index.

Parameters

$index
integer
zero based index.

Returns

mixed
the removed item.

Throws

TInvalidDataValueException
If the index specified exceeds the bound
TInvalidOperationException
if the list is read-only

Overrides

TList::removeAt()
Methods inherited from TListItemCollection
createListItem(), createNewListItem(), findIndexByText(), findIndexByValue(), findItemByText(), findItemByValue(), loadState(), saveState()
Methods inherited from TList
__construct(), add(), clear(), contains(), copyFrom(), count(), getCount(), getIterator(), getReadOnly(), indexOf(), insertAfter(), insertBefore(), itemAt(), mergeWith(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), remove(), setReadOnly(), toArray()
Methods inherited from TComponent
__call(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), 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 TComponent
GLOBAL_RAISE_EVENT_LISTENER
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