Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. 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

  • since: 1.5
  • author: Louis Landry <louis.landry@joomla.org
  • abstract:

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

Class JObject   (Subpackage Base)

Abstract class JButton   (Subpackage HTML)
Direct descendents
Class Description
ClassJButtonConfirm Renders a standard button with a confirm dialog
ClassJButtonCustom Renders a custom button
ClassJButtonHelp Renders a help popup window button
ClassJButtonLink Renders a link button
ClassJButtonPopup Renders a popup window button
ClassJButtonSeparator Renders a button separator
ClassJButtonStandard Renders a standard button
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 39)

element name

This has to be set in the final renderer classes.

  • access: protected

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

reference to the object that instantiated the element

  • access: protected

Inherited Variables

Inherited from JObject

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

Constructor

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

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

Get the button

Defined in the final button class

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

Redefined in descendants as:
fetchIconClass (line 102)

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 115)

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 65)

get the element name

  • return: type of the parameter
  • access: public
string getName ()
render (line 70)
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()

Documentation generated on Tue, 29 Jan 2008 18:44:45 +0000 by phpDocumentor 1.3.1