Class QCheckBoxLegacyColumn

This defines a specific column for a DataGrid All the appearance properties should be self-explanatory. The SortByCommand and ReverseSortByCommand are both optional -- and are explained in more depth in DataGrid.inc

QBaseClass

QDataGridLegacyColumn

QCheckBoxLegacyColumn

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

Methods summary
`public`	# `__construct( string $strName, QDataGridLegacy $dataGrid, mixed $objOverrideParameters = null )` Creates a QDataGridLegacyColumn of checkboxes Creates a QDataGridLegacyColumn of checkboxes Parameters `$strName` The header to give the column, shown as the label for the Select All checkbox `$dataGrid` The parent DataGrid. This does not add the column to that datagrid `$objOverrideParameters` Same as QDataGridLegacy Throws Exception `QCallerException` Overrides `QDataGridLegacyColumn::__construct()`
`protected integer`	# `GetColIndex( )` Returns the index of this column in the parent datagrid Returns the index of this column in the parent datagrid Returns integer The index of the column, or -1 if not found
`public`	# `SetCheckboxCallback( Object $objParent, string $strFuncName )` Sets the callback method for when a checkbox is created. Used for initializing the checkbox state Sets the callback method for when a checkbox is created. Used for initializing the checkbox state Parameters `$objParent` The object the callback function belongs to `$strFuncName` The name of the function to call back
`public`	# `chkSelectAll_Render( $blnWithLabel = false )`
`public`	# `chkSelected_Render( $_ITEM )`
`public string`	# `chkIdToItemId( $strCheckId )` Convert a checkbox id to its corresponding item id Convert a checkbox id to its corresponding item id Parameters `$strCheckId` Returns string
`public array`	# `GetSelectedItems( string $strClass, boolean $blnIndex = true, null $objClauses = null )` Returns an array of items for the selected rows, loaded using the specified class's Load($id) method Returns an array of items for the selected rows, loaded using the specified class's Load($id) method Parameters `$strClass` The class name of the object type to return `$blnIndex` Whether to spend extra time indexing the array by Id `$objClauses` QQClause expression Returns array An array of selected Items
`public array`	# `GetSelectedIds( )` Returns an array of the Ids of the items selected. Note this only includes rendered controls. Returns an array of the Ids of the items selected. Note this only includes rendered controls. Returns array An array of selected Ids
`public bool[]`	# `GetChangedIds( boolean $blnRemember = false )` Returns an array of changed ids. Returns an array of changed ids. Parameters `$blnRemember` Returns bool[] Key is the object Id, value is the new check state (bln)
`public`	# `AcceptChanges( )` Considers the current state to be the new baseline Considers the current state to be the new baseline
`public`	# `SetSelectAllCheckbox( $value )`
`public`	# `SetCheckbox( $itemId, $value )`
`public mixed`	# `__get( string $strName )` PHP magic method PHP magic method Parameters `$strName` Returns mixed Throws Exception\|`QCallerException` Overrides `QDataGridLegacyColumn::__get()`
`public mixed`	# `__set( string $strName, string $mixValue )` Override method to perform a property "Set" This will set the property $strName to be $mixValue Override method to perform a property "Set" This will set the property $strName to be $mixValue Parameters `$strName` Name of the property to set `$mixValue` New value of the property Returns mixed Throws Exception\|`QCallerException` Overrides `QDataGridLegacyColumn::__set()`

Methods inherited from QDataGridLegacyColumn
`ClearFilter(), FilterAddListItem(), GetActiveFilterState(), GetActiveFilterValue(), GetAttributes(), HasFilter(), SetActiveFilterState()`

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

Properties summary
`protected`	`$objDataGrid`	#
`protected boolean`	`$blnHtmlEntities` Determines if the contents of this column have to be processed through HtmlEntities Determines if the contents of this column have to be processed through HtmlEntities	# `false`
`protected`	`$chkSelectAll`	#
`protected integer`	`$colIndex`	# `-1`
`protected`	`$objCheckboxCallback`	# `null`
`protected`	`$strCheckboxCallbackFunc`	# `null`
`protected string`	`$strPrimaryKey`	# `'Id'`

Properties inherited from QDataGridLegacyColumn
$arrFilterByCommand, $arrFilterList, $blnFontBold, $blnFontItalic, $blnFontOverline, $blnFontStrikeout, $blnFontUnderline, $blnHasResetButton, $blnWrap, $intFilterBoxSize, $intFilterColId, $objActiveFilter, $objFilterConstant, $objOrderByClause, $objReverseOrderByClause, $strBackColor, $strBorderColor, $strBorderStyle, $strBorderWidth, $strCssClass, $strFilterPostfix, $strFilterPrefix, $strFilterType, $strFontNames, $strFontSize, $strForeColor, $strHorizontalAlign, $strHtml, $strName, $strVerticalAlign, $strWidth

Magic properties inherited from QDataGridLegacyColumn
$ActiveFilter, $BackColor, $BorderColor, $BorderStyle, $BorderWidth, $CssClass, $Filter, $FilterBoxSize, $FilterByCommand, $FilterColId, $FilterConstant, $FilterInfo, $FilterList, $FilterPostfix, $FilterPrefix, $FilterType, $FontBold, $FontItalic, $FontNames, $FontOverline, $FontSize, $FontStrikeout, $FontUnderline, $ForeColor, $HasResetButton, $HorizontalAlign, $Html, $HtmlEntities, $Name, $OrderByClause, $ReverseOrderByClause, $ReverseSortByCommand, $SortByCommand, $VerticalAlign, $Width, $Wrap

Packages

Classes

Traits

Exceptions

Functions

Class QCheckBoxLegacyColumn

Parameters

Throws

Overrides

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Overrides

Parameters

Returns

Throws

Overrides