Class QCheckBoxList

This class will render a List of HTML Checkboxes (inhereting from ListControl). By definition, checkbox lists are multiple-select ListControls.

So assuming you have a list of 10 items, and you have RepeatColumn set to 3: RepeatDirection::Horizontal would render as: 1 2 3 4 5 6 7 8 9 10

RepeatDirection::Vertical would render as: 1 5 8 2 6 9 3 7 10 4

QBaseClass

QHtmlAttributeManagerBase

QHtmlAttributeManager

QControlBase

QControl

QListControl uses QListItemManager

QCheckBoxList

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

Methods summary
`public`	# `__construct( QControl\|QForm\|QControlBase $objParentObject, string $strControlId = null )` Creates a QControlBase object This constructor will generally not be used to create a QControlBase object. Instead it is used by the classes which extend the class. Only the parent object parameter is required. If the option strControlId parameter is not used, QCubed will generate the id. Creates a QControlBase object This constructor will generally not be used to create a QControlBase object. Instead it is used by the classes which extend the class. Only the parent object parameter is required. If the option strControlId parameter is not used, QCubed will generate the id. Parameters `$objParentObject` `$strControlId` optional id of this Control. In html, this will be set as the value of the id attribute. The id can only contain alphanumeric characters. If this parameter is not passed, QCubed will generate the id. Throws Exception\|`QCallerException` Overrides `QControlBase::__construct()`
`public`	# `ParsePostData( )` Parses the post data. Many different scenarios are covered. See below. Parses the post data. Many different scenarios are covered. See below.
`public string`	# `GetEndScript( )` Return the javascript associated with the control. Return the javascript associated with the control. Returns string Overrides `QControlBase::GetEndScript()`
`protected string`	# `GetItemHtml( QListItem $objItem, integer $intIndex, string $strTabIndex, boolean $blnWrapLabel )` Return the HTML for the given item. Return the HTML for the given item. Parameters `$objItem` `$intIndex` `$strTabIndex` `$blnWrapLabel` Returns string
`protected string`	# `GetControlHtml( )` Return the html to draw the base control. Return the html to draw the base control. Returns string
`public string`	# `RenderButtonTable( )` Renders the button group as a table, paying attention to the number of columns wanted. Renders the button group as a table, paying attention to the number of columns wanted. Returns string
`public string`	# `RenderButtonSet( )` Renders the checkbox list as a buttonset, rendering just as a list of checkboxes and allowing css or javascript to format the rest. Renders the checkbox list as a buttonset, rendering just as a list of checkboxes and allowing css or javascript to format the rest. Returns string
`public string`	# `RenderButtonColumn( )` Render as a single column. This implementation simply wraps the columns in divs. Render as a single column. This implementation simply wraps the columns in divs. Returns string
`public boolean`	# `Validate( )` Validate the control. Validate the control. 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 mixed`	# `__get( string $strName )` PHP __get magic method implementation PHP __get magic method implementation Parameters `$strName` Property Name Returns mixed Throws Exception\|`QCallerException` Overrides `QListControl::__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 `QListControl::__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 `QListControl::GetModelConnectorParams()`

Methods inherited from QListControl
`AddItem(), AddItems(), GetFirstSelectedItem(), GetId(), GetSelectedItems(), GetState(), PutState(), 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(), 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 summary
`integer`	`ButtonModeNone`	# `0`
`integer`	`ButtonModeJq`	# `1`
`integer`	`ButtonModeSet`	# `2`
`integer`	`ButtonModeList`	# `3`

Constants inherited from QControlBase
`CommentEnd, CommentStart`

Properties summary
`protected string`	`$strTextAlign`	# `QTextAlign::Right`
`protected boolean`	`$blnHtmlEntities`	# `true`
`protected integer`	`$intCellPadding`	# `-1`
`protected integer`	`$intCellSpacing`	# `-1`
`protected integer`	`$intRepeatColumns`	# `1`
`protected string`	`$strRepeatDirection`	# `QRepeatDirection::Vertical`
`protected null\|QListItemStyle`	`$objItemStyle` The common style for all elements in the list The common style for all elements in the list	# `null`
`protected`	`$intButtonMode`	#
`protected`	`$strMaxHeight`	#

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 string`	`$Text` is used to display text that is displayed next to the checkbox. The text is rendered as an html "Label For" the checkbox.
`public integer`	`$CellPadding` specified the HTML Table's CellPadding
`public integer`	`$CellSpacing` specified the HTML Table's CellSpacing
`public integer`	`$RepeatColumns` specifies how many columns should be rendered in the HTML Table
`public string`	`$RepeatDirection` pecifies which direction should the list go first...
`public boolean`	`$HtmlEntities`

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 QCheckBoxList

Parameters

Throws

Overrides

Returns

Overrides

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides

Returns

Overrides