Class QListControl

Abstract object which is extended by anything which involves lists of selectable items. This object is the foundation for the ListBox, CheckBoxList, RadioButtonList and TreeNav. Subclasses can be used as objects to specify one-to-many and many-to-many relationships.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QListControl uses QListItemManager

Direct known subclasses

QCheckBoxList, QListBoxBase, QRadioButtonList

Indirect known subclasses

ProjectPickerListBox, QListBox, QSelectMenu, QSelectMenuBase, QSelectMenuGen

Abstract
Package: Controls
See: QListItemStyle
Located at includes/base_controls/QListControl.class.php

Methods summary
`public`	# `AddItem( $mixListItemOrName, $strValue = null, $blnSelected = null, $strItemGroup = null, $mixOverrideParameters = null )`
`public`	# `AddItems( array $mixItemArray, mixed $mixSelectedValues = null, string $strItemGroup = null, string $mixOverrideParameters = null )` Adds an array of items, or an array of key=>value pairs. Convenient for adding a list from a type table. When passing key=>val pairs, mixSelectedValues can be an array, or just a single value to compare against to indicate what is selected. Adds an array of items, or an array of key=>value pairs. Convenient for adding a list from a type table. When passing key=>val pairs, mixSelectedValues can be an array, or just a single value to compare against to indicate what is selected. Parameters `$mixItemArray` Array of QListItems or key=>val pairs. `$mixSelectedValues` Array of selected values, or value of one selection `$strItemGroup` allows you to apply grouping ( tag) `$mixOverrideParameters` OverrideParameters for ListItemStyle Throws Exception\|`QInvalidCastException`
`public string`	# `GetId( )` Return the id. Used by QListItemManager trait. Return the id. Used by QListItemManager trait. Returns string
`public`	# `UnselectAllItems( boolean $blnRefresh = true )` Recursively unselects all the items and subitems in the list. Recursively unselects all the items and subitems in the list. Parameters `$blnRefresh` True if we need to reflect the change in the html page. False if we are recording what the user has already done.
`public`	# `SetSelectedItemsById( array $strIdArray, boolean $blnRefresh = true )` Selects the given items by Id, and unselects items that are not in the list. Selects the given items by Id, and unselects items that are not in the list. Parameters `$strIdArray` `$blnRefresh`
`public`	# `SetSelectedItemsByIndex( array $intIndexArray, boolean $blnRefresh = true )` Set the selected item by index. This can only set top level items. Lower level items are untouched. Set the selected item by index. This can only set top level items. Lower level items are untouched. Parameters `$intIndexArray` `$blnRefresh`
`public`	# `SetSelectedItemsByValue( array $mixValueArray, boolean $blnRefresh = true )` Set the selected items by value. We equate nulls and empty strings, but must be careful not to equate those with a zero. Set the selected items by value. We equate nulls and empty strings, but must be careful not to equate those with a zero. Parameters `$mixValueArray` `$blnRefresh`
`public`	# `SetSelectedItemsByName( array $strNameArray, boolean $blnRefresh = true )` Set the selected items by name. Set the selected items by name. Parameters `$strNameArray` `$blnRefresh`
`protected`	# `RefreshSelection( )` This method is called when a selection is changed. It should execute the code to refresh the selected state of the items in the control. This method is called when a selection is changed. It should execute the code to refresh the selected state of the items in the control. The default just redraws the control. Redrawing a large list control can take a lot of time, so subclasses should implement a way of just setting the selection through javasacript.
`public null\|QListItem`	# `GetFirstSelectedItem( )` Return the first item selected. Return the first item selected. Returns null\|`QListItem` Throws Exception `QIndexOutOfRangeException` `QInvalidCastException`
`public QListItem[]`	# `GetSelectedItems( )` Return all the selected items. Return all the selected items. Returns `QListItem[]` Throws Exception `QIndexOutOfRangeException` `QInvalidCastException`
`public mixed`	# `GetState( )` Returns the current state of the control to be able to restore it later. Returns the current state of the control to be able to restore it later. Returns mixed Overrides `QControlBase::GetState()`
`public`	# `PutState( mixed $state )` Restore the state of the control. Restore the state of the control. Parameters `$state` Overrides `QControlBase::PutState()`
`public mixed`	# `__get( string $strName )` PHP __get magic method implementation PHP __get magic method implementation Parameters `$strName` Property Name Returns mixed Throws Exception\|`QCallerException` Overrides `QControlBase::__get()`
`public mixed\|`	# `__set( string $strName, string $mixValue )` PHP __set magic method implementation PHP __set magic method implementation Parameters `$strName` Property Name `$mixValue` Propety Value Returns mixed\| Throws `QIndexOutOfRangeException`\|Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QControlBase::__set()`
`public static QModelConnectorParam[]`	# `GetModelConnectorParams( )` Returns a description of the options available to modify by the designer for the code generator. Returns a description of the options available to modify by the designer for the code generator. Returns `QModelConnectorParam[]` Overrides `QControlBase::GetModelConnectorParams()`

Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetControlHtml(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetEndScript(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetNonWrappedHtml(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ParsePostData(), ProcessActionParameters(), Refresh(), RemoveAllActions(), RemoveChildControl(), RemoveChildControls(), RemoveCustomAttribute(), RemoveCustomStyle(), RemoveWrapperCssClass(), Render(), RenderActionScripts(), RenderAjax(), RenderAttributeScripts(), RenderChildren(), RenderComment(), RenderCssStyles(), RenderExtensionRenderer(), RenderHelper(), RenderHtmlAttributes(), RenderOutput(), RenderWithError(), RenderWithName(), RenderWrappedOutput(), ResetFlags(), ResetOnPageStatus(), SetCustomAttribute(), SetCustomStyle(), SetFocus(), SetForm(), SetParentControl(), Sleep(), SleepHelper(), Validate(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState(), __construct()

Methods inherited from QHtmlAttributeManagerBase
`AddCssClass(), GetCssStyle(), GetDataAttribute(), GetHtmlAttribute(), GetHtmlAttributes(), HasCssClass(), HasCssStyle(), HasHtmlAttribute(), Override(), RemoveCssClass(), RemoveCssClassesByPrefix(), RemoveCssStyle(), RemoveDataAttribute(), RemoveHtmlAttribute(), RenderTag(), SetCssBoxValue(), SetCssClass(), SetCssStyle(), SetDataAttribute(), SetHtmlAttribute()`

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

Methods used from QListItemManager
`AddItemAt(), AddListItem(), AddListItems(), FindItem(), FindItemByValue(), GetAllItems(), GetItem(), GetItemCount(), MarkAsModified(), Reindex(), RemoveAllItems(), RemoveItem(), ReplaceItem()`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected null\|QListItemStyle`	`$objItemStyle` The common style for all elements in the list The common style for all elements in the list	# `null`

Properties inherited from QControlBase
$blnActionsMustTerminate, $blnAutoRender, $blnDisplay, $blnIsBlockElement, $blnMinimize, $blnModified, $blnOnPage, $blnRendered, $blnRendering, $blnRequired, $blnSaveState, $blnScriptsOnly, $blnUseWrapper, $blnVisible, $blnWrapLabel, $blnWrapperModified, $mixActionParameter, $mixCausesValidation, $objActionArray, $objChildControlArray, $objDraggable, $objDroppable, $objForm, $objLinkedNode, $objParentControl, $objResizable, $objWatcher, $objWrapperStyler, $strAttributeScripts, $strControlId, $strCssClass, $strCustomAttributeArray, $strCustomStyleArray, $strFormAttributes, $strHtmlAfter, $strHtmlBefore, $strInstructions, $strJavaScripts, $strName, $strPreferredRenderMethod, $strRenderMethod, $strStyleSheets, $strValidationError, $strWarning

Properties inherited from QHtmlAttributeManagerBase
`$attributes, $styles`

Properties used from QListItemManager
`$objListItemArray`

Magic properties summary
`public integer`	`$SelectedIndex` is the index number of the control that is selected. "-1" means that nothing is selected. If multiple items are selected, it will return the lowest index number of all ListItems that are currently selected. Set functionality: selects that specific ListItem and will unselect all other currently selected ListItems.
`public string`	`$SelectedName` simply returns ListControl::SelectedItem->Name, or null if nothing is selected.
`public mixed`	`$SelectedValue` simply returns ListControl::SelectedItem->Value, or null if nothing is selected.
`public array`	`$SelectedNames` returns an array of all selected names
`public array`	`$SelectedValues` returns an array of all selected values
`public string`	`$ItemStyle` `QListItemStyle`
`public read-only integer`	`$ItemCount` the current count of ListItems in the control.
`public read-only QListItem`	`$SelectedItem` (readonly!) returns the ListItem object, itself, that is selected (or the ListItem with the lowest index number of a ListItems that are currently selected if multiple items are selected). It will return null if nothing is selected.
`public read-only array`	`$SelectedItems` returns an array of selected ListItems (if any).

Magic properties inherited from QControlBase
`$ActionParameter, $ActionsMustTerminate, $AutoRender, $CausesValidation, $ControlId, $Form, $FormAttributes, $HtmlAfter, $HtmlBefore, $Instructions, $JavaScripts, $LinkedNode, $Minimize, $Modified, $Moveable, $Name, $OnPage, $ParentControl, $PreferredRenderMethod, $RenderMethod, $Rendered, $Rendering, $Required, $Resizable, $SaveState, $ScriptsOnly, $StyleSheets, $UseWrapper, $ValidationError, $Visible, $Warning, $WrapLabel, $WrapperCssClass, $WrapperModified`

Magic properties inherited from QHtmlAttributeManagerBase
`$AccessKey, $AltText, $BackColor, $BorderCollapse, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Cursor, $Data, $Display, $DisplayStyle, $Enabled, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $Height, $HorizontalAlign, $Left, $Margin, $NoWrap, $Opacity, $OrderedListType, $Overflow, $Padding, $Position, $ReadOnly, $TabIndex, $ToolTip, $Top, $UnorderedListStyle, $VerticalAlign, $Width`

Packages

Classes

Traits

Exceptions

Functions

Class QListControl

Direct known subclasses

Indirect known subclasses

Parameters

Throws

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Returns

Throws

Returns

Overrides

Parameters

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides