Class yii\grid\CheckboxColumn

所有类 | 属性 | 方法

继承	yii\grid\CheckboxColumn » yii\grid\Column » yii\base\Object
可用自版本	2.0

CheckboxColumn网格视图中显示一列复选框。

添加一个CheckboxColumn网格yii\grid\GridView数据表格,将其添加到列配置如下:

'columns' => [
    // ...
    [
        'class' => 'yii\grid\CheckboxColumn',
        // you may configure additional properties here
    ],
]

用户可以点击复选框选择网格的行。选中的行可以获得通过调用以下JavaScript代码:

var keys = $('#grid').yiiGridView('getSelectedRows');
// keys is an array consisting of the keys associated with the selected rows

在CheckboxColumn更多细节和使用信息,请参阅指南文章数据窗口小部件。

公共属性

隐藏继承属性

属性	类型	描述	定义在
$checkboxOptions	array|Closure	HTML属性复选框。	yii\grid\CheckboxColumn
$cssClass	string	css类将被用来发现复选框。	yii\grid\CheckboxColumn
$multiple	boolean	是否可以选择多个行。	yii\grid\CheckboxColumn
$name	string	输入的名称复选框输入字段。	yii\grid\CheckboxColumn

公共方法

隐藏继承方法

方法	描述	定义在
init()		yii\grid\CheckboxColumn
registerClientScript()	注册所需的JavaScript	yii\grid\CheckboxColumn

受保护的方法

隐藏继承方法

方法	描述	定义在
getHeaderCheckBoxName()	返回头复选框的名称	yii\grid\CheckboxColumn
renderDataCellContent()		yii\grid\CheckboxColumn
renderHeaderCellContent()	呈现标头单元格内容。	yii\grid\CheckboxColumn

属性详情

$checkboxOptions public property

HTML属性复选框。这个属性可以是一个数组或一个匿名函数(关闭),返回一个数组。函数的签名应该如下:function ($model, $key, $index, $column)。 $model, $key,,$index参考模型,目前呈现的关键和索引行和列指的是 $column  yii\grid\CheckboxColumn对象。一个函数可以用来将不同属性分配给不同的行基于这一行中的数据。特别是如果你想设置一个不同的值的复选框可以使用这个选项

'checkboxOptions' => function ($model, $key, $index, $column) {
    return ['value' => $model->name];
}

参见 yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array|Closure $checkboxOptions = []

$cssClass public property （可用自版本 2.0.9）

css类将被用来发现复选框。

public string $cssClass = null

$multiple public property

是否可以选择多个行。默认值为true。

public boolean $multiple = true

$name public property

输入复选框输入字段的名称。这将是不带 [] 确保在数组中。

public string $name = 'selection'

方法详情

getHeaderCheckBoxName() protected 方法 （可用自版本 2.0.8）

返回头复选框的名称

protected string getHeaderCheckBoxName ( )
return	string	Header checkbox name

init() public 方法

 

public void init ( )
throws	yii\base\InvalidConfigException	if $name is not set.

registerClientScript() public 方法 （可用自版本 2.0.8）

注册所需的JavaScript

public void registerClientScript ( )

renderDataCellContent() protected 方法

 

protected void renderDataCellContent ( $model, $key, $index )
$model
$key
$index

renderHeaderCellContent() protected 方法

显示标题单元格内容。

他默认实现简单呈现网格\yii\grid\header。这种方法可能会覆盖自定义标题单元格的呈现。

protected string renderHeaderCellContent ( )
return	string	呈现的结果

转载于:https://my.oschina.net/u/3359744/blog/860796