\GridFieldTogglePaginator
A GridField component that allows to temporary disable the pagination.
It should be included before the GridFieldPaginator component that
must be present (otherwise this class would be pretty useless).
Synopsis
class GridFieldTogglePaginator
implements
GridField_HTMLProvider,GridField_ActionProvider,GridField_DataManipulator
{
- // members
- private static $enable_icon;
- private static $disable_icon;
- protected $target;
- protected $state_id;
- protected $state;
- // methods
- public void __construct()
- protected void updateState()
- public array getHTMLFragments()
- public array getActions()
- public void handleAction()
- public SS_List getManipulatedData()
Hierarchy
Implements
- GridField_HTMLProvider
- GridField_ActionProvider
- GridField_DataManipulator
Members
private
-
$disable_icon
The icon to use on the disable pagination button. Can be null. -
$enable_icon
The icon to use on the enable pagination button. Can be null.
protected
-
$state
Session data (an associative array). -
$state_id
ID of the session data. -
$target
Fragment to write the button to.
Methods
protected
- updateState() — Update $state and $state_id properties.
public
- __construct()
- getActions() — Required by the GridField_ActionProvider interface.
- getHTMLFragments() — Implements the GridField_HTMLProvider interface.
- getManipulatedData() — Required by the GridField_DataManipulator interface.
- handleAction() — Handle the action.