Docs For Class JHtmlActionsDropdown

Description

HTML utility class for building a dropdown menu

abstract:
since: 3.2

Located in /libraries/cms/html/actionsdropdown.php (line 19)

Variable Summary

static string $dropDownList

Method Summary

static void addCustomItem (string $label, [string $icon = ''], [string $id = ''], [string $task = ''])

static void archive (string $id, [string $prefix = ''])

static void divider ()

static void duplicate (string $id, [string $prefix = ''])

static void feature (string $id, [string $prefix = ''])

static void publish (string $id, [string $prefix = ''])

static string render ([string $item = ''])

static void trash (string $id, [string $prefix = ''])

static void unarchive (string $id, [string $prefix = ''])

static void unfeature (string $id, [string $prefix = ''])

static void unpublish (string $id, [string $prefix = ''])

static void untrash (string $id, [string $prefix = ''])

Variables

static string $dropDownList = array() (line 25)

var: HTML markup for the dropdown list
since: 3.2
access: protected

Methods

static addCustomItem (line 225)

Append a custom item to current dropdown menu.

since: 3.2
access: public

static void addCustomItem (string $label, [string $icon = ''], [string $id = ''], [string $task = ''])

string $label: The label of the item.
string $icon: The icon classname.
string $id: The item id.
string $task: The task.

static archive (line 132)

Append an archive item to the current dropdown menu

since: 3.2
access: public

static void archive (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static divider (line 208)

Writes a divider between dropdown items

since: 3.0
access: public

static void divider ()

static duplicate (line 164)

Append a duplicate item to the current dropdown menu

since: 3.2
access: public

static void duplicate (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static feature (line 100)

Append a feature item to the current dropdown menu

since: 3.2
access: public

static void feature (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static publish (line 68)

Append a publish item to the current dropdown menu

since: 3.2
access: public

static void publish (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static render (line 36)

Method to render current dropdown menu

return: HTML markup for the dropdown list
since: 3.2
access: public

static string render ([string $item = ''])

string $item: An item to render.

static trash (line 180)

Append a trash item to the current dropdown menu

since: 3.2
access: public

static void trash (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static unarchive (line 148)

Append an unarchive item to the current dropdown menu

since: 3.2
access: public

static void unarchive (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static unfeature (line 116)

Append an unfeature item to the current dropdown menu

since: 3.2
access: public

static void unfeature (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static unpublish (line 84)

Append an unpublish item to the current dropdown menu

since: 3.2
access: public

static void unpublish (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix

static untrash (line 196)

Append an untrash item to the current dropdown menu

since: 3.2
access: public

static void untrash (string $id, [string $prefix = ''])

string $id: ID of corresponding checkbox of the record
string $prefix: The task prefix