Class JButton

Description

Button base class

The JButton is the base class for all JButton types

  • abstract:
  • since: 11.1

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

JObject
   |
   --JButton
Direct descendents
Class Description
JButtonLink Renders a link button
JButtonPopup Renders a popup window button
JButtonStandard Renders a standard button
JButtonCustom Renders a custom button
JButtonHelp Renders a help popup window button
JButtonConfirm Renders a standard button with a confirm dialog
JButtonSeparator Renders a button separator
Variable Summary
Method Summary
JButton __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:
JButton $_parent = null (line 37)

reference to the object that instantiated the element

  • access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 44)

Constructor

  • access: public
JButton __construct ([object $parent = null])
  • object $parent: The parent

Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
fetchButton (line 114)

Get the button

Defined in the final button class

  • abstract:
  • since: 11.1
  • access: public
string fetchButton ()

Redefined in descendants as:
fetchIconClass (line 100)

Method to get the CSS class name for an icon identifier

Can be redefined in the final class

  • return: CSS class name
  • since: 11.1
  • access: public
string fetchIconClass (string $identifier)
  • string $identifier: Icon identification string
getName (line 54)

Get the element name

  • return: type of the parameter
  • access: public
string getName ()
render (line 66)

Get the HTML to render the button

  • access: public
string render (array &$definition)
  • array &$definition: Parameters to be passed

Redefined in descendants as:

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:52:39 -0500 by phpDocumentor 1.4.4