Package: | Ext.menu |
Class: | CheckItem |
Extends: | Item |
Defined In: | CheckItem.js |
Property | Defined By | |
---|---|---|
disabled : Object | Component | |
true if this component is disabled. Read-only. | ||
hidden : Object | Component | |
true if this component is hidden. Read-only. | ||
rendered : Object | Component | |
true if this component has been rendered. Read-only. |
Method | Defined By | |
---|---|---|
CheckItem( Object config ) |
CheckItem | |
Creates a new CheckItem | ||
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 | Component | |
Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the c... | ||
disable() : Ext.Component | Component | |
Disable this component. | ||
enable() : Ext.Component | Component | |
Enable this component. | ||
fireEvent( String eventName , Object... args ) : Boolean |
Observable | |
Fires the specified event with the passed parameters (minus the event name). | ||
focus( Boolean selectText ) : Ext.Component |
Component | |
Try to focus this component. | ||
getEl() : Ext.Element | Component | |
Returns the underlying Ext.Element. | ||
getId() : String | Component | |
Returns the id of this component. | ||
hasListener( String eventName ) : Boolean |
Observable | |
Checks to see if this object has any listeners for a specified event | ||
hide() : Ext.Component | Component | |
Hide this component. | ||
isVisible() : void | Component | |
Returns true if this component is visible. | ||
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 | ||
render( [String/HTMLElement/Element container ] ) : void |
Component | |
If this is a lazy rendering component, render it to its container element. | ||
setChecked( Boolean checked , [Boolean suppressEvent ] ) : void |
CheckItem | |
Set the checked state of this item | ||
setDisabled( Boolean disabled ) : void |
Component | |
Convenience function for setting disabled/enabled by boolean. | ||
setText( String text ) : void |
Item | |
Sets the text to display in this menu item | ||
setVisible( Boolean visible ) : Ext.Component |
Component | |
Convenience function to hide or show this component by boolean. | ||
show() : Ext.Component | Component | |
Show this component. | ||
un( String eventName , Function handler , [Object scope ] ) : void |
Observable | |
Removes a listener (shorthand for removeListener) |
Event | Defined By | |
---|---|---|
activate : ( Ext.menu.BaseItem this ) |
BaseItem | |
Fires when this item is activated | ||
beforecheckchange : ( Ext.menu.CheckItem this , Boolean checked ) |
CheckItem | |
Fires before the checked value is set, providing an opportunity to cancel if needed | ||
beforedestroy : ( Ext.Component this ) |
Component | |
Fires before the component is destroyed. Return false to stop the destroy. | ||
beforehide : ( Ext.Component this ) |
Component | |
Fires before the component is hidden. Return false to stop the hide. | ||
beforerender : ( Ext.Component this ) |
Component | |
Fires before the component is rendered. Return false to stop the render. | ||
beforeshow : ( Ext.Component this ) |
Component | |
Fires before the component is shown. Return false to stop the show. | ||
checkchange : ( Ext.menu.CheckItem this , Boolean checked ) |
CheckItem | |
Fires after the checked value has been set | ||
click : ( Ext.menu.BaseItem this , Ext.EventObject e ) |
BaseItem | |
Fires when this item is clicked | ||
deactivate : ( Ext.menu.BaseItem this ) |
BaseItem | |
Fires when this item is deactivated | ||
destroy : ( Ext.Component this ) |
Component | |
Fires after the component is destroyed. | ||
disable : ( Ext.Component this ) |
Component | |
Fires after the component is disabled. | ||
enable : ( Ext.Component this ) |
Component | |
Fires after the component is enabled. | ||
hide : ( Ext.Component this ) |
Component | |
Fires after the component is hidden. | ||
render : ( Ext.Component this ) |
Component | |
Fires after the component is rendered. | ||
show : ( Ext.Component this ) |
Component | |
Fires after the component is shown. |
Config Options | Defined By | |
---|---|---|
activeClass : String | BaseItem | |
The CSS class to use when the item becomes activated (defaults to "x-menu-item-active") | ||
allowDomMove : Boolean | Component | |
Whether the component can move the Dom node when rendering (defaults to true). | ||
canActivate : Boolean | BaseItem | |
True if this item can be visually activated (defaults to false) | ||
checked : Boolean | CheckItem | |
True to initialize this checkbox as checked (defaults to false). Note that if this checkbox is part of a radio group ... | ||
disableClass : String | Component | |
CSS class added to the component when it is disabled (defaults to "x-item-disabled"). | ||
group : String | CheckItem | |
All check items with the same group name will automatically be grouped into a single-select radio button group (defau... | ||
groupClass : String | CheckItem | |
The default CSS class to use for radio group check items (defaults to "x-menu-group-item") | ||
handler : Function | BaseItem | |
A function that will handle the click event of this menu item (defaults to undefined) | ||
hideDelay : Number | BaseItem | |
Length of time in milliseconds to wait before hiding after a click (defaults to 100) | ||
hideMode : String | Component | |
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi... | ||
hideOnClick : Boolean | BaseItem | |
True to hide the containing menu after this item is clicked (defaults to true) | ||
icon : String | Item | |
The path to an icon to display in this menu item (defaults to Ext.BLANK_IMAGE_URL) | ||
itemCls : String | CheckItem | |
The default CSS class to use for check items (defaults to "x-menu-item x-menu-check-item") | ||
showDelay : Number | Item | |
Length of time in milliseconds to wait before showing this item (defaults to 200) |
public Object disabled
public Object hidden
public Object rendered
public function CheckItem( 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()
Ext.Component
public function enable()
Ext.Component
public function fireEvent( String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function focus( Boolean selectText
)
selectText
: BooleanExt.Component
public function getEl()
Ext.Element
public function getId()
String
public function hasListener( String eventName
)
eventName
: StringBoolean
public function hide()
Ext.Component
public function isVisible()
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 render( [String/HTMLElement/Element container
] )
container
: String/HTMLElement/Elementvoid
public function setChecked( Boolean checked
, [Boolean suppressEvent
] )
checked
: BooleansuppressEvent
: Booleanvoid
public function setDisabled( Boolean disabled
)
disabled
: Booleanvoid
public function setText( String text
)
text
: Stringvoid
public function setVisible( Boolean visible
)
visible
: BooleanExt.Component
public function show()
Ext.Component
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public event activate
this
: Ext.menu.BaseItempublic event beforecheckchange
this
: Ext.menu.CheckItemchecked
: Booleanpublic event beforedestroy
this
: Ext.Componentpublic event beforehide
this
: Ext.Componentpublic event beforerender
this
: Ext.Componentpublic event beforeshow
this
: Ext.Componentpublic event checkchange
this
: Ext.menu.CheckItemchecked
: Booleanpublic event click
this
: Ext.menu.BaseIteme
: Ext.EventObjectpublic event deactivate
this
: Ext.menu.BaseItempublic event destroy
this
: Ext.Componentpublic event disable
this
: Ext.Componentpublic event enable
this
: Ext.Componentpublic event hide
this
: Ext.Componentpublic event render
this
: Ext.Componentpublic event show
this
: Ext.ComponentactiveClass : String
allowDomMove : Boolean
canActivate : Boolean
checked : Boolean
disableClass : String
group : String
groupClass : String
handler : Function
hideDelay : Number
hideMode : String
hideOnClick : Boolean
icon : String
itemCls : String
showDelay : Number