Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Abstract Class JButton

Description

Button base class

The JButton is the base class for all JButton types

  • abstract:
  • since: 1.5

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

Class JObject   (Subpackage Base)

Abstract class JButton   (Subpackage HTML)
Direct descendents
Class Description
ClassJButtonHelp Renders a help popup window button
ClassJButtonCustom Renders a custom button
ClassJButtonLink Renders a link button
ClassJButtonStandard Renders a standard button
ClassJButtonSeparator Renders a button separator
ClassJButtonPopup Renders a popup window button
ClassJButtonConfirm Renders a standard button with a confirm dialog
Variable Summary
Variable string $_name
Variable object $_parent
Method Summary
Constructor JButton __construct ([ $parent = null])
Abstract method void fetchButton ()
Method string fetchIconClass (string $identifier)
Method void fetchId ()
Method string getName ()
Method void render ( &$definition)
Variables
string $_name = null (line 38)

element name

This has to be set in the final renderer classes.

  • access: protected

Redefined in descendants as:
object $_parent = null (line 46)

reference to the object that instantiated the element

  • access: protected

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Constructor __construct (line 53)

Constructor

  • access: protected
JButton __construct ([ $parent = null])
  • $parent

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

Get the button

Defined in the final button class

  • abstract:
  • since: 1.5
  • access: public
void fetchButton ()

Redefined in descendants as:
fetchIconClass (line 101)

Method to get the CSS class name for an icon identifier

Can be redefined in the final class

  • return: CSS class name
  • since: 1.5
  • access: public
string fetchIconClass (string $identifier)
  • string $identifier: Icon identification string
fetchId (line 114)

Get the button id

Can be redefined in the final button class

  • since: 1.5
  • access: public
void fetchId ()

Redefined in descendants as:
getName (line 64)

get the element name

  • return: type of the parameter
  • access: public
string getName ()
render (line 69)
void render ( &$definition)
  • &$definition

Redefined in descendants as:

Inherited Methods

Inherited From JObject

 JObject::JObject()
 JObject::__construct()
 JObject::get()
 JObject::getError()
 JObject::getErrors()
 JObject::getProperties()
 JObject::getPublicProperties()
 JObject::set()
 JObject::setError()
 JObject::setProperties()
 JObject::toString()
Support Joomla!