Class QListItem

Utilized by the QListControl class which contains a private array of ListItems. Originally these represented items in a select list, but now represent items in any kind of control that has repetitive items in it. This includes list controls, menus, drop-downs, and hierarchical lists. This is a general purpose container for the options in each item. Note that not all the options are used by every control, and we don't do any drawing here.

QBaseClass

QListItemBase

QListItem implements JsonSerializable

Direct known subclasses

QAutocompleteListItem

Package: Controls
Located at includes/base_controls/QListItem.class.php

Methods summary
`public QListItem`	# `__construct( string $strName, string $strValue = null, boolean $blnSelected = false, string $strItemGroup = null, array\|string $mixOverrideParameters = null )` Creates a QListItem Creates a QListItem Parameters `$strName` is the displayed Name of the Item `$strValue` is any text that represents the value of the ListItem (e.g. maybe a DB Id) `$blnSelected` is a boolean of whether or not this item is selected or not (optional) `$strItemGroup` is the group (if any) in which the Item should be displayed `$mixOverrideParameters` allows you to override item styles. It is either a string formatted as Property=Value or an array of the format array(property => value) Returns `QListItem` Throws Exception\|`QCallerException` Overrides `QListItemBase::__construct()`
`public string`	# `toJsObject( )` Returns the details of the control as javascript string. This is customized for the JQuery UI autocomplete. If your widget requires something else, you will need to subclass and override this. Returns the details of the control as javascript string. This is customized for the JQuery UI autocomplete. If your widget requires something else, you will need to subclass and override this. Returns string
`public string`	# `jsonSerialize( )` Returns the details of the control as javascript string. This is customized for the JQuery UI autocomplete. If your widget requires something else, you will need to subclass and override this. Returns the details of the control as javascript string. This is customized for the JQuery UI autocomplete. If your widget requires something else, you will need to subclass and override this. Returns string Implementation of `JsonSerializable::jsonSerialize()`
`public mixed`	# `__get( string $strName )` PHP magic method PHP magic method Parameters `$strName` Returns mixed Throws Exception\|`QCallerException` Overrides `QListItemBase::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP magic method PHP magic method Parameters `$strName` `$mixValue` Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QListItemBase::__set()`

Methods inherited from QListItemBase
`FindItem(), GetAttributes(), GetId(), GetStyle(), MarkAsModified(), Reindex(), SetId()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Properties summary
`protected boolean`	`$blnSelected` Is the item selected? Is the item selected?	# `false`
`protected null\|string`	`$strItemGroup` Group to which the item belongs, if control supports groups. Group to which the item belongs, if control supports groups.	# `null`
`protected string`	`$strLabel` Label text for the item. Label text for the item.	# `null`

Properties inherited from QListItemBase
`$objItemStyle, $strId, $strName, $strValue`

Magic properties summary
`public boolean`	`$Selected` is a boolean of whether or not this item is selected or not (do only! use during initialization, otherwise this should be set by the `QListControl`!)
`public string`	`$ItemGroup` is the group (if any) in which the Item should be displayed
`public string`	`$Label` is optional text to display instead of the Name for certain controls.

Magic properties inherited from QListItemBase
`$Empty, $Id, $ItemStyle, $Name, $Text, $Value`

Packages

Classes

Traits

Exceptions

Functions

Class QListItem

Direct known subclasses

Parameters

Returns

Throws

Overrides

Returns

Returns

Implementation of

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides