Class Ext.Component

Package:	Ext
Class:	Component
Extends:	Observable
Subclasses:	ColorPalette, DatePicker, Editor, Layout, BaseItem
Defined In:	Component.js

Base class for all Ext form controls that provides a common set of events and functionality shared by all components.

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	disabled : Object	Component
	true if this component is disabled. Read-only.	Component
	disabledClass : Object	Component
	CSS class added to the component when it is disabled.	Component
	hidden : Object	Component
	true if this component is hidden. Read-only.	Component
	rendered : Object	Component
	true if this component has been rendered. Read-only.	Component

Public Methods

Method		Defined By
	Component(`Ext.Element/String/Object config`)	Component
		Component
	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
	disable() : void	Component
	Disable this component	Component
	enable() : void	Component
	Enable this component	Component
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	focus(`Boolean selectText`) : void	Component
	Try to focus this component	Component
	getEl() : Ext.Element	Component
	Returns the underlying Ext.Element	Component
	getId() : String	Component
	Returns the id of this component	Component
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object has any listeners for a specified event	Observable
	hide() : void	Component
	Hide this component	Component
	isVisible() : void	Component
	Returns true if this component is visible	Component
	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
	render([`String/HTMLElement/Element container`]) : void	Component
	If this is a lazy rendering component, render it to its container element	Component
	setDisabled(`Boolean disabled`) : void	Component
	Convenience function for setting disabled/enabled by boolean	Component
	setVisible(`Boolean visible`) : void	Component
	Convenience function to hide or show this component by boolean	Component
	show() : void	Component
	Show this component	Component
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	beforedestroy : (`Ext.Component this`)	Component
	Fires before the component is destroyed	Component
	beforehide : (`Ext.Component this`)	Component
	Fires before the component is hidden	Component
	beforerender : (`Ext.Component this`)	Component
	Fires before the component is rendered	Component
	beforeshow : (`Ext.Component this`)	Component
	Fires before the component is shown	Component
	destroy : (`Ext.Component this`)	Component
	Fires after the component is destroyed	Component
	disable : (`Ext.Component this`)	Component
	Fires after the component is disabled	Component
	enable : (`Ext.Component this`)	Component
	Fires after the component is enabled	Component
	hide : (`Ext.Component this`)	Component
	Fires after the component is hidden	Component
	render : (`Ext.Component this`)	Component
	Fires after the component is rendered	Component
	show : (`Ext.Component this`)	Component
	Fires after the component is shown	Component

Config Options

Config Options		Defined By
	hideMode : String	Component
	How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...	Component

Property Details

disabled

public Object disabled

true if this component is disabled. Read-only.

This property is defined by Component.

disabledClass

public Object disabledClass

CSS class added to the component when it is disabled.

This property is defined by Component.

hidden

public Object hidden

true if this component is hidden. Read-only.

This property is defined by Component.

rendered

public Object rendered

true if this component has been rendered. Read-only.

This property is defined by Component.

Constructor Details

Component

public function Component(Ext.Element/String/Object config)

Parameters:

config : Ext.Element/String/Object
The configuration options. If an element is passed, it is set as the internal element and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.

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.

disable

public function disable()

Disable this component

Parameters:

None.

Returns:

void

This method is defined by Component.

enable

public function enable()

Enable this component

Parameters:

None.

Returns:

void

This method is defined by Component.

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(Boolean selectText)

Try to focus this component

Parameters:

selectText : Boolean
True to also select the text in this component (if applicable)

Returns:

void

This method is defined by Component.

getEl

public function getEl()

Returns the underlying Ext.Element

Parameters:

None.

Returns:

Ext.Element
The element

This method is defined by Component.

getId

public function getId()

Returns the id of this component

Parameters:

None.

Returns:

String

This method is defined by Component.

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 component

Parameters:

None.

Returns:

void

This method is defined by Component.

isVisible

public function isVisible()

Returns true if this component is visible

Parameters:

None.

Returns:

void

This method is defined by Component.

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.

render

public function render([String/HTMLElement/Element container])

If this is a lazy rendering component, render it to its container element

Parameters:

container : String/HTMLElement/Element
(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.

Returns:

void

This method is defined by Component.

setDisabled

public function setDisabled(Boolean disabled)

Convenience function for setting disabled/enabled by boolean

Parameters:

disabled : Boolean

Returns:

void

This method is defined by Component.

setVisible

public function setVisible(Boolean visible)

Convenience function to hide or show this component by boolean

Parameters:

visible : Boolean
True to show, false to hide

Returns:

void

This method is defined by Component.

show

public function show()

Show this component

Parameters:

None.

Returns:

void

This method is defined by Component.

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

beforedestroy

public event beforedestroy

Fires before the component is destroyed

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

beforehide

public event beforehide

Fires before the component is hidden

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

beforerender

public event beforerender

Fires before the component is rendered

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

beforeshow

public event beforeshow

Fires before the component is shown

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

destroy

public event destroy

Fires after the component is destroyed

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

disable

public event disable

Fires after the component is disabled

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

enable

public event enable

Fires after the component is enabled

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

hide

public event hide

Fires after the component is hidden

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

render

public event render

Fires after the component is rendered

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

show

public event show

Fires after the component is shown

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

Config Details

hideMode

hideMode : String

How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to display

This config option is defined by Component.