Joomla! API

下载
启动

ToolbarHelper

按钮栏的实用程序类。

抽象
自版本

1.5
包

Joomla CMS

方法

addNew

为按钮栏编写通用的“新建”图标。

addNew( task = 'add',  alt = 'JTOOLBAR_NEW',  check = false) :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

check

bool如果需要检查标准列表项是否已选中，则为 true。

返回值

void

apply

为给定选项编写保存按钮。

apply( task = 'apply',  alt = 'JTOOLBAR_APPLY') :
静态

应用操作仅导致保存操作（不会退出编辑模式）。

自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

archiveList

为记录列表编写通用的“归档”按钮。

archiveList( task = 'archive',  alt = 'JTOOLBAR_ARCHIVE') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

assign

为记录编写通用的“分配”按钮。

assign( task = 'assign',  alt = 'JTOOLBAR_ASSIGN') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

back

编写一个取消按钮，该按钮将返回到上一页，而无需执行任何其他操作。

back( alt = 'JTOOLBAR_BACK',  href = 'javascript:history.back();') :
静态
自版本

1.5

参数

alt

string替代文本。

href

stringhref 属性的 URL。

返回值

void

cancel

编写取消按钮并调用取消操作（例如签入）。

cancel( task = 'cancel',  alt = 'JTOOLBAR_CANCEL') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

checkin

为给定选项编写签入按钮。

checkin( task = 'checkin',  alt = 'JTOOLBAR_CHECKIN',  check = true) :
静态
自版本

1.7

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

check

bool如果需要检查标准列表项是否已选中，则为 true。

返回值

void

custom

为按钮栏编写自定义选项和任务按钮。

custom( task = '',  icon = '',  iconOver = '',  alt = '',  listSelect = true,  formId = null) :
静态
自版本

1.5

参数

task

string要执行的任务（由 switch($task) 块获取）。

icon

string要显示的图像。

iconOver

string@deprecated 4.3 将在 6.0 中移除

alt

string图标图像的替代文本。

listSelect

bool如果需要检查标准列表项是否已选中，则为 true。

formId

string操作表单的 ID。

返回值

void

deleteList

为记录列表编写通用的“删除”按钮。

deleteList( msg = '',  task = 'remove',  alt = 'JTOOLBAR_DELETE') :
静态
自版本

1.5

参数

msg

string“确定”消息的后缀。

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

divider

在菜单按钮之间编写分隔符

divider() :
静态
自版本

1.5

返回值

void

editCss

为模板 css 编写通用的“编辑”按钮。

editCss( task = 'edit_css',  alt = 'JTOOLBAR_EDIT_CSS') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

editHtml

为模板 html 编写通用的“编辑”按钮。

editHtml( task = 'edit_source',  alt = 'JTOOLBAR_EDIT_HTML') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

editList

为记录列表编写通用的“编辑”按钮。

editList( task = 'edit',  alt = 'JTOOLBAR_EDIT') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

help

为给定选项编写帮助按钮（打开一个弹出窗口）。

help( ref,  com = false,  override = null,  component = null) :
静态
自版本

1.5

参数

ref

string弹出文件的名称（不包括 xml 文件的文件扩展名）。

com

bool使用组件目录中的帮助文件。

override

string使用此 URL 而不是任何其他 URL

component

string获取帮助的组件名称（当前组件为 null）

返回值

void

inlinehelp

编写一个帮助按钮，用于显示/隐藏表单的内联帮助

inlinehelp( class = "hide-aware-inline-help") :
静态
自版本

4.1.0

参数

class

string内联帮助项使用的类。

返回值

void

jooa11y

为给定选项编写 jooa11y 可访问性检查器按钮（打开一个弹出窗口）。

jooa11y( url = '',  updateEditors = false,  icon = 'icon-universal-access',  bodyHeight = null,  modalWidth = null) :
静态
自版本

4.1.0

参数

url

string要打开的 url

updateEditors

bool未使用

icon

string要显示的图像。

bodyHeight

int预览弹出窗口的主体高度

modalWidth

int预览弹出窗口的模态宽度

返回值

void

link

创建一个按钮以重定向到链接

link( url,  text,  name = 'link') :
静态
自版本

3.5

参数

url

string链接 url

text

string按钮文本

name

string用作 ID 部分的名称

返回值

void

makeDefault

为记录编写通用的“默认”按钮。

makeDefault( task = 'default',  alt = 'JTOOLBAR_DEFAULT') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

media_manager

编写一个 media_manager 按钮。

media_manager( directory = '',  alt = 'JTOOLBAR_UPLOAD') :
静态
自版本

1.5

参数

directory

string将媒体上传到的子目录。

alt

string替代文本的覆盖。

返回值

void

modal

显示模态按钮

modal( targetModalId,  icon,  alt,  class = 'btn-primary') :
静态
自版本

3.2

参数

targetModalId

string目标模态框的 ID

icon

string在模态按钮上显示的图标类

alt

string模态按钮的标题

class

string按钮类

返回值

void

preferences

编写配置按钮并调用取消操作（例如签入）。

preferences( component,  height = 550,  width = 875,  alt = 'JTOOLBAR_OPTIONS',  path = '') :
静态
自版本

1.5

参数

component

string组件的名称，例如 com_content。

height

int弹出窗口的高度。[未使用]

width

int弹出窗口的宽度。[未使用]

alt

string按钮的名称。

path

string相对于 JPATH_SITE 的配置 xml 的替代路径。

返回值

void

preview

为给定选项编写预览按钮（打开一个弹出窗口）。

preview( url = '',  updateEditors = false,  icon = 'preview',  bodyHeight = null,  modalWidth = null) :
静态
自版本

1.5

参数

url

string弹出文件的名称（不包括文件扩展名）

updateEditors

bool未使用

icon

string要显示的图像。

bodyHeight

int预览弹出窗口的主体高度

modalWidth

int预览弹出窗口的模态宽度

返回值

void

publish

编写通用的“发布”按钮。

publish( task = 'publish',  alt = 'JTOOLBAR_PUBLISH',  check = false) :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

check

bool如果需要检查标准列表项是否已选中，则为 true。

返回值

void

publishList

为记录列表编写通用的“发布”按钮。

publishList( task = 'publish',  alt = 'JTOOLBAR_PUBLISH') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

save

为给定选项编写保存按钮。

save( task = 'save',  alt = 'JTOOLBAR_SAVE') :
静态

保存操作导致保存然后关闭操作。

自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

save2copy

为给定选项编写保存为副本按钮。

save2copy( task = 'save2copy',  alt = 'JTOOLBAR_SAVE_AS_COPY') :
静态

保存为副本操作导致清除密钥后保存，然后将用户返回到具有新密钥的编辑模式。

自版本

1.6

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

save2new

为给定选项编写保存并创建新按钮。

save2new( task = 'save2new',  alt = 'JTOOLBAR_SAVE_AND_NEW') :
静态

保存并创建操作导致保存然后添加操作。

自版本

1.6

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

saveGroup

为给定选项编写保存按钮，并带有一个额外的下拉列表

saveGroup(mixed||string|int buttons = [],  class = 'btn-success') :
静态
自版本

4.0.0

参数

buttons

array<string|int, mixed>按钮数组

class

string按钮类

返回值

void

spacer

编写间隔单元格。

spacer( width = '') :
静态
自版本

1.5

参数

width

string单元格的宽度

返回值

void

title

标题单元格。

title( title,  icon = 'generic.png') :
静态

为了使标题和工具栏正确呈现，必须在 starttable 函数和工具栏图标之前调用此标题函数，这是由于 css 如何用于相对于工具栏定位标题的性质造成的。

自版本

1.5

参数

title

string标题。

icon

string图像的空格分隔名称。

返回值

void

trash

为记录列表编写通用的“垃圾箱”按钮。

trash( task = 'remove',  alt = 'JTOOLBAR_TRASH',  check = true) :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

check

bool允许列表为 true。

返回值

void

unarchiveList

为记录列表编写取消归档按钮。

unarchiveList( task = 'unarchive',  alt = 'JTOOLBAR_UNARCHIVE') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

unpublish

编写通用的“取消发布”按钮。

unpublish( task = 'unpublish',  alt = 'JTOOLBAR_UNPUBLISH',  check = false) :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

check

bool如果需要检查标准列表项是否已选中，则为 true。

返回值

void

unpublishList

为记录列表编写通用的“取消发布”按钮。

unpublishList( task = 'unpublish',  alt = 'JTOOLBAR_UNPUBLISH') :
静态
自版本

1.5

参数

task

string任务的覆盖。

alt

string替代文本的覆盖。

返回值

void

versions

编写版本历史记录

versions( typeAlias,  itemId,  height = 800,  width = 500,  alt = 'JTOOLBAR_VERSIONS') :
静态
自版本

3.2

参数

typeAlias

string组件和类型，例如“com_content.article”

itemId

int项目的 ID，例如文章 ID。

height

int弹出窗口的高度。

width

int弹出窗口的宽度。

alt

string按钮的名称。

返回值

void

  • \ Joomla
  • \ CMS
  • \ Toolbar
  • \ ToolbarHelper