Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • X2CheckBoxColumn
  • X2DataColumnGeneric
  • Overview
  • Package
  • Class
  • Tree

Class X2CheckBoxColumn

CCheckBoxColumn represents a grid view column of checkboxes.

CCheckBoxColumn supports no checking (read-only), single check and multiple checking. The mode is determined according to CCheckBoxColumn::$selectableRows. When in multiple checking mode, the header cell will display an additional checkbox, clicking on which will check or uncheck all of the checkboxes in the data cells. The header cell can be customized by CCheckBoxColumn::$headerTemplate.

Additionally selecting a checkbox can select a grid view row (depending on CGridView::selectableRows value) if CCheckBoxColumn::$selectableRows is null (default).

By default, the checkboxes rendered in data cells will have the values that are the same as the key values of the data model. One may change this by setting either CCheckBoxColumn::$name or CCheckBoxColumn::$value.

CComponent
Extended by CGridColumn
Extended by CCheckBoxColumn
Extended by X2CheckBoxColumn
Package: zii\widgets\grid
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.1
Located at x2engine/protected/components/X2GridView/X2CheckBoxColumn.php
Methods summary
public
# init( )

Initializes the column. This method registers necessary client script for the checkbox column.

Initializes the column. This method registers necessary client script for the checkbox column.

Overrides

CCheckBoxColumn::init()
public
# renderHeaderCellContent( )

Renders the header cell content. This method will render a checkbox in the header when CCheckBoxColumn::$selectableRows is greater than 1 or in case CCheckBoxColumn::$selectableRows is null when CGridView::selectableRows is greater than 1. This method is Copyright (c) 2008-2014 by Yii Software LLC http://www.yiiframework.com/license/

Renders the header cell content. This method will render a checkbox in the header when CCheckBoxColumn::$selectableRows is greater than 1 or in case CCheckBoxColumn::$selectableRows is null when CGridView::selectableRows is greater than 1. This method is Copyright (c) 2008-2014 by Yii Software LLC http://www.yiiframework.com/license/

Overrides

CGridColumn::renderHeaderCellContent()
protected
# renderDataCellContent( integer $row, mixed $data )

Renders the data cell content. This method renders a checkbox in the data cell.

Renders the data cell content. This method renders a checkbox in the data cell.

Parameters

$row
integer
$row the row number (zero-based)
$data
mixed
$data the data associated with the row This method is Copyright (c) 2008-2014 by Yii Software LLC http://www.yiiframework.com/license/

Overrides

CGridColumn::renderDataCellContent()
Methods inherited from CCheckBoxColumn
getDataCellContent(), getHeaderCellContent()
Methods inherited from CGridColumn
__construct(), getFilterCellContent(), getFooterCellContent(), getHasFooter(), renderDataCell(), renderFilterCell(), renderFilterCellContent(), renderFooterCell(), renderFooterCellContent(), renderHeaderCell()
Methods inherited from CComponent
__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()
Properties summary
public array $headerHtmlOptions array ()
#

$headerHtmlOptions

$headerHtmlOptions

public array $headerCheckBoxHtmlOptions array ()
#
public mixed $width
#
Properties inherited from CCheckBoxColumn
$checkBoxHtmlOptions, $checked, $disabled, $footerHtmlOptions, $headerTemplate, $htmlOptions, $name, $selectableRows, $value
Properties inherited from CGridColumn
$cssClassExpression, $filterHtmlOptions, $footer, $grid, $header, $id, $visible
Magic properties inherited from CGridColumn
$filterCellContent, $footerCellContent, $hasFooter, $headerCellContent
X2CRM Documentation API documentation generated by ApiGen 2.8.0