JHtmlDropdown

class JHtmlDropdown

HTML utility class for building a dropdown menu

Methods

static  void
init()

Method to inject needed script

static  void
start()

Method to start a new dropdown menu

static  string
render()

Method to render current dropdown menu

static  void
edit( integer $id, string $prefix = '', string $customLink = '')

Append an edit item to the current dropdown menu

static  void
publish( string $checkboxId, string $prefix = '')

Append a publish item to the current dropdown menu

static  void
unpublish( string $checkboxId, string $prefix = '')

Append an unpublish item to the current dropdown menu

static  void
featured( string $checkboxId, string $prefix = '')

Append a featured item to the current dropdown menu

static  void
unfeatured( string $checkboxId, string $prefix = '')

Append an unfeatured item to the current dropdown menu

static  void
archive( string $checkboxId, string $prefix = '')

Append an archive item to the current dropdown menu

static  void
unarchive( string $checkboxId, string $prefix = '')

Append an unarchive item to the current dropdown menu

static  void
trash( string $checkboxId, string $prefix = '')

Append a trash item to the current dropdown menu

static  void
untrash( string $checkboxId, string $prefix = '')

Append an untrash item to the current dropdown menu

static  void
checkin( string $checkboxId, string $prefix = '')

Append a checkin item to the current dropdown menu

static  void
divider()

Writes a divider between dropdown items

static  void
addCustomItem( string $label, string $link = 'javascript:void(0)', string $linkAttributes = '', string $className = '', boolean $ajaxLoad = false, string $jsCallBackFunc = null)

Append a custom item to current dropdown menu

Details

static void init()

Method to inject needed script

Return Value

void

static void start()

Method to start a new dropdown menu

Return Value

void

static string render()

Method to render current dropdown menu

Return Value

string HTML markup for the dropdown list

static void edit( integer $id, string $prefix = '', string $customLink = '')

Append an edit item to the current dropdown menu

Parameters

integer $id Record ID
string $prefix Task prefix
string $customLink The custom link if dont use default Joomla action format

Return Value

void

static void publish( string $checkboxId, string $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

Return Value

void

static void unpublish( string $checkboxId, string $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

Return Value

void

Append a featured item to the current dropdown menu

Parameters

string $checkboxId ID of corresponding checkbox of the record
string $prefix The task prefix

Return Value

void

static void unfeatured( string $checkboxId, string $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

Return Value

void

static void archive( string $checkboxId, string $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

Return Value

void

static void unarchive( string $checkboxId, string $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

Return Value

void

static void trash( string $checkboxId, string $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

Return Value

void

static void untrash( string $checkboxId, string $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

Return Value

void

static void checkin( string $checkboxId, string $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

Return Value

void

static void divider()

Writes a divider between dropdown items

Return Value

void

static void addCustomItem( string $label, string $link = 'javascript:void(0)', string $linkAttributes = '', string $className = '', boolean $ajaxLoad = false, string $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
boolean $ajaxLoad True if using ajax load when item clicked
string $jsCallBackFunc Javascript function name, called when ajax load successfully

Return Value

void