|
BoxComponent( Ext.Element/String/Object config ) |
BoxComponent |
|
|
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. |
|
getBox( [Boolean local ] ) : s |
BoxComponent |
Gets the current box measurements of the component's underlying element. |
|
getEl() : Ext.Element |
Component |
Returns the underlying Ext.Element. |
|
getId() : String |
Component |
Returns the id of this component. |
|
getPosition( [Boolean local ] ) : Array |
BoxComponent |
Gets the current XY position of the component's underlying element. |
|
getSize() : Object |
BoxComponent |
Gets the current size of the component's underlying element. |
|
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) |
|
onPosition( Number x , Number y ) : void |
BoxComponent |
Called after the component is moved, this method is empty by default but can be implemented by any
subclass that need... |
|
onResize( Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) : void |
BoxComponent |
Called after the component is resized, this method is empty by default but can be implemented by any
subclass that ne... |
|
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. |
|
setDisabled( Boolean disabled ) : void |
Component |
Convenience function for setting disabled/enabled by boolean. |
|
setPagePosition( Number x , Number y ) : s |
BoxComponent |
Sets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ... |
|
setPosition( Number left , Number top ) : s |
BoxComponent |
Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ... |
|
setSize( Number/Object width , Number height ) : Ext.BoxComponent |
BoxComponent |
Sets the width and height of the component. This method fires the resize event. This method can accept
either width... |
|
setVisible( Boolean visible ) : Ext.Component |
Component |
Convenience function to hide or show this component by boolean. |
|
show() : Ext.Component |
Component |
Show this component. |
|
syncSize() : s |
BoxComponent |
Force the component's size to recalculate based on the underlying element's current height and width. |
|
un( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener (shorthand for removeListener) |
|
updateBox( Object box ) : s |
BoxComponent |
Sets the current box measurements of the component's underlying element. |
|
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. |
|
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. |
|
move : ( Ext.Component this , Number x , Number y ) |
BoxComponent |
Fires after the component is moved. |
|
render : ( Ext.Component this ) |
Component |
Fires after the component is rendered. |
|
resize : ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight ) |
BoxComponent |
Fires after the component is resized. |
|
show : ( Ext.Component this ) |
Component |
Fires after the component is shown. |
addEvents
public function addEvents( Object object
)
Used to define events on this Observable
addListener
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this component
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe 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)
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
});
Returns:
destroy
public function destroy()
Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its
Ext.Container (if applicable) and unregistering it from
Ext.ComponentMgr.
disable
public function disable()
enable
public function enable()
fireEvent
public function fireEvent( String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
focus
public function focus( Boolean selectText
)
Try to focus this component.
getBox
public function getBox( [Boolean local
] )
Gets the current box measurements of the component's underlying element.
This method is defined by BoxComponent.
getEl
public function getEl()
getId
public function getId()
Returns the id of this component.
getPosition
public function getPosition( [Boolean local
] )
Gets the current XY position of the component's underlying element.
This method is defined by BoxComponent.
getSize
public function getSize()
Gets the current size of the component's underlying element.
This method is defined by BoxComponent.
hasListener
public function hasListener( String eventName
)
Checks to see if this object has any listeners for a specified event
hide
public function hide()
isVisible
public function isVisible()
Returns true if this component is visible.
on
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this element (shorthand for addListener)
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe 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:
onPosition
public function onPosition( Number x
, Number y
)
Called after the component is moved, this method is empty by default but can be implemented by any
subclass that needs to perform custom logic after a move occurs.
Parameters:
x
: NumberThe new x position
y
: NumberThe new y position
Returns:
This method is defined by BoxComponent.
onResize
public function onResize( Number adjWidth
, Number adjHeight
, Number rawWidth
, Number rawHeight
)
Called after the component is resized, this method is empty by default but can be implemented by any
subclass that needs to perform custom logic after a resize occurs.
Parameters:
adjWidth
: NumberThe box-adjusted width that was set
adjHeight
: NumberThe box-adjusted height that was set
rawWidth
: NumberThe width that was originally specified
rawHeight
: NumberThe height that was originally specified
Returns:
This method is defined by BoxComponent.
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeListener
public function removeListener( String eventName
, Function handler
, [Object scope
] )
render
public function render( [String/HTMLElement/Element container
] )
If this is a lazy rendering component, render it to its container element.
setDisabled
public function setDisabled( Boolean disabled
)
Convenience function for setting disabled/enabled by boolean.
setPagePosition
public function setPagePosition( Number x
, Number y
)
Sets the page XY position of the component. To set the left and top instead, use
setPosition.
This method fires the move event.
Parameters:
x
: NumberThe new x position
y
: NumberThe new y position
Returns:
This method is defined by BoxComponent.
setPosition
public function setPosition( Number left
, Number top
)
Sets the left and top of the component. To set the page XY position instead, use
setPagePosition.
This method fires the move event.
Parameters:
left
: NumberThe new left
top
: NumberThe new top
Returns:
This method is defined by BoxComponent.
setSize
public function setSize( Number/Object width
, Number height
)
Sets the width and height of the component. This method fires the resize event. This method can accept
either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
Parameters:
width
: Number/ObjectThe new width to set, or a size object in the format {width, height}
height
: NumberThe new height to set (not required if a size object is passed as the first arg)
Returns:
This method is defined by BoxComponent.
setVisible
public function setVisible( Boolean visible
)
Convenience function to hide or show this component by boolean.
show
public function show()
syncSize
public function syncSize()
Force the component's size to recalculate based on the underlying element's current height and width.
This method is defined by BoxComponent.
un
public function un( String eventName
, Function handler
, [Object scope
] )
Removes a listener (shorthand for removeListener)
updateBox
public function updateBox( Object box
)
Sets the current box measurements of the component's underlying element.
This method is defined by BoxComponent.