Print Friendly

Class Ext.Toolbar.MenuButton

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

Properties   -  Methods   -  Events   -  Config Options

Public Properties

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 (toggle mode only)

Public Methods

Method Defined By
  Toolbar.MenuButton(Object config) Toolbar.MenuButton
  addListener(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this component
  destroy() : void Toolbar.MenuButton
Remove and destroy this button
  disable() : void Button
Disable this button
  enable() : void Button
Enable this button
  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 buttons element
  getText() : String Button
Get the text for this button
  hide() : void Toolbar.MenuButton
Hide this button
  on(String eventName, Function handler, [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
  setArrowHandler(Function handler, [Object scope]) : void MenuButton
Sets this button's arrow click handler
  setHandler(Function handler, [Object scope]) : void Button
Sets this buttons click handler
  setText(String text) : void Button
Set this buttons text
  setVisible(Boolean visible) : void Button
Convenience function for boolean show/hide
  show() : void Toolbar.MenuButton
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
Removes a listener (shorthand for removeListener)

Public Events

Event Defined By
  arrowclick : (Button this, EventObject e) MenuButton
Fires when this arrow is clicked
  click : (Button this, EventObject e) Button
Fires when this button is clicked
  toggle : (Button this, Boolean pressed) Button
Fires when this the "pressed" state of this button changes (only if toggle enabled)

Config Options

Config Options Defined By
  arrowHandler : Function MenuButton
A function called when the arrow button is clicked (can be used instead of click event)
  arrowTooltip : String MenuButton
The title attribute of the arrow
  disabled : Boolean Button
True to start disabled
  enableToggle : Boolean Button
True to enable pressed/not pressed toggling
  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
  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 for toggle buttons)
  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)
  tooltip : String Button
The title attribute of the 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 (toggle mode only)
This property is defined by Button.

Constructor Details

Toolbar.MenuButton

public function Toolbar.MenuButton(Object config)
Parameters:
  • config : Object

Method Details

addListener

public function addListener(String eventName, Function handler, [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
  • options : Object
    (optional)
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.MenuButton.

disable

public function disable()
Disable this button
Parameters:
  • None.
Returns:
  • void
This method is defined by Button.

enable

public function enable()
Enable this button
Parameters:
  • None.
Returns:
  • void
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).
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 buttons element
Parameters:
  • None.
Returns:
  • Ext.Element
This method is defined by Button.

getText

public function getText()
Get the text for this button
Parameters:
  • None.
Returns:
  • String
This method is defined by Button.

hide

public function hide()
Hide this button
Parameters:
  • None.
Returns:
  • void
This method is defined by Toolbar.MenuButton.

on

public function on(String eventName, Function handler, [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
  • 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.

setArrowHandler

public function setArrowHandler(Function handler, [Object scope])
Sets this button's arrow click handler
Parameters:
  • handler : Function
    The function to call when the arrow is clicked
  • scope : Object
    (optional) Scope for the function passed above
Returns:
  • void
This method is defined by MenuButton.

setHandler

public function setHandler(Function handler, [Object scope])
Sets this buttons click handler
Parameters:
  • handler : Function
    The function to call when the button is clicked
  • scope : Object
    (optional) Scope for the function passed above
Returns:
  • void
This method is defined by Button.

setText

public function setText(String text)
Set this buttons text
Parameters:
  • text : String
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.MenuButton.

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

arrowclick

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

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.

toggle

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

Config Details

arrowHandler

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

arrowTooltip

arrowTooltip : String
The title attribute of the arrow
This config option is defined by MenuButton.

disabled

disabled : Boolean
True to start disabled
This config option is defined by Button.

enableToggle

enableToggle : Boolean
True to enable pressed/not pressed toggling
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
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 for toggle buttons)
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.
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)
This config option is defined by Button.

tooltip

tooltip : String
The title attribute of the button
This config option is defined by Button.

yui-ext - Copyright © 2006 Jack Slocum. | Yahoo! UI - Copyright © 2006 Yahoo! Inc.
All rights reserved.