Class TControlCollection

Description

TControlCollection class

TControlCollection implements a collection that enables controls to maintain a list of their child controls.

  • since: 3.0
  • version: $Id: TControl.php 2434 2008-04-18 09:47:05Z mikl $
  • author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/TControl.php (line 1769)

TComponent
   |
   --TList
      |
      --TControlCollection
Direct descendents
Class Description
TEmptyControlCollection TEmptyControlCollection class
TViewCollection TViewCollection class.
TTableRowCollection TTableRowCollection class.
TTableCellCollection TTableCellCollection class.
TTabViewCollection TTabViewCollection class.
Method Summary
TControlCollection __construct (TControl $owner, [boolean $readOnly = false])
void clear ()
void insertAt (integer $index, mixed $item)
mixed removeAt (integer $index)
Methods
Constructor __construct (line 1782)

Constructor.

  • access: public
TControlCollection __construct (TControl $owner, [boolean $readOnly = false])
  • TControl $owner: the control that owns this collection.
  • boolean $readOnly: whether the list is read-only

Redefinition of:
TList::__construct()
Constructor.

Redefined in descendants as:
clear (line 1835)

Overrides the parent implementation by invoking TControl::clearNamingContainer

  • access: public
void clear ()

Redefinition of:
TList::clear()
Removes all items in the list.
getOwner (line 1791)
  • return: the control that owns this collection.
  • access: protected
TControl getOwner ()
insertAt (line 1804)

Inserts an item at the specified position.

This overrides the parent implementation by performing additional operations for each newly added child control.

  • access: public
  • throws: TInvalidDataTypeException if the item to be inserted is neither a string nor a TControl.
void insertAt (integer $index, mixed $item)
  • integer $index: the speicified position.
  • mixed $item: new item

Redefinition of:
TList::insertAt()
Inserts an item at the specified position.

Redefined in descendants as:
removeAt (line 1824)

Removes an item at the specified position.

This overrides the parent implementation by performing additional cleanup work when removing a child control.

  • return: the removed item.
  • access: public
mixed removeAt (integer $index)
  • integer $index: the index of the item to be removed.

Redefinition of:
TList::removeAt()
Removes an item at the specified position.

Inherited Methods

Inherited From TList

TList::__construct()
TList::add()
TList::clear()
TList::contains()
TList::copyFrom()
TList::count()
TList::getCount()
TList::getIterator()
TList::getReadOnly()
TList::indexOf()
TList::insertAt()
TList::itemAt()
TList::mergeWith()
TList::offsetExists()
TList::offsetGet()
TList::offsetSet()
TList::offsetUnset()
TList::remove()
TList::removeAt()
TList::setReadOnly()
TList::toArray()

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

Documentation generated on Mon, 21 Apr 2008 11:34:14 -0400 by phpDocumentor 1.3.0RC4