Joomla! API

下载
启动

FeaturedButton

扩展自 ActionButton

FeaturedButton 类。

自版本

4.0.0
包

Joomla CMS

方法

__construct

ActionButton 构造函数。

__construct(mixed||string|int options = []) :
继承
自版本

4.0.0

参数

选项

array<string|int, mixed>此组中所有按钮的选项。

返回值

混合类型

__toString

渲染为字符串。

__toString() :
继承
自版本

4.0.0

返回值

字符串

addState

添加状态配置文件。

addState( value,  task,  icon = 'ok',  title = '', mixed||string|int options = []) :
继承
自版本

4.0.0

参数

值

int此状态的值。

任务

string单击此按钮后要执行的任务。

图标

string要显示给用户的图标。

标题

string如果启用工具提示，则会显示标题文本。

选项

array<string|int, mixed>按钮选项，将覆盖组选项。

返回值

static返回自身以支持链式调用。

fetchIconClass

用于获取图标标识符的 CSS 类名称的方法。

fetchIconClass( identifier) :
继承

可以在最终类中重新定义。

自版本

4.0.0

参数

标识符

string图标标识符字符串。

返回值

stringCSS 类名称。

getLayout

用于获取属性布局的方法。

getLayout() :
继承
自版本

4.0.0

返回值

字符串

getOption

获取选项值。

getOption( name,  default = null) :
继承
自版本

4.0.0

参数

名称

string选项名称。

默认值

mixed如果不存在，则为默认值。

返回值

mixed返回选项值或默认值。

getOptions

用于获取属性选项的方法。

getOptions() : mixed||string|int
继承
自版本

4.0.0

返回值

array<string|int, mixed>

getState

根据值名称获取状态配置文件。

getState( value) : array|null
继承
自版本

4.0.0

参数

值

int我们要获取的值名称。

返回值

array<string|int, mixed>|null返回状态配置文件或 NULL。

preprocess

配置此对象。

preprocess() :
自版本

4.0.0

返回值

空

removeState

根据值名称删除状态。

removeState( value) :
继承
自版本

4.0.0

参数

值

int根据此值删除状态。

返回值

static返回以支持链式调用。

render

根据项目值渲染操作按钮。

render(int|null value = null, int|null row = null, mixed||string|int options = [], string|\Joomla\CMS\Date\Date featuredUp = null, string|\Joomla\CMS\Date\Date featuredDown = null) :
自版本

4.0.0

参数

值

int|null此项目的当前值。

行

int|null此项目的行号。

选项

array<string|int, mixed>要覆盖组选项的选项。

置顶

string|Date项目置顶的日期。

取消置顶

string|Date项目取消置顶的日期。

返回值

string渲染的 HTML。

setLayout

用于设置属性模板的方法。

setLayout( layout) :
继承
自版本

4.0.0

参数

布局

string布局路径。

返回值

static返回自身以支持链式调用。

setOption

设置选项值。

setOption( name,  value) :
继承
自版本

4.0.0

参数

名称

string选项名称。

值

mixed选项值。

返回值

static返回自身以支持链式调用。

setOptions

用于设置属性选项的方法。

setOptions(mixed||string|int options) :
继承
自版本

4.0.0

参数

选项

array<string|int, mixed>此按钮组的选项。

返回值

static返回自身以支持链式调用。

属性

状态

按钮状态配置文件。

继承
自版本

4.0.0

类型

array<string|int, mixed>

未知状态

未知状态的默认选项。

继承
自版本

4.0.0

类型

array<string|int, mixed>

选项

此按钮集的选项。

继承
自版本

4.0.0

类型

注册表

布局

要渲染的布局路径。

继承
自版本

4.0.0

类型

字符串
  • \ Joomla
  • \ CMS
  • \ Button
  • \ FeaturedButton