Print Friendly

Class Ext.BoxComponent

Package:Ext
Class:BoxComponent
Extends:Component
Subclasses:Field
Defined In:BoxComponent.js
Base class for any visual Ext.Component that uses a box container. BoxComponent provides automatic box model adjustments for sizing and positioning and will work correctly withnin the Component rendering model. All container classes should subclass BoxComponent so that they will work consistently when nested within other Ext layout containers.

Properties   -  Methods   -  Events   -  Config Options

Public Properties

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.

Public Methods

Method Defined By
  BoxComponentExt.Element/String/Object config ) BoxComponent
  addEventsObject object ) : void Observable
Used to define events on this Observable
  addListenerString 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.
  fireEventString eventName, Object... args ) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  focusBoolean 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.
  hasListenerString 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.
  onString eventName, Function handler, [Object scope], [Object options] ) : void Observable
Appends an event handler to this element (shorthand for addListener)
  onPositionNumber 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...
  onResizeNumber 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
  removeListenerString 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.
  setDisabledBoolean disabled ) : void Component
Convenience function for setting disabled/enabled by boolean.
  setPagePositionNumber 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 ...
  setPositionNumber 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 ...
  setSizeNumber/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...
  setVisibleBoolean 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.
  unString eventName, Function handler, [Object scope] ) : void Observable
Removes a listener (shorthand for removeListener)
  updateBoxObject box ) : s BoxComponent
Sets the current box measurements of the component's underlying element.

Public Events

Event Defined By
  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.

Config Options

Config Options Defined By
  allowDomMove : Boolean Component
Whether the component can move the Dom node when rendering (defaults to true).
  disableClass : String Component
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
  hideMode : String Component
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...

Property Details

disabled

public Object disabled
true if this component is disabled. Read-only.
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

BoxComponent

public function BoxComponent( Ext.Element/String/Object config )
Parameters:
  • config : Ext.Element/String/Object
    The configuration options.

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)

    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:
  • void
This method is defined by Observable.

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.
Parameters:
  • None.
Returns:
  • void
This method is defined by Component.

disable

public function disable()
Disable this component.
Parameters:
  • None.
Returns:
  • Ext.Component
    this
This method is defined by Component.

enable

public function enable()
Enable this component.
Parameters:
  • None.
Returns:
  • Ext.Component
    this
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:
  • Ext.Component
    this
This method is defined by Component.

getBox

public function getBox( [Boolean local] )
Gets the current box measurements of the component's underlying element.
Parameters:
  • local : Boolean
    (optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:
  • s
    {Object} box An object in the format {x, y, width, height}
This method is defined by BoxComponent.

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.

getPosition

public function getPosition( [Boolean local] )
Gets the current XY position of the component's underlying element.
Parameters:
  • local : Boolean
    (optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:
  • Array
    The XY position of the element (e.g., [100, 200])
This method is defined by BoxComponent.

getSize

public function getSize()
Gets the current size of the component's underlying element.
Parameters:
  • None.
Returns:
  • Object
    An object containing the element's size {width: (element width), height: (element height)}
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
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:
  • Ext.Component
    this
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.

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 : Number
    The new x position
  • y : Number
    The new y position
Returns:
  • void
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 : Number
    The box-adjusted width that was set
  • adjHeight : Number
    The box-adjusted height that was set
  • rawWidth : Number
    The width that was originally specified
  • rawHeight : Number
    The height that was originally specified
Returns:
  • void
This method is defined by BoxComponent.

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.

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 : Number
    The new x position
  • y : Number
    The new y position
Returns:
  • s
    {Ext.BoxComponent} this
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 : Number
    The new left
  • top : Number
    The new top
Returns:
  • s
    {Ext.BoxComponent} this
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/Object
    The new width to set, or a size object in the format {width, height}
  • height : Number
    The new height to set (not required if a size object is passed as the first arg)
Returns:
  • Ext.BoxComponent
    this
This method is defined by BoxComponent.

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:
  • Ext.Component
    this
This method is defined by Component.

show

public function show()
Show this component.
Parameters:
  • None.
Returns:
  • Ext.Component
    this
This method is defined by Component.

syncSize

public function syncSize()
Force the component's size to recalculate based on the underlying element's current height and width.
Parameters:
  • None.
Returns:
  • s
    {Ext.BoxComponent} this
This method is defined by BoxComponent.

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.

updateBox

public function updateBox( Object box )
Sets the current box measurements of the component's underlying element.
Parameters:
  • box : Object
    An object in the format {x, y, width, height}
Returns:
  • s
    {Ext.BoxComponent} this
This method is defined by BoxComponent.

Event Details

beforedestroy

public event beforedestroy
Fires before the component is destroyed. Return false to stop the destroy.
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. Return false to stop the hide.
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. Return false to stop the render.
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. Return false to stop the show.
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.

move

public event move
Fires after the component is moved.
Subscribers will be called with the following parameters:
  • this : Ext.Component
  • x : Number
    The new x position
  • y : Number
    The new y position
This event is defined by BoxComponent.

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.

resize

public event resize
Fires after the component is resized.
Subscribers will be called with the following parameters:
  • this : Ext.Component
  • adjWidth : Number
    The box-adjusted width that was set
  • adjHeight : Number
    The box-adjusted height that was set
  • rawWidth : Number
    The width that was originally specified
  • rawHeight : Number
    The height that was originally specified
This event is defined by BoxComponent.

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

allowDomMove

allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
This config option is defined by Component.

disableClass

disableClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
This config option is defined by Component.

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.

Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.