addListener
public function addListener(String eventName
, Function handler
, [Object scope
], [Object options
])
Appends an event handler to this component
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler function. The handler function's "this" context.
options
: Object(optional) An object containing handler configuration properties. This may contain any of the following properties:
- scope {Object} The scope in which to execute the handler function. The handler function's "this" context.
- delegate {String} A simple selector to filter the target or look for a descendant of the target
- stopEvent {Boolean} True to stop the event. That is stop propagation, and prevent the default action.
- preventDefault {Boolean} True to prevent the default action
- stopPropagation {Boolean} True to prevent event propagation
- normalized {Boolean} False to pass a browser event to the handler function instead of an Ext.EventObject
- delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
- single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer {Number} Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
Code:
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.
Attaching multiple handlers in 1 call
Code:
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
Or a shorthand syntax:
Code:
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
Returns:
destroy
public function destroy()
Destroys this Button and removes any listeners.
This method is defined by Button.
disable
public function disable()
This method is defined by Button.
enable
public function enable()
This method is defined by Button.
fireEvent
public function fireEvent(String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
focus
public function focus()
This method is defined by Button.
getEl
public function getEl()
Returns the button's underlying element
This method is defined by Button.
getText
public function getText()
Gets the text for this button
This method is defined by Button.
hasListener
public function hasListener(String eventName
)
Checks to see if this object is currently listening for a specified event
hide
public function hide()
This method is defined by Button.
on
public function on(String eventName
, Function handler
, [Object options
])
Appends an event handler to this element (shorthand for addListener)
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeListener
public function removeListener(String eventName
, Function handler
, [Object scope
])
setDisabled
public function setDisabled(Boolean enabled
)
Convenience function for boolean enable/disable
This method is defined by Button.
setHandler
public function setHandler(Function handler
, [Object scope
])
Assigns this button's click handler
This method is defined by Button.
setText
public function setText(String text
)
Sets this button's text
Parameters:
text
: StringThe button text
Returns:
This method is defined by Button.
setVisible
public function setVisible(Boolean visible
)
Convenience function for boolean show/hide
This method is defined by Button.
show
public function show()
This method is defined by Button.
toggle
public function toggle([Boolean state
])
If a state it passed, it becomes the pressed state otherwise the current state is toggled.
This method is defined by Button.
un
public function un(String eventName
, Function handler
, [Object scope
])
Removes a listener (shorthand for removeListener)
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.