LeKoala\PureModal\PureModalAction
Custom modal action Requires cms-actions to work out of the box
Synopsis
class PureModalAction
extends DatalessField
{
- // members
- protected FieldList $fieldList;
- protected $dialogButtonTitle;
- protected boolean $showDialogButton = true;
- protected $buttonIcon;
- protected boolean $shouldRefresh = false;
- protected bool $dropUp = false;
- // methods
- public void __construct()
- protected string getButtonTitle()
- protected string getDialogButtonTitle()
- public PureModalAction setDialogButtonTitle()
- public string getButtonIcon()
- public $this setButtonIcon()
- protected boolean getShowDialogButton()
- public PureModalAction setShowDialogButton()
- public FieldList getFieldList()
- public $this setFieldList()
- public bool getDropUp()
- public $this setDropUp()
- public string actionName()
- public mixed getShouldRefresh()
- public $this setShouldRefresh()
- public void getModalID()
- public void getTitle()
Hierarchy
Extends
- SilverStripe\Forms\DatalessField
Members
protected
- $dialogButtonTitle
—
string
A custom title for the dialog button - $dropUp
—
LeKoala\PureModal\bool
Whether to place the button in a dot-menu. - $fieldList — SilverStripe\Forms\FieldList
- $shouldRefresh — boolean
- $showDialogButton
—
boolean
Should it show the dialog button
Methods
protected
- getButtonTitle() — Get the title with icon if set
- getDialogButtonTitle() — Get the dialog button title with icon if set
- getShowDialogButton() — Get whether it must display the dialog button
public
- __construct()
- actionName() — Required for cms-actions
- getButtonIcon() — Get an icon for this button
- getDropUp() — Get the dropUp value Called by ActionsGridFieldItemRequest to determine placement
- getFieldList() — Get the value of fieldList
- getModalID()
- getShouldRefresh() — Get the value of shouldRefresh
- getTitle()
- setButtonIcon() — Set an icon for this button
- setDialogButtonTitle() — Set dialog button customised button title
- setDropUp() — Set the value of dropUp
- setFieldList() — Set the value of fieldList
- setShouldRefresh() — Set the value of shouldRefresh
- setShowDialogButton() — Set whether it must display the dialog button