Class QListBoxBase

QListBoxBase will render an HTML DropDown or MultiSelect box [SELECT] element. It extends QListControl. By default, the number of visible rows is set to 1 and the selection mode is set to single, creating a dropdown select box.

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QListControl uses QListItemManager

QListBoxBase

Direct known subclasses

QListBox

Indirect known subclasses

ProjectPickerListBox, QSelectMenu, QSelectMenuBase, QSelectMenuGen

Abstract
Package: Controls
See: QSelectionMode
Located at includes/base_controls/QListBoxBase.class.php

Methods summary
`public`	# `__construct( QControl\|QForm $objParentObject, string $strControlId = null )` QControl-Constructor QControl-Constructor Parameters `$objParentObject` `$strControlId` Throws Exception\|`QCallerException` Overrides `QControlBase::__construct()`
`public`	# `ParsePostData( )` Parses the data received back from the client/browser Parses the data received back from the client/browser
`protected string`	# `GetItemHtml( QListItem $objItem )` Returns the HTML-Code for a single Item Returns the HTML-Code for a single Item Parameters `$objItem` Returns string resulting HTML
`protected string`	# `GetControlHtml( )` Returns the html for the entire control. Returns the html for the entire control. Returns string
`protected string`	# `RenderInnerHtml( )` Return the inner html for the select box. Return the inner html for the select box. Returns string
`abstract protected`	# `GetResetButtonHtml( )`
`public boolean`	# `Validate( )` Determines whether the supplied input data is valid or not. Determines whether the supplied input data is valid or not. Returns boolean
`protected`	# `RefreshSelection( )` Override of superclass that will update the selection using javascript so that the whole control does not need to be redrawn. Override of superclass that will update the selection using javascript so that the whole control does not need to be redrawn. Overrides `QListControl::RefreshSelection()`
`public`	# `PutState( mixed $state )` Restore the state of the control. This override makes sure the item exists before putting it. Otherwise, if the item did not exist, the default selection would be removed and nothing would be selected. Restore the state of the control. This override makes sure the item exists before putting it. Otherwise, if the item did not exist, the default selection would be removed and nothing would be selected. Parameters `$state` Overrides `QListControl::PutState()`
`public mixed`	# `__get( string $strName )` PHP magic function PHP magic function Parameters `$strName` Returns mixed Throws Exception\|`QCallerException` Overrides `QListControl::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` PHP magic method PHP magic method Parameters `$strName` `$mixValue` Returns mixed Throws Exception\|`QCallerException`\|`QInvalidCastException` Overrides `QListControl::__set()`
`public static QModelConnectorParam[]`	# `GetModelConnectorParams( )` Returns an description of the options available to modify by the designer for the code generator. Returns an description of the options available to modify by the designer for the code generator. Returns `QModelConnectorParam[]` Overrides `QListControl::GetModelConnectorParams()`

Methods inherited from QListControl
`AddItem(), AddItems(), GetFirstSelectedItem(), GetId(), GetSelectedItems(), GetState(), SetSelectedItemsById(), SetSelectedItemsByIndex(), SetSelectedItemsByName(), SetSelectedItemsByValue(), UnselectAllItems()`

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(), GetNonWrappedHtml(), GetStyleAttributes(), GetTemplatePath(), GetWrapperAttributes(), GetWrapperStyleAttributes(), GetWrapperStyler(), IsDescendantOf(), IsModified(), MakeCurrent(), MarkAsModified(), MarkAsRendered(), MarkAsWrapperModified(), 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(), ValidateControlAndChildren(), ValidationReset(), VarExport(), Wakeup(), WakeupHelper(), Watch(), _CallActionMethod(), _ProcessActionParams(), _ReadState(), _WriteState()

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 string`	`$strLabelForRequired` Error to be shown if the box is empty, has a name and is marked as required Error to be shown if the box is empty, has a name and is marked as required	#
`protected string`	`$strLabelForRequiredUnnamed` Error to be shown If the box is empty, doesn't have a name and is marked as required Error to be shown If the box is empty, doesn't have a name and is marked as required	#

Properties inherited from QListControl
`$objItemStyle`

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`	`$Rows` specifies how many rows you want to have shown.
`public string`	`$LabelForRequired`
`public string`	`$LabelForRequiredUnnamed`
`public string`	`$SelectionMode` `QSelectionMode` specifies if this is a "Single" or "Multiple" select control.

Magic properties inherited from QListControl
`$ItemCount, $ItemStyle, $SelectedIndex, $SelectedItem, $SelectedItems, $SelectedName, $SelectedNames, $SelectedValue, $SelectedValues`

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 QListBoxBase

Direct known subclasses

Indirect known subclasses

Parameters

Throws

Overrides

Parameters

Returns

Returns

Returns

Returns

Overrides

Parameters

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides