Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class PopupButton - list of methods

Renders a modal window button

Extends

ToolbarButton
Package: Joomla\CMS\Toolbar\Button
Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Toolbar/Button/PopupButton.php
Project: Joomla

Method Summary

protected void
(array &$options)

Prepare options for this button.
Parameters
  • array $options The options about this button.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: prepareOptions Source Code

public string
(mixed $type = 'Modal', mixed $name = '', mixed $text = '', mixed $url = '', mixed $iframeWidth = 640, mixed $iframeHeight = 480, mixed $bodyHeight = null, mixed $modalWidth = null, mixed $onClose = '', mixed $title = '', mixed $footer = null)

Fetch the HTML for the button
Parameters
  • 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
  • int $iframeWidth Width of popup
  • int $iframeHeight Height of popup
  • int $bodyHeight Optional height of the modal body in viewport units (vh)
  • int $modalWidth Optional width of the modal in viewport units (vh)
  • string $onClose JavaScript for the onClose event.
  • string $title The title text
  • string $footer The footer html
Returns
  • string HTML string for the button
Since
  • 3.0
Show source code of this method: fetchButton Source Code

protected string
(array &$options)

Render button HTML.
Parameters
  • array $options The button options.
Returns
  • string The button HTML.
Since
  • 4.0.0
Show source code of this method: renderButton Source Code

private string
_getCommand
(mixed $url)

Get the JavaScript command for the button
Parameters
  • string $url URL for popup
Returns
  • string JavaScript command string
Since
  • 3.0
Show source code of this method: _getCommand Source Code

protected static array
()

Method to configure available option accessors.
Returns
  • array
Since
  • 4.0.0
Show source code of this method: getAccessors Source Code

Properties Summary

protected string
$layout
Property layout.
Since
  • 4.0.0

Tags Summary

public self
url (string $value)
public self
icon (string $value)
public self
iframeWidth (int $value)
public self
iframeHeight (int $value)
public self
bodyHeight (int $value)
public self
modalWidth (int $value)
public self
onclose (string $value)
public self
title (string $value)
public self
footer (string $value)
public self
selector (string $value)
public self
listCheck (bool $value)
public string
getUrl ()
public int
getIframeWidth ()
public int
getIframeHeight ()
public int
getBodyHeight ()
public int
getModalWidth ()
public string
getOnclose ()
public string
getTitle ()
public string
getFooter ()
public string
getSelector ()
public bool
getListCheck ()
Since
3.0