ActionButton
TaskButton 类。
自 |
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
图标标识字符串。
响应
string
CSS 类名。
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 |
---|
响应
void
removeState
通过值名称移除状态。
removeState( value) :
自 |
4.0.0 |
---|
参数
- 值
int
通过此值移除状态。
响应
static
返回以支持链式调用。
render
通过项目值渲染操作按钮。
render(int|null value = null, int|null row = null, mixed||string|int options = []) :
自 |
4.0.0 |
---|---|
抛出 |
|
参数
- 值
int|null
此项目的当前值。- 行
int|null
此项目的行号。- 选项
array<string|int, mixed>
要覆盖组选项的选项。
响应
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>
unknownState
未知状态的默认选项。
自 |
4.0.0 |
---|
类型
array<string|int, mixed>
选项
此按钮集的选项。
自 |
4.0.0 |
---|
类型
注册表
布局
要渲染的布局路径。
自 |
4.0.0 |
---|
类型
字符串