JHtmlDropdown
HTML utility class for building a dropdown menu
| since |
3.0 |
|---|---|
| package |
Joomla.Libraries |
Methods
addCustomItem
Append a custom item to current dropdown menu
addCustomItem(string $label, string $link = 'javascript:void(0)', string $linkAttributes = '', string $className = '', boolean $ajaxLoad = false, string $jsCallBackFunc = null) : void
| since |
3.0 |
|---|
Arguments
- $label
stringThe label of item- $link
stringThe link of item- $linkAttributes
stringCustom link attributes- $className
stringClass name of item- $ajaxLoad
booleanTrue if using ajax load when item clicked- $jsCallBackFunc
stringJavascript function name, called when ajax load successfully
archive
Append an archive item to the current dropdown menu
archive(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
checkin
Append a checkin item to the current dropdown menu
checkin(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
divider
Writes a divider between dropdown items
divider() : void
| since |
3.0 |
|---|
edit
Append an edit item to the current dropdown menu
edit(integer $id, string $prefix = '', string $customLink = '') : void
| since |
3.0 |
|---|
Arguments
- $id
integerRecord ID- $prefix
stringTask prefix- $customLink
stringThe custom link if dont use default Joomla action format
featured
Append a featured item to the current dropdown menu
featured(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
init
Method to inject needed script
init() : void
| since |
3.0 |
|---|
publish
Append a publish item to the current dropdown menu
publish(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
render
Method to render current dropdown menu
render() : string
| since |
3.0 |
|---|
Response
stringHTML markup for the dropdown list
start
Method to start a new dropdown menu
start() : void
| since |
3.0 |
|---|
trash
Append a trash item to the current dropdown menu
trash(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
unarchive
Append an unarchive item to the current dropdown menu
unarchive(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
unfeatured
Append an unfeatured item to the current dropdown menu
unfeatured(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
unpublish
Append an unpublish item to the current dropdown menu
unpublish(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
untrash
Append an untrash item to the current dropdown menu
untrash(string $checkboxId, string $prefix = '') : void
| since |
3.0 |
|---|
Arguments
- $checkboxId
stringID of corresponding checkbox of the record- $prefix
stringThe task prefix
Properties
loaded
Array containing information for loaded files
| since |
3.0 |
|---|
Type(s)
array
dropDownList
HTML markup for the dropdown list
| since |
3.0 |
|---|
Type(s)
string