打印版式

Class Ext.Toolbar.Button

Package:Ext
Class:Toolbar.Button
Extends:Button
Defined In:Toolbar.js
A button that renders into a toolbar.

属性   -  方法   -  事件   -  设置选项

公共属性

属性 定义对象
  disabled : Boolean Button
Read-only. True if this button is disabled
  hidden : Boolean Button
Read-only. True if this button is hidden
  pressed : Boolean Button
Read-only. True if this button is pressed (only if enableToggle = true)

公共方法

方法 定义对象
  Toolbar.Button(Object config) Toolbar.Button
Creates a new Button
  addEvents(Object object) : void Observable
将对象中没有的事件从给出的对象中复制过来。
  addListener(String eventName, Function handler, [Object scope], [Object options]) : void Observable
为该组件加入事件处理器函数
  destroy() : void Toolbar.Button
Remove and destroy this button
  disable() : void Toolbar.Button
Disable this item
  enable() : void Toolbar.Button
Enable this item
  fireEvent(String eventName, Object... args) : Boolean Observable
触发指定的事件, 并将参数传入(至少要有事件名称)。
  focus() : void Button
Focus the button
  getEl() : Ext.Element Button
Returns the button's underlying element
  getText() : String Button
Gets the text for this button
  hasListener(String eventName) : Boolean Observable
检查该对象是否拥有指定事件的侦听器
  hide() : void Toolbar.Button
Hide this button
  on(String eventName, Function handler, [Object options]) : void Observable
为该组件加入事件处理器函数, addListener 的简写方式
  purgeListeners() : void Observable
从对象身上移除所有的侦听器
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器
  setDisabled(Boolean enabled) : void Button
Convenience function for boolean enable/disable
  setHandler(Function handler, [Object scope]) : void Button
Assigns this button's click handler
  setText(String text) : void Button
Sets this button's text
  setVisible(Boolean visible) : void Button
Convenience function for boolean show/hide
  show() : void Toolbar.Button
Show this button
  toggle([Boolean state]) : void Button
If a state it passed, it becomes the pressed state otherwise the current state is toggled.
  un(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器, removeListener 的简写方式

公共事件

事件 定义对象
  click : (Button this, EventObject e) Button
Fires when this button is clicked
  mouseout : (Button this, Event e) Button
Fires when the mouse exits the button
  mouseover : (Button this, Event e) Button
Fires when the mouse hovers over the button
  toggle : (Button this, Boolean pressed) Button
Fires when the "pressed" state of this button changes (only if enableToggle = true)

设置选项

设置选项 定义对象
  disabled : Boolean Button
True to start disabled (defaults to false)
  enableToggle : Boolean Button
True to enable pressed/not pressed toggling (defaults to false)
  handler : Function Button
A function called when the button is clicked (can be used instead of click event)
  hidden : Boolean Button
True to start hidden (defaults to false)
  icon : String Button
The path to an image to display in the button (the image will be set as the background-image CSS property of the butt...
  menu : Mixed Button
Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob
  menuAlign : String Button
The position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?').
  minWidth : Number Button
The minimum width for this button (used to give a set of buttons a common width)
  pressed : Boolean Button
True to start pressed (only if enableToggle = true)
  repeat : Boolean/Object Button
True to repeat fire the click event while the mouse is down. This can also be an Ext.util.ClickRepeater config object...
  scope : Object Button
The scope of the handler
  text : String Button
The button text
  toggleGroup : String Button
The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)
  tooltip : String/Object Button
The tooltip for the button - can be a string or QuickTips config object
  tooltipType : String Button
The type of tooltip to use. Either "qtip" for QuickTips or "title" for title attribute.

属性详情

disabled

public Boolean disabled
Read-only. True if this button is disabled
This property is defined by Button.

hidden

public Boolean hidden
Read-only. True if this button is hidden
This property is defined by Button.

pressed

public Boolean pressed
Read-only. True if this button is pressed (only if enableToggle = true)
This property is defined by Button.

构造函数

Toolbar.Button

public function Toolbar.Button(Object config)
Creates a new Button
参数:
  • config : Object
    A standard Ext.Button config object

方法详情

addEvents

public function addEvents(Object object)
将对象中没有的事件从给出的对象中复制过来。给出的对象必须也继承于 Observable 对象此方法才会有效果。
参数:
  • object : Object
    要复制事件的源对象
返回:
  • void
This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object scope], [Object options])
为组件添加一个事件监听器
参数:
  • eventName : String
    侦听事件的类型
  • handler : Function
    事件调用的方法
  • scope : Object
    (可选)处理函数执行的作用域。处理函数 "this" 的内容。
  • options : Object
    (可选)一个包含处理设置属性的对象。可以包含下列的属性:
    • scope {Object} 处理函数执行的作用域。处理函数 "this" 的内容。
    • delegate {String} 一个简单的选择器用来过滤目标或查找目标的子节点。
    • stopEvent {Boolean} 值为 True 时用来中止事件。那样将中止传播,并防止缺省动作。
    • preventDefault {Boolean} 值为 True 时用来防止缺省动作。
    • stopPropagation {Boolean} 值为 True 时用来中止事件传播。
    • normalized {Boolean} 值为 False 时向处理函数传递浏览器事件用以代替 Ext.EventObject 对象。
    • delay {Number} 当事件触发后启用处理函数的延迟微秒数。
    • single {Boolean} 值为 True 时将添加一个处理函数用来处理下个触发的事件,并在处理完后移除。
    • buffer {Number} 使处理函数计划在由 Ext.util.DelayedTask 指定的微秒数后执行。如果事件在延迟期间再次触发,原来的处理函数将不再启动,而是由新的计划代替。

    组合选项
    使用选项参数可以组合不同类型的监听器:

    下面是一个标准的、延迟执行的、一次性的监听器,将会自动停止事件并传递一个自定义的参数(forumId)

    代码:
    el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });

    这个方法也允许传递的单个参数是一个包含多个指定处理函数的设置对象。

    一次调用多个处理函数
    代码:

    el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });

    或者简写为:
    代码:

    el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
返回:
  • void
This method is defined by Observable.

destroy

public function destroy()
Remove and destroy this button
参数:
  • 无。
返回:
  • void
This method is defined by Toolbar.Button.

disable

public function disable()
Disable this item
参数:
  • 无。
返回:
  • void
This method is defined by Toolbar.Button.

enable

public function enable()
Enable this item
参数:
  • 无。
返回:
  • void
This method is defined by Toolbar.Button.

fireEvent

public function fireEvent(String eventName, Object... args)
触发指定的事件并给出参数(至少要有事件名称)。
参数:
  • eventName : String
  • args : Object...
    传入处理函数的参数
返回:
  • Boolean
    如果任何处理函数返回 false 则返回值为 false, 否则返回 true。
This method is defined by Observable.

focus

public function focus()
Focus the button
参数:
  • 无。
返回:
  • void
This method is defined by Button.

getEl

public function getEl()
Returns the button's underlying element
参数:
  • 无。
返回:
  • Ext.Element
    The element
This method is defined by Button.

getText

public function getText()
Gets the text for this button
参数:
  • 无。
返回:
  • String
    The button text
This method is defined by Button.

hasListener

public function hasListener(String eventName)
检查该对象是否拥有指定事件的侦听器
参数:
  • eventName : String
    查询事件之名称
返回:
  • Boolean
    值为 True 值表示事件监听器存在, 否则值为 false。
This method is defined by Observable.

hide

public function hide()
Hide this button
参数:
  • 无。
返回:
  • void
This method is defined by Toolbar.Button.

on

public function on(String eventName, Function handler, [Object options])
为该组件加入事件处理器函数, addListener 的简写方式
参数:
  • eventName : String
    侦听事件的类型
  • handler : Function
    事件调用的方法
  • options : Object
    (可选)
返回:
  • void
This method is defined by Observable.

purgeListeners

public function purgeListeners()
从对象身上移除所有的侦听器
参数:
  • 无。
返回:
  • void
This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])
移除侦听器
参数:
  • eventName : String
    侦听事件的类型
  • handler : Function
    删除的处理函数
  • scope : Object
    (可选) The scope (this object) for the handler
返回:
  • void
This method is defined by Observable.

setDisabled

public function setDisabled(Boolean enabled)
Convenience function for boolean enable/disable
参数:
  • enabled : Boolean
    True to enable, false to disable
返回:
  • void
This method is defined by Button.

setHandler

public function setHandler(Function handler, [Object scope])
Assigns this button's click handler
参数:
  • handler : Function
    The function to call when the button is clicked
  • scope : Object
    (可选) Scope for the function passed in
返回:
  • void
This method is defined by Button.

setText

public function setText(String text)
Sets this button's text
参数:
  • text : String
    The button text
返回:
  • void
This method is defined by Button.

setVisible

public function setVisible(Boolean visible)
Convenience function for boolean show/hide
参数:
  • visible : Boolean
    True to show, false to hide
返回:
  • void
This method is defined by Button.

show

public function show()
Show this button
参数:
  • 无。
返回:
  • void
This method is defined by Toolbar.Button.

toggle

public function toggle([Boolean state])
If a state it passed, it becomes the pressed state otherwise the current state is toggled.
参数:
  • state : Boolean
    (可选) Force a particular state
返回:
  • void
This method is defined by Button.

un

public function un(String eventName, Function handler, [Object scope])
移除侦听器, removeListener 的简写方式
参数:
  • eventName : String
    侦听事件的类型
  • handler : Function
    删除的处理函数
  • scope : Object
    (可选) The scope (this object) for the handler
返回:
  • void
This method is defined by Observable.

事件详情

click

public event click
Fires when this button is clicked
Subscribers will be called with the following parameters:
  • this : Button
  • e : EventObject
    The click event
This event is defined by Button.

mouseout

public event mouseout
Fires when the mouse exits the button
Subscribers will be called with the following parameters:
  • this : Button
  • e : Event
    The event object
This event is defined by Button.

mouseover

public event mouseover
Fires when the mouse hovers over the button
Subscribers will be called with the following parameters:
  • this : Button
  • e : Event
    The event object
This event is defined by Button.

toggle

public event toggle
Fires when the "pressed" state of this button changes (only if enableToggle = true)
Subscribers will be called with the following parameters:
  • this : Button
  • pressed : Boolean
This event is defined by Button.

设置详情

disabled

disabled : Boolean
True to start disabled (defaults to false)
This config option is defined by Button.

enableToggle

enableToggle : Boolean
True to enable pressed/not pressed toggling (defaults to false)
This config option is defined by Button.

handler

handler : Function
A function called when the button is clicked (can be used instead of click event)
This config option is defined by Button.

hidden

hidden : Boolean
True to start hidden (defaults to false)
This config option is defined by Button.

icon

icon : String
The path to an image to display in the button (the image will be set as the background-image CSS property of the button by default, so if you want a mixed icon/text button, set cls:"x-btn-text-icon")
This config option is defined by Button.

menu

menu : Mixed
Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob
This config option is defined by Button.

menuAlign

menuAlign : String
The position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?').
This config option is defined by Button.

minWidth

minWidth : Number
The minimum width for this button (used to give a set of buttons a common width)
This config option is defined by Button.

pressed

pressed : Boolean
True to start pressed (only if enableToggle = true)
This config option is defined by Button.

repeat

repeat : Boolean/Object
True to repeat fire the click event while the mouse is down. This can also be an Ext.util.ClickRepeater config object (defaults to false).
This config option is defined by Button.

scope

scope : Object
The scope of the handler
This config option is defined by Button.

text

text : String
The button text
This config option is defined by Button.

toggleGroup

toggleGroup : String
The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)
This config option is defined by Button.

tooltip

tooltip : String/Object
The tooltip for the button - can be a string or QuickTips config object
This config option is defined by Button.

tooltipType

tooltipType : String
The type of tooltip to use. Either "qtip" for QuickTips or "title" for title attribute.
This config option is defined by Button.

Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.