Class lispa\amos\core\views\grid\CheckboxColumn
Inheritance | lispa\amos\core\views\grid\CheckboxColumn » yii\grid\CheckboxColumn » yii\grid\Column » yii\base\Object |
---|---|
Implements | yii\base\Configurable |
CheckboxColumn displays a column of checkboxes in a grid view.
To add a CheckboxColumn to the \lispa\amos\core\views\grid\GridView, add it to the \lispa\amos\core\views\grid\GridView::columns configuration as follows:
'columns' => [
// ...
[
'class' => 'lispa\amos\core\views\grid\CheckboxColumn',
'name' => 'amosWidgetsClassnames[]',
'checkboxOptions' => function($model, $key, $index, $column){
return [
'id' => \yii\helpers\StringHelper::basename($model['classname']),
'value' => $model['classname'],
'checked' => in_array($model['classname'], $this->params['widgetSelected'])
];
},
// you may configure additional properties here
],
]
Users may click on the checkboxes to select rows of the grid. The selected rows may be obtained by calling the following JavaScript code:
var keys = $('#grid').yiiGridView('getSelectedRows');
// keys is an array consisting of the keys associated with the selected rows
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$checkboxOptions | array|Closure | The HTML attributes for checkboxes. | yii\grid\CheckboxColumn |
$content | callable | This is a callable that will be used to generate the content of each cell. | yii\grid\Column |
$contentOptions | array|Closure | The HTML attributes for the data cell tag. | yii\grid\Column |
$cssClass | string | The css class that will be used to find the checkboxes. | yii\grid\CheckboxColumn |
$filterOptions | array | The HTML attributes for the filter cell tag. | yii\grid\Column |
$footer | string | The footer cell content. | yii\grid\Column |
$footerOptions | array | The HTML attributes for the footer cell tag. | yii\grid\Column |
$grid | yii\grid\GridView | The grid view object that owns this column. | yii\grid\Column |
$header | string | The header cell content. | yii\grid\Column |
$headerOptions | array | The HTML attributes for the header cell tag. | yii\grid\Column |
$multiple | boolean | Whether it is possible to select multiple rows. | yii\grid\CheckboxColumn |
$name | string | The name of the input checkbox input fields. | yii\grid\CheckboxColumn |
$options | array | The HTML attributes for the column group tag. | yii\grid\Column |
$visible | boolean | Whether this column is visible. | yii\grid\Column |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Object |
__construct() | Constructor. | yii\base\Object |
__get() | Returns the value of an object property. | yii\base\Object |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Object |
__set() | Sets value of an object property. | yii\base\Object |
__unset() | Sets an object property to null. | yii\base\Object |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Object |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Object |
className() | Returns the fully qualified name of this class. | yii\base\Object |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Object |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\Object |
init() | Initializes the object. | yii\grid\CheckboxColumn |
registerClientScript() | Registers the needed JavaScript | yii\grid\CheckboxColumn |
renderDataCell() | Renders a data cell. | yii\grid\Column |
renderFilterCell() | Renders the filter cell. | yii\grid\Column |
renderFooterCell() | Renders the footer cell. | yii\grid\Column |
renderHeaderCell() | Renders the header cell. | yii\grid\Column |
Protected Methods
Method | Description | Defined By |
---|---|---|
getHeaderCellLabel() | Returns header cell label. | yii\grid\Column |
getHeaderCheckBoxName() | Returns header checkbox name | yii\grid\CheckboxColumn |
renderDataCellContent() | Renders the data cell content. | lispa\amos\core\views\grid\CheckboxColumn |
renderFilterCellContent() | Renders the filter cell content. | yii\grid\Column |
renderFooterCellContent() | Renders the footer cell content. | yii\grid\Column |
renderHeaderCellContent() | Renders the header cell content. | lispa\amos\core\views\grid\CheckboxColumn |
Method Details
Renders the data cell content.
protected string renderDataCellContent ( $model, $key, $index ) | ||
$model | mixed | The data model |
$key | mixed | The key associated with the data model |
$index | integer | The zero-based index of the data model among the models array returned by \lispa\amos\core\views\grid\GridView::dataProvider. |
return | string | The rendering result |
---|
Renders the header cell content.
The default implementation simply renders $header. This method may be overridden to customize the rendering of the header cell.
protected string renderHeaderCellContent ( ) | ||
return | string | The rendering result |
---|