打印版式

Class Ext.menu.Adapter

Package:Ext.menu
Class:Adapter
Extends:BaseItem
Subclasses:ColorItem, DateItem
Defined In:Adapter.js
A base utility class that adapts a non-menu component so that it can be wrapped by a menu item and added to a menu. It provides basic rendering, activation management and enable/disable logic required to work in menus.

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

公共属性

属性 定义对象
  disabled : Object Component
true if this component is disabled. Read-only.
  disabledClass : Object Component
CSS class added to the component when it is disabled.
  hidden : Object Component
true if this component is hidden. Read-only.
  rendered : Object Component
true if this component has been rendered. Read-only.

公共方法

方法 定义对象
  Adapter(Object config) Adapter
Creates a new Adapter
  addEvents(Object object) : void Observable
将对象中没有的事件从给出的对象中复制过来。
  addListener(String eventName, Function handler, [Object scope], [Object options]) : void Observable
为该组件加入事件处理器函数
  disable() : void Component
Disable this component
  enable() : void Component
Enable this component
  fireEvent(String eventName, Object... args) : Boolean Observable
触发指定的事件, 并将参数传入(至少要有事件名称)。
  focus(Boolean selectText) : void Component
Try to focus this component
  getEl() : Ext.Element Component
Returns the underlying Ext.Element
  getId() : String Component
Returns the id of this component
  hasListener(String eventName) : Boolean Observable
检查该对象是否拥有指定事件的侦听器
  hide() : void Component
Hide this component
  isVisible() : void Component
Returns true if this component is visible
  on(String eventName, Function handler, [Object options]) : void Observable
为该组件加入事件处理器函数, addListener 的简写方式
  purgeListeners() : void Observable
从对象身上移除所有的侦听器
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器
  render([String/HTMLElement/Element container]) : void Component
If this is a lazy rendering component, render it to its container element
  setDisabled(Boolean disabled) : void Component
Convenience function for setting disabled/enabled by boolean
  setVisible(Boolean visible) : void Component
Convenience function to hide or show this component by boolean
  show() : void Component
Show this component
  un(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器, removeListener 的简写方式

公共事件

事件 定义对象
  activate : (Ext.menu.BaseItem this) BaseItem
Fires when this item is activated
  beforedestroy : (Ext.Component this) Component
Fires before the component is destroyed
  beforehide : (Ext.Component this) Component
Fires before the component is hidden
  beforerender : (Ext.Component this) Component
Fires before the component is rendered
  beforeshow : (Ext.Component this) Component
Fires before the component is shown
  click : (Ext.menu.BaseItem this, Ext.EventObject e) BaseItem
Fires when this item is clicked
  deactivate : (Ext.menu.BaseItem this) BaseItem
Fires when this item is deactivated
  destroy : (Ext.Component this) Component
Fires after the component is destroyed
  disable : (Ext.Component this) Component
Fires after the component is disabled
  enable : (Ext.Component this) Component
Fires after the component is enabled
  hide : (Ext.Component this) Component
Fires after the component is hidden
  render : (Ext.Component this) Component
Fires after the component is rendered
  show : (Ext.Component this) Component
Fires after the component is shown

设置选项

设置选项 定义对象
  activeClass : String BaseItem
The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")
  canActivate : Boolean BaseItem
True if this item can be visually activated (defaults to false)
  handler : Function BaseItem
A function that will handle the click event of this menu item (defaults to undefined)
  hideDelay : Number BaseItem
Length of time in milliseconds to wait before hiding after a click (defaults to 100)
  hideOnClick : Boolean BaseItem
True to hide the containing menu after this item is clicked (defaults to true)

属性详情

disabled

public Object disabled
true if this component is disabled. Read-only.
This property is defined by Component.

disabledClass

public Object disabledClass
CSS class added to the component when it is disabled.
This property is defined by Component.

hidden

public Object hidden
true if this component is hidden. Read-only.
This property is defined by Component.

rendered

public Object rendered
true if this component has been rendered. Read-only.
This property is defined by Component.

构造函数

Adapter

public function Adapter(Object config)
Creates a new Adapter
参数:
  • config : Object
    Configuration options

方法详情

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.

disable

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

enable

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

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(Boolean selectText)
Try to focus this component
参数:
  • selectText : Boolean
    True to also select the text in this component (if applicable)
返回:
  • void
This method is defined by Component.

getEl

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

getId

public function getId()
Returns the id of this component
参数:
  • 无。
返回:
  • String
This method is defined by Component.

hasListener

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

hide

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

isVisible

public function isVisible()
Returns true if this component is visible
参数:
  • 无。
返回:
  • void
This method is defined by Component.

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.

render

public function render([String/HTMLElement/Element container])
If this is a lazy rendering component, render it to its container element
参数:
  • container : String/HTMLElement/Element
    (可选) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.
返回:
  • void
This method is defined by Component.

setDisabled

public function setDisabled(Boolean disabled)
Convenience function for setting disabled/enabled by boolean
参数:
  • disabled : Boolean
返回:
  • void
This method is defined by Component.

setVisible

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

show

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

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.

事件详情

activate

public event activate
Fires when this item is activated
Subscribers will be called with the following parameters:
  • this : Ext.menu.BaseItem
This event is defined by BaseItem.

beforedestroy

public event beforedestroy
Fires before the component is destroyed
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforehide

public event beforehide
Fires before the component is hidden
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforerender

public event beforerender
Fires before the component is rendered
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforeshow

public event beforeshow
Fires before the component is shown
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

click

public event click
Fires when this item is clicked
Subscribers will be called with the following parameters:
  • this : Ext.menu.BaseItem
  • e : Ext.EventObject
This event is defined by BaseItem.

deactivate

public event deactivate
Fires when this item is deactivated
Subscribers will be called with the following parameters:
  • this : Ext.menu.BaseItem
This event is defined by BaseItem.

destroy

public event destroy
Fires after the component is destroyed
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

disable

public event disable
Fires after the component is disabled
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

enable

public event enable
Fires after the component is enabled
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

hide

public event hide
Fires after the component is hidden
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

render

public event render
Fires after the component is rendered
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

show

public event show
Fires after the component is shown
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

设置详情

activeClass

activeClass : String
The CSS class to use when the item becomes activated (defaults to "x-menu-item-active")
This config option is defined by BaseItem.

canActivate

canActivate : Boolean
True if this item can be visually activated (defaults to false)
This config option is defined by BaseItem.

handler

handler : Function
A function that will handle the click event of this menu item (defaults to undefined)
This config option is defined by BaseItem.

hideDelay

hideDelay : Number
Length of time in milliseconds to wait before hiding after a click (defaults to 100)
This config option is defined by BaseItem.

hideOnClick

hideOnClick : Boolean
True to hide the containing menu after this item is clicked (defaults to true)
This config option is defined by BaseItem.

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