Docs For Class JToolbarButton

Description

Button base class

The JButton is the base class for all JButton types

abstract:
since: 3.0

Located in /libraries/cms/toolbar/button.php (line 21)

Direct descendents

Class	Description
JButton	Deprecated class placeholder. You should use JToolbarButton instead.
JToolbarButtonConfirm	Renders a standard button with a confirm dialog
JToolbarButtonCustom	Renders a custom button
JToolbarButtonHelp	Renders a help popup window button
JToolbarButtonLink	Renders a link button
JToolbarButtonPopup	Renders a modal window button
JToolbarButtonSeparator	Renders a button separator
JToolbarButtonSlider	Renders a button to render an HTML element in a slider container
JToolbarButtonStandard	Renders a standard button

Variable Summary

string $_name

JButton $_parent

Method Summary

JToolbarButton __construct ([object $parent = null])

string fetchButton ()

string fetchIconClass (string $identifier)

string getName ()

string render (array &$definition)

Variables

string $_name = null (line 30)

element name

This has to be set in the final renderer classes.

access: protected

Redefined in descendants as:

JToolbarButtonConfirm::$_name : Button type
JToolbarButtonCustom::$_name : Button type
JToolbarButtonHelp::$_name
JToolbarButtonLink::$_name : Button type
JToolbarButtonPopup::$_name : Button type
JToolbarButtonSeparator::$_name : Button type
JToolbarButtonSlider::$_name : Button type
JToolbarButtonStandard::$_name : Button type

JButton $_parent = null (line 37)

reference to the object that instantiated the element

access: protected

Methods

Constructor __construct (line 44)

Constructor

access: public

JToolbarButton __construct ([object $parent = null])

object $parent: The parent

Redefined in descendants as:

JButton::__construct() : Constructor

fetchButton (line 122)

Get the button

Defined in the final button class

abstract:
since: 3.0
access: public

string fetchButton ()

Redefined in descendants as:

JToolbarButtonConfirm::fetchButton() : Fetch the HTML for the button
JToolbarButtonCustom::fetchButton() : Fetch the HTML for the button
JToolbarButtonHelp::fetchButton() : Fetches the button HTML code.
JToolbarButtonLink::fetchButton() : Fetch the HTML for the button
JToolbarButtonPopup::fetchButton() : Fetch the HTML for the button
JToolbarButtonSeparator::fetchButton() : Empty implementation (not required for separator)
JToolbarButtonSlider::fetchButton() : Fetch the HTML for the button
JToolbarButtonStandard::fetchButton() : Fetch the HTML for the button

fetchIconClass (line 105)

Method to get the CSS class name for an icon identifier

Can be redefined in the final class

return: CSS class name
since: 3.0
access: public

string fetchIconClass (string $identifier)

string $identifier: Icon identification string

getName (line 56)

Get the element name

return: type of the parameter
since: 3.0
access: public

string getName ()

render (line 70)

Get the HTML to render the button

since: 3.0
access: public

string render (array &$definition)

array &$definition: Parameters to be passed

Redefined in descendants as:

JToolbarButtonSeparator::render() : Get the HTML for a separator in the toolbar