Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Dropdown - list of methods

HTML utility class for building a dropdown menu
Package: Joomla\CMS\HTML\Helpers
Copyright: (C) 2012 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/HTML/Helpers/Dropdown.php
Project: Joomla

Method Summary

public static void
()

Method to inject needed script
Returns
  • void
Since
  • 3.0
Show source code of this method: init Source Code

public static void
()

Method to start a new dropdown menu
Returns
  • void
Since
  • 3.0
Show source code of this method: start Source Code

public static string
()

Method to render current dropdown menu
Returns
  • string HTML markup for the dropdown list
Since
  • 3.0
Show source code of this method: render Source Code

public static void
(mixed $id, mixed $prefix = '', mixed $customLink = '')

Append an edit item to the current dropdown menu
Parameters
  • int $id Record ID
  • string $prefix Task prefix
  • string $customLink The custom link if dont use default Joomla action format
Returns
  • void
Since
  • 3.0
Show source code of this method: edit Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append a publish item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: publish Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append an unpublish item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: unpublish Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append a featured item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: featured Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append an unfeatured item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: unfeatured Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append an archive item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: archive Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append an unarchive item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: unarchive Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append a trash item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: trash Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append an untrash item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: untrash Source Code

public static void
(mixed $checkboxId, mixed $prefix = '')

Append a checkin item to the current dropdown menu
Parameters
  • string $checkboxId ID of corresponding checkbox of the record
  • string $prefix The task prefix
Returns
  • void
Since
  • 3.0
Show source code of this method: checkin Source Code

public static void
()

Writes a divider between dropdown items
Returns
  • void
Since
  • 3.0
Show source code of this method: divider Source Code

public static void
(mixed $label, mixed $link = 'javascript:void(0)', mixed $linkAttributes = '', mixed $className = '', mixed $ajaxLoad = false, mixed $jsCallBackFunc = null)

Append a custom item to current dropdown menu
Parameters
  • string $label The label of item
  • string $link The link of item
  • string $linkAttributes Custom link attributes
  • string $className Class name of item
  • bool $ajaxLoad True if using ajax load when item clicked
  • string $jsCallBackFunc Javascript function name, called when ajax load successfully
Returns
  • void
Since
  • 3.0
Show source code of this method: addCustomItem Source Code

Properties Summary

protected static array
$loaded
Since
  • 3.0
protected static string
$dropDownList
Since
  • 3.0

Tags Summary

Since
3.0