Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPortletToolbar

组件工具栏接口

version

10.5.0

since

10.5.0

Hierarchy 层级

  • IPortletToolbar

Index 目录

Methods 方法

Methods 方法

addButton

  • 添加工具栏按钮

    version

    10.5.0

    since

    10.5.0

    • 示例
    toolbar.addButton({
  id: 'DEMO',
  icon: 'sx-icon-ai',
  tip: 'demo button'
}, (event) => {
  alert('click DEMO button');
}, 0);

    Parameters 参数

    • button: IPortletToolbarButton
    • handler: (event: MouseEvent) => void

      点击按钮的回调函数

        • (event: MouseEvent): void

        • Parameters 参数

          • event: MouseEvent

          Returns 返回值 void

    • Optional index: number

      按钮序号，不填默认加到末尾（序号从0开始）

    Returns 返回值 void

getButton

  • 根据id获取工具栏按钮

    version

    10.5.0

    since

    10.5.0

    • 示例
    let aiBtn: IPortletToolbarButton = toolbar.getButton(PortletToolbarIdEnum.AI);

    Parameters 参数

    Returns 返回值 IPortletToolbarButton

getButtons

  • 获取所有工具栏按钮

    version

    10.5.0

    since

    10.5.0

    • 示例
    let buttons: Array<IPortletToolbarButton> = toolbar.getButtons();

    Returns 返回值 Array<IPortletToolbarButton>

isHidden

  • isHidden(): boolean

  • 获取工具栏隐藏状态，为true则隐藏，否则显示

    version

    10.5.0

    since

    10.5.0

    • 示例
    let isHidden: boolean = toolbar.isHidden();

    Returns 返回值 boolean

    boolean 隐藏状态

removeButton

  • 移除工具栏按钮

    version

    10.5.0

    since

    10.5.0

    • 示例
    toolbar.removeButton(PortletToolbarIdEnum.MOVE);

    Parameters 参数

    Returns 返回值 void

setHidden

  • setHidden(isHidden: boolean): void

  • 设置工具栏隐藏状态，为true则隐藏，否则显示

    version

    10.5.0

    since

    10.5.0

    • 示例
    toolbar.setHidden(true);

    Parameters 参数

    • isHidden: boolean

      隐藏状态

    Returns 返回值 void