GridFieldFilterHeader
class GridFieldFilterHeader implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider (View source)
GridFieldFilterHeader alters the {@link GridField} with some filtering fields in the header of each column.
Methods
Determine what happens when this component is used with a list that isn't {@link SS_Filterable}.
See {@link setThrowExceptionOnBadDataType()}
No description
Handle an action on the given {@link GridField}.
No description
Details
setThrowExceptionOnBadDataType($throwExceptionOnBadDataType)
Determine what happens when this component is used with a list that isn't {@link SS_Filterable}.
- true: An exception is thrown
- false: This component will be ignored - it won't make any changes to the GridField.
By default, this is set to true so that it's clearer what's happening, but the predefined {@link GridFieldConfig} subclasses set this to false for flexibility.
getThrowExceptionOnBadDataType()
See {@link setThrowExceptionOnBadDataType()}
array
getActions($gridField)
handleAction(GridField $gridField, $actionName, $arguments, $data)
Handle an action on the given {@link GridField}.
Calls ALL components for every action handled, so the component needs to ensure it only accepts actions it is actually supposed to handle.