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 TListItemCollection

TListItemCollection class.

TListItemCollection maintains a list of TListItem for TListControl.

TComponent
Extended by TList implements IteratorAggregate, ArrayAccess, Countable
Extended by TListItemCollection

Direct known subclasses

TActiveListItemCollection
Package: System\Collections
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Collections/TListItemCollection.php
Methods summary
public TListItem
# createListItem( integer $index = -1 )

Creates a list item object. This method may be overriden to provide a customized list item object.

Creates a list item object. This method may be overriden to provide a customized list item object.

Parameters

$index
integer
index where the newly created item is to be inserted at. If -1, the item will be appended to the end.

Returns

TListItem
list item object
protected TListItem
# createNewListItem( mixed $text = null )

Returns

TListItem
new item.
public
# insertAt( integer $index, TListItem $item )

Inserts an item into the collection.

Inserts an item into the collection.

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.
$item
TListItem
the item to be inserted.

Throws

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

Overrides

TList::insertAt()
public integer
# findIndexByValue( string $value, boolean $includeDisabled = true )

Finds the lowest cardinal index of the item whose value is the one being looked for.

Finds the lowest cardinal index of the item whose value is the one being looked for.

Parameters

$value
string
the value to be looked for
$includeDisabled
boolean
whether to look for disabled items also

Returns

integer
the index of the item found, -1 if not found.
public integer
# findIndexByText( string $text, boolean $includeDisabled = true )

Finds the lowest cardinal index of the item whose text is the one being looked for.

Finds the lowest cardinal index of the item whose text is the one being looked for.

Parameters

$text
string
the text to be looked for
$includeDisabled
boolean
whether to look for disabled items also

Returns

integer
the index of the item found, -1 if not found.
public TListItem
# findItemByValue( string $value, boolean $includeDisabled = true )

Finds the item whose value is the one being looked for.

Finds the item whose value is the one being looked for.

Parameters

$value
string
the value to be looked for
$includeDisabled
boolean
whether to look for disabled items also

Returns

TListItem
the item found, null if not found.
public TListItem
# findItemByText( string $text, boolean $includeDisabled = true )

Finds the item whose text is the one being looked for.

Finds the item whose text is the one being looked for.

Parameters

$text
string
the text to be looked for
$includeDisabled
boolean
whether to look for disabled items also

Returns

TListItem
the item found, null if not found.
public
# loadState( array|null $state )

Loads state into every item in the collection. This method should only be used by framework and control developers.

Loads state into every item in the collection. This method should only be used by framework and control developers.

Parameters

$state
array|null
state to be loaded.
public array|null
# saveState( )

Saves state of items. This method should only be used by framework and control developers.

Saves state of items. This method should only be used by framework and control developers.

Returns

array|null
the saved state
Methods inherited from TList
__construct(), add(), clear(), contains(), copyFrom(), count(), getCount(), getIterator(), getReadOnly(), indexOf(), insertAfter(), insertBefore(), itemAt(), mergeWith(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), remove(), removeAt(), 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