ConfirmButton
Extends \Joomla\CMS\Toolbar\ToolbarButtonRenders a standard button with a confirm dialog
The JButton is the base class for all JButton types
| since |
3.0 |
|---|
Methods
__construct
Constructor
__construct(object $parent = null)
Arguments
- $parent
objectThe parent
_getCommand
Get the JavaScript command for the button
_getCommand(object $msg, string $name, string $task, boolean $list) : string
| since |
3.0 |
|---|
Arguments
- $msg
objectThe message to display.- $name
stringNot used.- $task
stringThe task used by the application- $list
booleanTrue is requires a list confirmation.
Response
stringJavaScript command string
fetchButton
Get the button
fetchButton() : string
Defined in the final button class
| since |
3.0 |
|---|
Response
string
fetchIconClass
Method to get the CSS class name for an icon identifier
fetchIconClass(string $identifier) : string
Can be redefined in the final class
| since |
3.0 |
|---|
Arguments
- $identifier
stringIcon identification string
Response
stringCSS class name
fetchId
Get the button CSS Id
fetchId(string $type = 'Confirm', string $msg = '', string $name = '', string $text = '', string $task = '', boolean $list = true, boolean $hideMenu = false) : string
| since |
3.0 |
|---|
Arguments
- $type
stringButton type- $msg
stringMessage to display- $name
stringName to be used as apart of the id- $text
stringButton text- $task
stringThe task associated with the button- $list
booleanTrue to allow use of lists- $hideMenu
booleanTrue to hide the menu on click
Response
stringButton CSS Id
getName
Get the element name
getName() : string
| since |
3.0 |
|---|
Response
stringtype of the parameter
render
Get the HTML to render the button
render( &$definition) : string
| since |
3.0 |
|---|
Arguments
- $definition
Response
string
Properties
_name
element name
This has to be set in the final renderer classes.
Type(s)
string
_parent
reference to the object that instantiated the element
Type(s)
\JButton