Dropdown
HTML utility class for building a dropdown menu
since |
3.0 |
---|---|
package |
Joomla CMS |
Methods
addCustomItem
Append a custom item to current dropdown menu
addCustomItem( label, link = 'javascript:void(0)', linkAttributes = '', className = '', ajaxLoad = false, jsCallBackFunc = null) :
since |
3.0 |
---|
Arguments
- label
string
The label of item- link
string
The link of item- linkAttributes
string
Custom link attributes- className
string
Class name of item- ajaxLoad
bool
True if using ajax load when item clicked- jsCallBackFunc
string
Javascript function name, called when ajax load successfully
Response
void
archive
Append an archive item to the current dropdown menu
archive( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
checkin
Append a checkin item to the current dropdown menu
checkin( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
divider
Writes a divider between dropdown items
divider() :
since |
3.0 |
---|
Response
void
edit
Append an edit item to the current dropdown menu
edit( id, prefix = '', customLink = '') :
since |
3.0 |
---|
Arguments
- id
int
Record ID- prefix
string
Task prefix- customLink
string
The custom link if dont use default Joomla action format
Response
void
featured
Append a featured item to the current dropdown menu
featured( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
init
Method to inject needed script
init() :
since |
3.0 |
---|
Response
void
publish
Append a publish item to the current dropdown menu
publish( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
render
Method to render current dropdown menu
render() :
since |
3.0 |
---|
Response
string
HTML markup for the dropdown list
start
Method to start a new dropdown menu
start() :
since |
3.0 |
---|
Response
void
trash
Append a trash item to the current dropdown menu
trash( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
unarchive
Append an unarchive item to the current dropdown menu
unarchive( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
unfeatured
Append an unfeatured item to the current dropdown menu
unfeatured( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
unpublish
Append an unpublish item to the current dropdown menu
unpublish( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
untrash
Append an untrash item to the current dropdown menu
untrash( checkboxId, prefix = '') :
since |
3.0 |
---|
Arguments
- checkboxId
string
ID of corresponding checkbox of the record- prefix
string
The task prefix
Response
void
Properties
loaded
Array containing information for loaded files
since |
3.0 |
---|
Type(s)
array<string|int, mixed>
dropDownList
HTML markup for the dropdown list
since |
3.0 |
---|
Type(s)
string