Docs For Class JToolbarButtonPopup

Description

Renders a modal window button

since: 3.0

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

JToolbarButton
   |
   --JToolbarButtonPopup

Variable Summary

string $_name

Method Summary

string fetchButton ([string $type = 'Modal'], [string $name = ''], [string $text = ''], [string $url = ''], [integer $width = 640], [integer $height = 480], [integer $top = 0], [integer $left = 0], [string $onClose = ''], [string $title = ''])

string fetchId (string $type, string $name)

Variables

string $_name = 'Popup' (line 26)

Button type

access: protected

Redefinition of:

JToolbarButton::$_name: element name

Inherited Variables

Inherited from JToolbarButton

JToolbarButton::$_parent

Methods

fetchButton (line 46)

Fetch the HTML for the button

return: HTML string for the button
since: 3.0
access: public

string fetchButton ([string $type = 'Modal'], [string $name = ''], [string $text = ''], [string $url = ''], [integer $width = 640], [integer $height = 480], [integer $top = 0], [integer $left = 0], [string $onClose = ''], [string $title = ''])

string $type: Unused string, formerly button type.
string $name: Modal name, used to generate element ID
string $text: The link text
string $url: URL for popup
integer $width: Width of popup
integer $height: Height of popup
integer $top: Top attribute. [@deprecated Unused, will be removed in 4.0]
integer $left: Left attribute. [@deprecated Unused, will be removed in 4.0]
string $onClose: JavaScript for the onClose event.
string $title: The title text

Redefinition of:

JToolbarButton::fetchButton(): Get the button

fetchId (line 103)

Get the button id

return: Button CSS Id
since: 3.0
access: public

string fetchId (string $type, string $name)

string $type: Button type
string $name: Button name

Inherited Methods

Inherited From JToolbarButton

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