Dropdown

HTML utility class for building a dropdown menu

abstract
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) : 
static
since

3.0

Arguments

label

stringThe label of item

link

stringThe link of item

linkAttributes

stringCustom link attributes

className

stringClass name of item

ajaxLoad

boolTrue if using ajax load when item clicked

jsCallBackFunc

stringJavascript function name, called when ajax load successfully

Response

void

archive

Append an archive item to the current dropdown menu

archive( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

checkin

Append a checkin item to the current dropdown menu

checkin( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

divider

Writes a divider between dropdown items

divider() : 
static
since

3.0

Response

void

edit

Append an edit item to the current dropdown menu

edit( id,  prefix = '',  customLink = '') : 
static
since

3.0

Arguments

id

intRecord ID

prefix

stringTask prefix

customLink

stringThe custom link if dont use default Joomla action format

Response

void

init

Method to inject needed script

init() : 
static
since

3.0

Response

void

publish

Append a publish item to the current dropdown menu

publish( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

render

Method to render current dropdown menu

render() : 
static
since

3.0

Response

stringHTML markup for the dropdown list

start

Method to start a new dropdown menu

start() : 
static
since

3.0

Response

void

trash

Append a trash item to the current dropdown menu

trash( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

unarchive

Append an unarchive item to the current dropdown menu

unarchive( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

unfeatured

Append an unfeatured item to the current dropdown menu

unfeatured( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

unpublish

Append an unpublish item to the current dropdown menu

unpublish( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

untrash

Append an untrash item to the current dropdown menu

untrash( checkboxId,  prefix = '') : 
static
since

3.0

Arguments

checkboxId

stringID of corresponding checkbox of the record

prefix

stringThe task prefix

Response

void

Properties

loaded

Array containing information for loaded files

static
since

3.0

Type(s)

array<string|int, mixed>

dropDownList

HTML markup for the dropdown list

static
since

3.0

Type(s)

string