Class JToolbarButtonStandard

Description

Renders a standard button

  • since: 3.0

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

JToolbarButton
   |
   --JToolbarButtonStandard
Variable Summary
 string $_name
Method Summary
 string fetchButton ([string $type = 'Standard'], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true])
 string fetchId ([string $type = 'Standard'], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true], [boolean $hideMenu = false])
 string _getCommand (string $name, string $task, boolean $list)
Variables
string $_name = 'Standard' (line 26)

Button type

  • access: protected

Redefinition of:
JToolbarButton::$_name
element name

Inherited Variables

Inherited from JToolbarButton

JToolbarButton::$_parent
Methods
fetchButton (line 41)

Fetch the HTML for the button

  • return: HTML string for the button
  • since: 3.0
  • access: public
string fetchButton ([string $type = 'Standard'], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true])
  • string $type: Unused string.
  • string $name: The name of the button icon class.
  • string $text: Button text.
  • string $task: Task associated with the button.
  • boolean $list: True to allow lists

Redefinition of:
JToolbarButton::fetchButton()
Get the button
fetchId (line 79)

Get the button CSS Id

  • return: Button CSS Id
  • since: 3.0
  • access: public
string fetchId ([string $type = 'Standard'], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true], [boolean $hideMenu = false])
  • string $type: Unused string.
  • string $name: Name to be used as apart of the id
  • string $text: Button text
  • string $task: The task associated with the button
  • boolean $list: True to allow use of lists
  • boolean $hideMenu: True to hide the menu on click
_getCommand (line 95)

Get the JavaScript command for the button

  • return: JavaScript command string
  • since: 3.0
  • access: protected
string _getCommand (string $name, string $task, boolean $list)
  • string $name: The task name as seen by the user
  • string $task: The task used by the application
  • boolean $list: True is requires a list confirmation.

Inherited Methods

Inherited From JToolbarButton

 JToolbarButton::__construct()
 JToolbarButton::fetchButton()
 JToolbarButton::fetchIconClass()
 JToolbarButton::getName()
 JToolbarButton::render()

Documentation generated on Tue, 19 Nov 2013 15:14:18 +0100 by phpDocumentor 1.4.3