Class Ext.Toolbar.Button

Package:	Ext
Class:	Toolbar.Button
Extends:	Button
Defined In:	Toolbar.js

A button that renders into a toolbar.

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	disabled : Boolean	Button
	Read-only. True if this button is disabled	Button
	hidden : Boolean	Button
	Read-only. True if this button is hidden	Button
	pressed : Boolean	Button
	Read-only. True if this button is pressed (only if enableToggle = true)	Button

Public Methods

Method		Defined By
	Toolbar.Button(`Object config`)	Toolbar.Button
	Creates a new Button	Toolbar.Button
	addEvents(`Object object`) : void	Observable
	Used to define events on this Observable	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	destroy() : void	Toolbar.Button
	Remove and destroy this button	Toolbar.Button
	disable() : void	Toolbar.Button
	Disable this item	Toolbar.Button
	enable() : void	Toolbar.Button
	Enable this item	Toolbar.Button
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	focus() : void	Button
	Focus the button	Button
	getEl() : Ext.Element	Button
	Returns the button's underlying element	Button
	getText() : String	Button
	Gets the text for this button	Button
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object has any listeners for a specified event	Observable
	hide() : void	Toolbar.Button
	Hide this button	Toolbar.Button
	on(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	setDisabled(`Boolean enabled`) : void	Button
	Convenience function for boolean enable/disable	Button
	setHandler(`Function handler`, [`Object scope`]) : void	Button
	Assigns this button's click handler	Button
	setText(`String text`) : void	Button
	Sets this button's text	Button
	setVisible(`Boolean visible`) : void	Button
	Convenience function for boolean show/hide	Button
	show() : void	Toolbar.Button
	Show this button	Toolbar.Button
	toggle([`Boolean state`]) : void	Button
	If a state it passed, it becomes the pressed state otherwise the current state is toggled.	Button
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	click : (`Button this`, `EventObject e`)	Button
	Fires when this button is clicked	Button
	mouseout : (`Button this`, `Event e`)	Button
	Fires when the mouse exits the button	Button
	mouseover : (`Button this`, `Event e`)	Button
	Fires when the mouse hovers over the button	Button
	toggle : (`Button this`, `Boolean pressed`)	Button
	Fires when the "pressed" state of this button changes (only if enableToggle = true)	Button

Config Options

Config Options		Defined By
	clickEvent : String	Button
	The type of event to map to the button's event handler (defaults to 'click')	Button
	cls : String	Button
	A CSS class to apply to the button's main element.	Button
	disabled : Boolean	Button
	True to start disabled (defaults to false)	Button
	enableToggle : Boolean	Button
	True to enable pressed/not pressed toggling (defaults to false)	Button
	handleMouseEvents : Boolean	Button
	False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)	Button
	handler : Function	Button
	A function called when the button is clicked (can be used instead of click event)	Button
	hidden : Boolean	Button
	True to start hidden (defaults to false)	Button
	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...	Button
	iconCls : String	Button
	A css class which sets a background image to be used as the icon for this button (defaults to undefined).	Button
	menu : Mixed	Button
	Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to unde...	Button
	menuAlign : String	Button
	The position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?').	Button
	minWidth : Number	Button
	The minimum width for this button (used to give a set of buttons a common width)	Button
	pressed : Boolean	Button
	True to start pressed (only if enableToggle = true)	Button
	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...	Button
	scope : Object	Button
	The scope of the handler	Button
	tabIndex : Number	Button
	The DOM tabIndex for this button (defaults to undefined)	Button
	template : Ext.Template	Button
	(Optional) An Ext.Template with which to create the Button's main element. This Template must contain numeric substit...	Button
	text : String	Button
	The button text	Button
	toggleGroup : String	Button
	The group this toggle button is a member of (only 1 per group can be pressed, only applies if enableToggle = true)	Button
	tooltip : String/Object	Button
	The tooltip for the button - can be a string or QuickTips config object	Button
	tooltipType : String	Button
	The type of tooltip to use. Either "qtip" (default) for QuickTips or "title" for title attribute.	Button
	type : String	Button
	The button's type, corresponding to the DOM input element type attribute. Either "submit," "reset" or "button" (defau...	Button

Property Details

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.

Constructor Details

Toolbar.Button

public function Toolbar.Button(Object config)

Creates a new Button

Parameters:

config : Object
A standard Ext.Button config object

Method Details

addEvents

public function addEvents(Object object)

Used to define events on this Observable

Parameters:

object : Object
The object with the events defined

Returns:

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object scope], [Object options])

Appends an event handler to this component

Parameters:

eventName : String
The type of event to listen for
handler : Function
The 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.
- 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, forumId: 4 });
```
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.
Code:
```
 foo.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:
```
 foo.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
```

Returns:

void

This method is defined by Observable.

destroy

public function destroy()

Remove and destroy this button

Parameters:

None.

Returns:

void

This method is defined by Toolbar.Button.

disable

public function disable()

Disable this item

Parameters:

None.

Returns:

void

This method is defined by Toolbar.Button.

enable

public function enable()

Enable this item

Parameters:

None.

Returns:

void

This method is defined by Toolbar.Button.

fireEvent

public function fireEvent(String eventName, Object... args)

Fires the specified event with the passed parameters (minus the event name).

Parameters:

eventName : String
args : Object...
Variable number of parameters are passed to handlers

Returns:

Boolean
returns false if any of the handlers return false otherwise it returns true

This method is defined by Observable.

focus

public function focus()

Focus the button

Parameters:

None.

Returns:

void

This method is defined by Button.

getEl

public function getEl()

Returns the button's underlying element

Parameters:

None.

Returns:

Ext.Element
The element

This method is defined by Button.

getText

public function getText()

Gets the text for this button

Parameters:

None.

Returns:

String
The button text

This method is defined by Button.

hasListener

public function hasListener(String eventName)

Checks to see if this object has any listeners for a specified event

Parameters:

eventName : String
The name of the event to check for

Returns:

Boolean
True if the event is being listened for, else false

This method is defined by Observable.

hide

public function hide()

Hide this button

Parameters:

None.

Returns:

void

This method is defined by Toolbar.Button.

on

public function on(String eventName, Function handler, [Object scope], [Object options])

Appends an event handler to this element (shorthand for addListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The 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)

Returns:

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

Removes all listeners for this object

Parameters:

None.

Returns:

void

This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])

Removes a listener

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

setDisabled

public function setDisabled(Boolean enabled)

Convenience function for boolean enable/disable

Parameters:

enabled : Boolean
True to enable, false to disable

Returns:

void

This method is defined by Button.

setHandler

public function setHandler(Function handler, [Object scope])

Assigns this button's click handler

Parameters:

handler : Function
The function to call when the button is clicked
scope : Object
(optional) Scope for the function passed in

Returns:

void

This method is defined by Button.

setText

public function setText(String text)

Sets this button's text

Parameters:

text : String
The button text

Returns:

void

This method is defined by Button.

setVisible

public function setVisible(Boolean visible)

Convenience function for boolean show/hide

Parameters:

visible : Boolean
True to show, false to hide

Returns:

void

This method is defined by Button.

show

public function show()

Show this button

Parameters:

None.

Returns:

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.

Parameters:

state : Boolean
(optional) Force a particular state

Returns:

void

This method is defined by Button.

un

public function un(String eventName, Function handler, [Object scope])

Removes a listener (shorthand for removeListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

Event Details

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.