\GridFieldCheckboxSelectComponent
Gives each row a checkbox which can be paired with various children of GridFieldApplyToMultipleRows subclasses to delete or perform other actions on many records at once.
- Author: Mark Guinn <mark@adaircreative.com>
Synopsis
class GridFieldCheckboxSelectComponent
implements
GridField_ColumnProvider
{
- // constants
- const CHECKBOX_COLUMN = 'SelectCheckbox';
- // members
- private static bool $prepend_column = false;
- // methods
- public void __construct()
- public void augmentColumns()
- public array getColumnsHandled()
- public string getColumnContent()
- public array getColumnMetadata()
- public array getColumnAttributes()
Hierarchy
Implements
- GridField_ColumnProvider
Constants
Name | Value |
---|---|
CHECKBOX_COLUMN | 'SelectCheckbox' |
Members
private
- $prepend_column
—
bool
Config flag to determine whether checkbox column should be prepended or appended to the table.
Methods
public
- __construct() — Adds some javascript
- augmentColumns() — Modify the list of columns displayed in the table.
- getColumnAttributes() — Attributes for the element containing the content returned by {@link getColumnContent()}.
- getColumnContent() — HTML for the column, content of the <td> element.
- getColumnMetadata() — Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.
- getColumnsHandled() — Names of all columns which are affected by this component.