class GridFieldToolbarHeader implements GridField_HTMLProvider (View source)

Adding this class to a GridFieldConfig} of a {@link GridField adds a header title to that field.

The header serves to display the name of the data the GridField is showing.

Methods

public
array
getHTMLFragments($gridField)

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

Details

array getHTMLFragments($gridField)

Returns a map where the keys are fragment names and the values are pieces of HTML to add to these fragments.

Here are 4 built-in fragments: 'header', 'footer', 'before', and 'after', but components may also specify fragments of their own.

To specify a new fragment, specify a new fragment by including the text "$DefineFragment(fragmentname)" in the HTML that you return.

Fragment names should only contain alphanumerics, -, and _.

If you attempt to return HTML for a fragment that doesn't exist, an exception will be thrown when the GridField is rendered.

Parameters

$gridField

Return Value

array