Roo.util.Observable
Roo.Component
Roo.bootstrap.Component
Roo.bootstrap.Button
Roo.bootstrap.SplitButton

Class Roo.bootstrap.SplitButton

Package:	Roo.bootstrap
Defined In:	Roo/bootstrap/SplitButton.js.
Class:	SplitButton
Subclasses:	Roo.bootstrap.Toolbar.SplitButton
Extends:	Roo.bootstrap.Button

A split button that provides a built-in dropdown arrow that can fire an event separately from the default
click event of the button. Typically this would be used to display a dropdown menu that provides additional
options to the primary button action, but any custom handler can provide the arrowclick implementation.

Class Comments / Notes => [Add Your comment/notes about this class]

Config Options (Usually are also Properties)
Options		Defined By
	actionMode : String which property holds the element that used for hide() / show() / disable() / enable() default is 'el' which property holds the element that used for hide() / show() / disable() / enable() default is 'el'	Roo.Component
	allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). Whether the component can move the Dom node when rendering (defaults to true).	Roo.Component
	arrowHandler : Function A function called when the arrow button is clicked (can be used instead of click event) A function called when the arrow button is clicked (can be used instead of click event)	Roo.bootstrap.SplitButton
	arrowTooltip : String The title attribute of the arrow The title attribute of the arrow	Roo.bootstrap.SplitButton
	badge : String text for badge text for badge	Roo.bootstrap.Button
	can_build_overlaid : Boolean True if element can be rebuild from a HTML page True if element can be rebuild from a HTML page	Roo.bootstrap.Component
	cls : String css class css class	Roo.bootstrap.Component
	dataId : string cutomer id cutomer id	Roo.bootstrap.Component
	defaulton : Boolean true \| false true \| false	Roo.bootstrap.Button
	disableClass : String CSS class added to the component when it is disabled (defaults to "x-item-disabled"). CSS class added to the component when it is disabled (defaults to "x-item-disabled").	Roo.Component
	disabled : Boolean false \| true false \| true	Roo.bootstrap.Button
	glyphicon : String empty \| adjust \| align-center \| align-justify \| align-left \| align-right \| arrow-down \| arrow-left \| arrow-right \| arrow-up \| asterisk \| backward \| ban-circle \| barcode \| bell \| bold \| book \| bookmark \| briefcase \| bullhorn \| calendar \| camera \| certificate \| check \| chevron-down \| chevron-left \| chevron-right \| chevron-up \| circle-arrow-down \| circle-arrow-left \| circle-arrow-right \| circle-arrow-up \| cloud \| cloud-download \| cloud-upload \| cog \| collapse-down \| collapse-up \| comment \| compressed \| copyright-mark \| credit-card \| cutlery \| dashboard \| download \| download-alt \| earphone \| edit \| eject \| envelope \| euro \| exclamation-sign \| expand \| export \| eye-close \| eye-open \| facetime-video \| fast-backward \| fast-forward \| file \| film \| filter \| fire \| flag \| flash \| floppy-disk \| floppy-open \| floppy-remove \| floppy-save \| floppy-saved \| folder-close \| folder-open \| font \| forward \| fullscreen \| gbp \| gift \| glass \| globe \| hand-down \| hand-left \| hand-right \| hand-up \| hd-video \| hdd \| header \| headphones \| heart \| heart-empty \| home \| import \| inbox \| indent-left \| indent-right \| info-sign \| italic \| leaf \| link \| list \| list-alt \| lock \| log-in \| log-out \| magnet \| map-marker \| minus \| minus-sign \| move \| music \| new-window \| off \| ok \| ok-circle \| ok-sign \| open \| paperclip \| pause \| pencil \| phone \| phone-alt \| picture \| plane \| play \| play-circle \| plus \| plus-sign \| print \| pushpin \| qrcode \| question-sign \| random \| record \| refresh \| registration-mark \| remove \| remove-circle \| remove-sign \| repeat \| resize-full \| resize-horizontal \| resize-small \| resize-vertical \| retweet \| road \| save \| saved \| screenshot \| sd-video \| search \| send \| share \| share-alt \| shopping-cart \| signal \| sort \| sort-by-alphabet \| sort-by-alphabet-alt \| sort-by-attributes \| sort-by-attributes-alt \| sort-by-order \| sort-by-order-alt \| sound-5-1 \| sound-6-1 \| sound-7-1 \| sound-dolby \| sound-stereo \| star \| star-empty \| stats \| step-backward \| step-forward \| stop \| subtitles \| tag \| tags \| tasks \| text-height \| text-width \| th \| th-large \| th-list \| thumbs-down \| thumbs-up \| time \| tint \| tower \| transfer \| trash \| tree-conifer \| tree-deciduous \| unchecked \| upload \| usd \| user \| volume-down \| volume-off \| volume-up \| warning-sign \| wrench \| zoom-in \| zoom-out empty \| adjust \| align-center \| align-justify \| align-left \| align-right \| arrow-down \| arrow-left \| arrow-right \| arrow-up \| asterisk \| backward \| ban-circle \| barcode \| bell \| bold \| book \| bookmark \| briefcase \| bullhorn \| calendar \| camera \| certificate \| check \| chevron-down \| chevron-left \| chevron-right \| chevron-up \| circle-arrow-down \| circle-arrow-left \| circle-arrow-right \| circle-arrow-up \| cloud \| cloud-download \| cloud-upload \| cog \| collapse-down \| collapse-up \| comment \| compressed \| copyright-mark \| credit-card \| cutlery \| dashboard \| download \| download-alt \| earphone \| edit \| eject \| envelope \| euro \| exclamation-sign \| expand \| export \| eye-close \| eye-open \| facetime-video \| fast-backward \| fast-forward \| file \| film \| filter \| fire \| flag \| flash \| floppy-disk \| floppy-open \| floppy-remove \| floppy-save \| floppy-saved \| folder-close \| folder-open \| font \| forward \| fullscreen \| gbp \| gift \| glass \| globe \| hand-down \| hand-left \| hand-right \| hand-up \| hd-video \| hdd \| header \| headphones \| heart \| heart-empty \| home \| import \| inbox \| indent-left \| indent-right \| info-sign \| italic \| leaf \| link \| list \| list-alt \| lock \| log-in \| log-out \| magnet \| map-marker \| minus \| minus-sign \| move \| music \| new-window \| off \| ok \| ok-circle \| ok-sign \| open \| paperclip \| pause \| pencil \| phone \| phone-alt \| picture \| plane \| play \| play-circle \| plus \| plus-sign \| print \| pushpin \| qrcode \| question-sign \| random \| record \| refresh \| registration-mark \| remove \| remove-circle \| remove-sign \| repeat \| resize-full \| resize-horizontal \| resize-small \| resize-vertical \| retweet \| road \| save \| saved \| screenshot \| sd-video \| search \| send \| share \| share-alt \| shopping-cart \| signal \| sort \| sort-by-alphabet \| sort-by-alphabet-alt \| sort-by-attributes \| sort-by-attributes-alt \| sort-by-order \| sort-by-order-alt \| sound-5-1 \| sound-6-1 \| sound-7-1 \| sound-dolby \| sound-stereo \| star \| star-empty \| stats \| step-backward \| step-forward \| stop \| subtitles \| tag \| tags \| tasks \| text-height \| text-width \| th \| th-large \| th-list \| thumbs-down \| thumbs-up \| time \| tint \| tower \| transfer \| trash \| tree-conifer \| tree-deciduous \| unchecked \| upload \| usd \| user \| volume-down \| volume-off \| volume-up \| warning-sign \| wrench \| zoom-in \| zoom-out	Roo.bootstrap.Button
	hideMode : String How this component should hidden. How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".	Roo.Component
	href : String empty or href empty or href	Roo.bootstrap.Button
	html : String The button content The button content	Roo.bootstrap.Button
	inverse : Boolean false \| true false \| true	Roo.bootstrap.Button
	isClose : Boolean false \| true false \| true	Roo.bootstrap.Button
	listeners : Object list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... }`	Roo.util.Observable
	name : string Specifies name attribute Specifies name attribute	Roo.bootstrap.Component
	offtext : String text for off toggle state text for off toggle state	Roo.bootstrap.Button
	ontext : String text for on toggle state text for on toggle state	Roo.bootstrap.Button
	preventDefault : Boolean (true \| false) default true (true \| false) default true	Roo.bootstrap.Button
	removeClass : Boolean true \| false remove the standard class. true \| false remove the standard class..	Roo.bootstrap.Button
	size : String empty \| lg \| sm \| xs empty \| lg \| sm \| xs	Roo.bootstrap.Button
	style : String any extra css any extra css	Roo.bootstrap.Component
	tag : String empty \| a \| input \| submit empty \| a \| input \| submit	Roo.bootstrap.Button
	target : String (_self\|_blank\|_parent\|_top)target for a href. (_self\|_blank\|_parent\|_top)target for a href.	Roo.bootstrap.Button
	theme : String default (or empty) \| glow default (or empty) \| glow	Roo.bootstrap.Button
	toggle : Boolean false \| true false \| true	Roo.bootstrap.Button
	weight : String default (or empty) \| primary \| success \| info \| warning \| danger \| link default (or empty) \| primary \| success \| info \| warning \| danger \| link	Roo.bootstrap.Button
	xattr : Object extra attributes to add to 'element' (used by builder to store stuff. extra attributes to add to 'element' (used by builder to store stuff.)	Roo.bootstrap.Component

Public Methods
Method		Defined By
	new Roo.bootstrap.SplitButton (String/HTMLElement/Element *renderTo, Object config) Create a new Roo.bootstrap.SplitButton Create a new Roo.bootstrap.SplitButton Parameters: String/HTMLElement/Element renderTo* The element to append the button to Object config The config object
	addEvents (Object *object) Used to define events on this Observable Used to define events on this Observable Parameters: Object object* The object with the events defined	Roo.util.Observable
	addListener (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this component Appends an event handler to this component Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (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 {link Roo.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) `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 });`	Roo.util.Observable
	destroy () Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}. Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}.	Roo.Component
	disable () : Roo.Component Disable this component. Disable this component. Returns: Roo.Component this	Roo.Component
	enable () : Roo.Component Enable this component. Enable this component. Returns: Roo.Component this	Roo.Component
	fireEvent (String *eventName, Object... args) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: String eventName* Object... args Variable number of parameters are passed to handlers Returns: Boolean returns false if any of the handlers return false otherwise it returns true	Roo.util.Observable
	focus () Focus the button Focus the button	Roo.bootstrap.SplitButton
	getEl () : Roo.Element Returns the underlying {link Roo.Element}. Returns the underlying {link Roo.Element}. Returns: Roo.Element The element	Roo.Component
	getId () : String Returns the id of this component. Returns the id of this component. Returns: String	Roo.Component
	hasListener (String *eventName) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: String eventName* The name of the event to check for Returns: Boolean True if the event is being listened for, else false	Roo.util.Observable
	hide () : Roo.Component Hide this component. Hide this component. Returns: Roo.Component this	Roo.Component
	isVisible () Returns true if this component is visible. Returns true if this component is visible.	Roo.Component
	on (String *eventName, Function handler, Object scope, Object options) Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: String eventName* The type of event to listen for Function handler The method the event invokes Object scope (optional) The scope in which to execute the handler function. The handler function's "this" context. Object options (optional)	Roo.util.Observable
	purgeListeners () Removes all listeners for this object Removes all listeners for this object	Roo.util.Observable
	removeListener (String *eventName, Function handler, Object scope) Removes a listener Removes a listener Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable
	render (String/HTMLElement/Element *container) If this is a lazy rendering component, render it to its container element. If this is a lazy rendering component, render it to its container element. Parameters: String/HTMLElement/Element container* (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.	Roo.Component
	setArrowHandler (Function *handler, Object scope) Sets this button's arrow click handler Sets this button's arrow click handler Parameters: Function handler* The function to call when the arrow is clicked Object scope (optional) Scope for the function passed above	Roo.bootstrap.SplitButton
	setDisabled (Boolean *disabled) Convenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters: Boolean disabled*	Roo.Component
	setHandler (Function *handler, Object scope) Sets this button's click handler Sets this button's click handler Parameters: Function handler* The function to call when the button is clicked Object scope (optional) Scope for the function passed above	Roo.bootstrap.SplitButton
	setVisible (Boolean *visible) : Roo.Component Convenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters: Boolean visible* True to show, false to hide Returns: Roo.Component this	Roo.Component
	show () : Roo.Component Show this component. Show this component. Returns: Roo.Component this	Roo.Component
	un (String *eventName, Function handler, Object scope) Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: String eventName* The type of event to listen for Function handler The handler to remove Object scope (optional) The scope (this object) for the handler	Roo.util.Observable

Events
Event		Defined By
	arrowclick (SplitButton *this, EventObject e) Fires when this button's arrow is clicked Fires when this button's arrow is clicked Parameters: SplitButton this* EventObject e The click event	Roo.bootstrap.SplitButton
	beforedestroy (Roo.Component *this) Fires before the component is destroyed. Fires before the component is destroyed. Return false to stop the destroy. Parameters: Roo.Component this*	Roo.Component
	beforehide (Roo.Component *this) Fires before the component is hidden. Fires before the component is hidden. Return false to stop the hide. Parameters: Roo.Component this*	Roo.Component
	beforerender (Roo.Component *this) Fires before the component is rendered. Fires before the component is rendered. Return false to stop the render. Parameters: Roo.Component this*	Roo.Component
	beforeshow (Roo.Component *this) Fires before the component is shown. Fires before the component is shown. Return false to stop the show. Parameters: Roo.Component this*	Roo.Component
	click (Roo.EventObject e) The raw click event for the entire grid. The raw click event for the entire grid. Parameters: Roo.EventObject e	Roo.bootstrap.Button
	destroy (Roo.Component *this) Fires after the component is destroyed. Fires after the component is destroyed. Parameters: Roo.Component this*	Roo.Component
	disable (Roo.Component *this) Fires after the component is disabled. Fires after the component is disabled. Parameters: Roo.Component this*	Roo.Component
	enable (Roo.Component *this) Fires after the component is enabled. Fires after the component is enabled. Parameters: Roo.Component this*	Roo.Component
	hide (Roo.Component *this) Fires after the component is hidden. Fires after the component is hidden. Parameters: Roo.Component this*	Roo.Component
	render (Roo.Component *this) Fires after the component is rendered. Fires after the component is rendered. Parameters: Roo.Component this*	Roo.Component
	show (Roo.Component *this) Fires after the component is shown. Fires after the component is shown. Parameters: Roo.Component this*	Roo.Component

Documentation generated by Introspection Doc Generator on Thu May 15 2014 17:51:21 GMT+0800 (HKT) Based on JsDoc Toolkit