Class QHListControl

A control that lets you dynamically create an html unordered or ordered hierarchical list with sub-lists. These structures are often used as the basis for javascript widgets like menu bars.

Also supports data binding. When using the data binder, it will recreate the item list each time it draws, and then delete the item list so that the list does not get stored in the formstate. It is common for lists like this to associate items in a database with items in a list through the value attribute of each item. In an effort to make sure that database ids are not exposed to the client (for security reasons), the value attribute is encrypted.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QHListControl uses QListItemManager, QDataBinder

Located at includes/base_controls/QHListControl.class.php

Methods summary
`public`	# `AddItem( QHListItem\|string $mixListItemOrName, null\|string $strValue = null, null\|string $strAnchor = null )` Adds an item to the list. Adds an item to the list. Parameters `$mixListItemOrName` `$strValue` `$strAnchor`
`public`	# `AddItems( array $objItemArray )` Adds an array of items to the list. The array can also be an array of key>val pairs Adds an array of items to the list. The array can also be an array of key>val pairs Parameters `$objItemArray` An array of QHListItems or key=>val pairs to be sent to constructor.
`public`	# `ParsePostData( )` This is not a typical input control, so there is no post data to read. This is not a typical input control, so there is no post data to read.
`public boolean`	# `Validate( )` Validate the submitted data Validate the submitted data Returns boolean
`public string`	# `GetId( )` Return the id. Used by QListItemManager trait. Return the id. Used by QListItemManager trait. Returns string
`public string`	# `GetControlHtml( )` Returns the HTML for the control and all subitems. Returns the HTML for the control and all subitems. Returns string
`protected string`	# `GetItemHtml( mixed $objItem )` Return the html to draw an item. Return the html to draw an item. Parameters `$objItem` Returns string
`protected string`	# `GetItemText( mixed $objItem )` Return the text html of the item. Return the text html of the item. Parameters `$objItem` Returns string
`protected QListItemStyle`	# `GetItemStyler( mixed $objItem )` Return the item styler for the given item. Combines the generic item styles found in this class with any specific item styles found in the item. Return the item styler for the given item. Combines the generic item styles found in this class with any specific item styles found in the item. Parameters `$objItem` Returns `QListItemStyle`
`protected string`	# `EncryptValue( string $value )` Return the encrypted value of the given object Return the encrypted value of the given object Parameters `$value` Returns string
`public string`	# `DecryptValue( $strEncryptedValue )` Return the decrypted value of the given value string. Return the decrypted value of the given value string. Parameters `$strEncryptedValue` Returns string
`protected array\|null\|string`	# `GetSubTagAttributes( mixed $objItem )` Return the attributes for the sub tag that wraps the item tags Return the attributes for the sub tag that wraps the item tags Parameters `$objItem` Returns array\|null\|string
`public mixed`	# `__get( string $strName )` PHP magic function PHP magic function Parameters `$strName` Returns mixed Throws Exception\|`QCallerException` Overrides `QControlBase::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP magic method PHP magic method Parameters `$strName` `$mixValue` Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QControlBase::__set()`

Methods inherited from QControlBase
AddAction(), AddActionArray(), AddAttributeScript(), AddChildControl(), AddCssFile(), AddJavascriptFile(), AddPluginCssFile(), AddPluginJavascriptFile(), AddWrapperCssClass(), Blink(), EvaluateTemplate(), Focus(), ForgetState(), GetAllActions(), GetAttributes(), GetChildControl(), GetChildControls(), GetControlFromHierarchyByMethodName(), GetCustomAttribute(), GetCustomAttributes(), GetCustomStyle(), GetEndHtml(), GetEndScript(), GetForm(), GetJavaScriptForEvent(), GetJqControlId(), GetModelConnectorParams(), GetNonWrappedHtml(), GetState(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), ProcessActionParameters(), PutState(), 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(), 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()`

Methods used from QDataBinder
`CallDataBinder(), GetForm(), HasDataBinder(), SetDataBinder(), Sleep(), Wakeup()`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected string`	`$strTag` top level tag top level tag	# `'ul'`
`protected string`	`$strItemTag` item tag item tag	# `'li'`
`protected null\|QListItemStyle`	`$objItemStyle` The common style for all elements in the list The common style for all elements in the list	# `null`
`protected null\|QCryptography`	`$objCrypt` the temporary cryptography object for encrypting database values sent to the client the temporary cryptography object for encrypting database values sent to the client	# `null`
`protected boolean`	`$blnEncryptValues` Whether to encrypt values Whether to encrypt values	# `true`

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`

Properties used from QDataBinder
`$objDataBinder`

Magic properties summary
`public string`	`$Tag` Tag for main wrapping object
`public string`	`$ItemTag` Tag for each item
`public boolean`	`$EncryptValues` Whether to encrypt the values that are printed in the html. Useful if the values are something you want to publicly hide, like database ids. True by default.

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

Interfaces

Traits

Exceptions

Functions

Class QHListControl

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides