Class ExampleCheckColumn1

A checkbox column that specifically is for inclusion in a QDataGrid object. The two work together to hand off important events and functionality.

The default functionality of this class shows the name of the column in the header, and uses the primary key of a database object as the checkbox id. It also stores the information on which boxes are checked in the session variable so that they can be easily recalled and do not clutter the form state. You can override additional functions below if you would like to store the checkbox state with the items themselves, or somewhere else.

If you turn on the CheckAll box in the header, you must subclass this column, and at a minimum implement the GetAllIds() function so that it knows the full set of ids to record as checked.

This column keeps track of what is checked and not checked in real time using ajax, rather than using POST methods. The primary reason is that what is visible in the table will generally not be the complete set of data available from the database if the datagrid is using a paginator.

QBaseClass

QAbstractHtmlTableColumn

QAbstractHtmlTableDataColumn

QHtmlTableCheckBoxColumn

QDataGrid_CheckBoxColumn

ExampleCheckColumn1

Package: Controls
Located at assets/php/examples/datagrid/qcheckboxcolumn.php

Methods summary
`protected array\|null`	# `GetAllIds( )` Override this to return an array of all the ids of the objects in the table, including ids that are not currently visible on the page being shown. If you create your own CheckAll function, or if you are not showing the CheckAll box in the header you do not need to implement this. Override this to return an array of all the ids of the objects in the table, including ids that are not currently visible on the page being shown. If you create your own CheckAll function, or if you are not showing the CheckAll box in the header you do not need to implement this. If you want to return an empty set, return an empty array. Returns array\|null Overrides `QDataGrid_CheckBoxColumn::GetAllIds()`

Methods inherited from QDataGrid_CheckBoxColumn
`CheckAll(), ClearCheckedItems(), Click(), GetCheckboxId(), GetCheckboxParams(), GetCheckboxValue(), GetCheckedItemIds(), GetItemCheckedState(), GetItemId(), IsChecked(), SetItemCheckedState()`

Methods inherited from QHtmlTableCheckBoxColumn
`FetchCellObject(), FetchHeaderCellValue(), GetCheckboxName(), SetCheckParamCallback(), Sleep(), Wakeup(), __get(), __set()`

Methods inherited from QAbstractHtmlTableDataColumn
`FetchCellValue()`

Methods inherited from QAbstractHtmlTableColumn
`GetCellClass(), GetCellId(), GetCellParams(), GetCellStyle(), GetColParams(), GetHeaderCellParams(), ParsePostData(), RenderCell(), RenderColTag(), RenderHeaderCell(), __construct()`

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

Properties inherited from QDataGrid_CheckBoxColumn
`$blnAllChecked, $blnShowCheckAll`

Properties inherited from QHtmlTableCheckBoxColumn
`$blnHtmlEntities, $checkParamCallback`

Properties inherited from QAbstractHtmlTableDataColumn
`$objOrderByClause, $objPostCallback, $objReverseOrderByClause, $strFormat, $strPostMethod`

Properties inherited from QAbstractHtmlTableColumn
`$blnRenderAsHeader, $blnVisible, $cellParamsCallback, $intSpan, $objCellStyler, $objColStyler, $objHeaderCellStyler, $objParentTable, $strCssClass, $strHeaderCssClass, $strId, $strName`

Magic properties inherited from QHtmlTableCheckBoxColumn
`$ShowCheckAll`

Magic properties inherited from QAbstractHtmlTableDataColumn
`$Format, $OrderByClause, $PostCallback, $PostMethod, $ReverseOrderByClause`

Magic properties inherited from QAbstractHtmlTableColumn
`$CellParamsCallback, $CellStyler, $ColStyler, $CssClass, $HeaderCellStyler, $HeaderCssClass, $HtmlEntities, $Id, $Name, $ParentTable, $RenderAsHeader, $Span, $Visible, $_ParentTable`

Packages

Classes

Traits

Exceptions

Functions

Class ExampleCheckColumn1

Returns

Overrides