Package: | Ext |
Class: | Toolbar.Button |
Extends: | Button |
Defined In: | Toolbar.js |
Property | Defined By | |
---|---|---|
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) |
Method | Defined By | |
---|---|---|
Toolbar.Button( Object config ) |
Toolbar.Button | |
Creates a new Button | ||
addEvents( Object object ) : void |
Observable | |
Used to define events on this Observable | ||
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable | |
Appends an event handler to this component | ||
destroy() : void | Toolbar.Button | |
Removes and destroys this button | ||
disable() : void | Toolbar.Button | |
Disables this item | ||
enable() : void | Toolbar.Button | |
Enables this item | ||
fireEvent( String eventName , Object... args ) : Boolean |
Observable | |
Fires the specified event with the passed parameters (minus the event name). | ||
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 | |
Checks to see if this object has any listeners for a specified event | ||
hide() : void | Toolbar.Button | |
Hides this button | ||
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable | |
Appends an event handler to this element (shorthand for addListener) | ||
purgeListeners() : void | Observable | |
Removes all listeners for this object | ||
removeListener( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener | ||
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 | |
Shows 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 | |
Removes a listener (shorthand for removeListener) |
Event | Defined By | |
---|---|---|
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) |
Config Options | Defined By | |
---|---|---|
clickEvent : String | Button | |
The type of event to map to the button's event handler (defaults to 'click') | ||
cls : String | Button | |
A CSS class to apply to the button's main element. | ||
disabled : Boolean | Button | |
True to start disabled (defaults to false) | ||
enableToggle : Boolean | Button | |
True to enable pressed/not pressed toggling (defaults to false) | ||
handleMouseEvents : Boolean | Button | |
False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) | ||
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... | ||
iconCls : String | Button | |
A css class which sets a background image to be used as the icon for this button (defaults to undefined). | ||
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... | ||
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 | ||
tabIndex : Number | Button | |
The DOM tabIndex for this button (defaults to undefined) | ||
template : Ext.Template | Button | |
(Optional) An Ext.Template with which to create the Button's main element. This Template must contain numeric substit... | ||
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" (default) for QuickTips or "title" for title attribute. | ||
type : String | Button | |
The button's type, corresponding to the DOM input element type attribute. Either "submit," "reset" or "button" (defau... |
public Boolean disabled
public Boolean hidden
public Boolean pressed
public function Toolbar.Button( Object config
)
config
: Objectpublic function addEvents( Object object
)
object
: Objectvoid
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Object
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)
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.
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 which passes the same scope object to all handlers:
el.on({
'click': this.onClick,
'mouseover': this.onMouseOver,
'mouseout': this.onMouseOut,
scope: this
});
void
public function destroy()
void
public function disable()
void
public function enable()
void
public function fireEvent( String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function focus()
void
public function getEl()
Ext.Element
public function getText()
String
public function hasListener( String eventName
)
eventName
: StringBoolean
public function hide()
void
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Objectvoid
public function purgeListeners()
void
public function removeListener( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function setDisabled( Boolean enabled
)
enabled
: Booleanvoid
public function setHandler( Function handler
, [Object scope
] )
handler
: Functionscope
: Objectvoid
public function setText( String text
)
text
: Stringvoid
public function setVisible( Boolean visible
)
visible
: Booleanvoid
public function show()
void
public function toggle( [Boolean state
] )
state
: Booleanvoid
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public event click
this
: Buttone
: EventObjectpublic event mouseout
this
: Buttone
: Eventpublic event mouseover
this
: Buttone
: Eventpublic event toggle
this
: Buttonpressed
: BooleanclickEvent : String
cls : String
disabled : Boolean
enableToggle : Boolean
handleMouseEvents : Boolean
handler : Function
hidden : Boolean
icon : String
iconCls : String
menu : Mixed
menuAlign : String
minWidth : Number
pressed : Boolean
repeat : Boolean/Object
tabIndex : Number
template : Ext.Template
toggleGroup : String
tooltip : String/Object
tooltipType : String
type : String