Print Friendly

Class Ext.grid.GridView

Package:Ext.grid
Class:GridView
Extends:Observable
Defined In:GridView.js

Properties   -  Methods   -  Events

Public Properties

This class has no public properties.

Public Methods

Method Defined By
  GridViewObject config ) GridView
  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
  autoSizeColumnNumber colIndex, Boolean forceMinSize ) : void GridView
Autofit a column to its content.
  autoSizeColumns() : void GridView
Autofits all columns to their content and then expands to fit any extra space in the grid
  ensureVisibleNumber row, Number col, Boolean hscroll ) : void GridView
Scrolls the specified cell into view
  fireEventString eventName, Object... args ) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  fitColumnsBoolean reserveScrollSpace ) : void GridView
Autofits all columns to the grid's width proportionate with their current size
  focusCellNumber row, Number col, Boolean hscroll ) : void GridView
Focuses the specified cell.
  focusRowNumber row ) : void GridView
Focuses the specified row.
  getFooterPanelBoolean doShow ) : Ext.Element GridView
Gets a panel in the footer of the grid that can be used for toolbars etc. After modifying the contents of this panel ...
  getHeaderPanelBoolean doShow ) : Ext.Element GridView
Gets a panel in the header of the grid that can be used for toolbars etc. After modifying the contents of this panel ...
  getRowClassRecord record, Number index ) : void GridView
Override this function to apply custom css classes to rows during rendering
  hasListenerString eventName ) : Boolean Observable
Checks to see if this object has any listeners for a specified event
  onString 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
  refreshBoolean headersToo ) : void GridView
Refreshes the grid
  removeListenerString eventName, Function handler, [Object scope] ) : void Observable
Removes a listener
  scrollToTop() : void GridView
Scrolls the grid to the top
  unString eventName, Function handler, [Object scope] ) : void Observable
Removes a listener (shorthand for removeListener)

Public Events

This class has no public events.

Constructor Details

GridView

public function GridView( Object config )
Parameters:
  • config : Object

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.

autoSizeColumn

public function autoSizeColumn( Number colIndex, Boolean forceMinSize )
Autofit a column to its content.
Parameters:
  • colIndex : Number
  • forceMinSize : Boolean
    true to force the column to go smaller if possible
Returns:
  • void
This method is defined by GridView.

autoSizeColumns

public function autoSizeColumns()
Autofits all columns to their content and then expands to fit any extra space in the grid
Parameters:
  • None.
Returns:
  • void
This method is defined by GridView.

ensureVisible

public function ensureVisible( Number row, Number col, Boolean hscroll )
Scrolls the specified cell into view
Parameters:
  • row : Number
    The row index
  • col : Number
    The column index
  • hscroll : Boolean
    false to disable horizontal scrolling
Returns:
  • void
This method is defined by GridView.

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.

fitColumns

public function fitColumns( Boolean reserveScrollSpace )
Autofits all columns to the grid's width proportionate with their current size
Parameters:
  • reserveScrollSpace : Boolean
    Reserve space for a scrollbar
Returns:
  • void
This method is defined by GridView.

focusCell

public function focusCell( Number row, Number col, Boolean hscroll )
Focuses the specified cell.
Parameters:
  • row : Number
    The row index
  • col : Number
    The column index
  • hscroll : Boolean
    false to disable horizontal scrolling
Returns:
  • void
This method is defined by GridView.

focusRow

public function focusRow( Number row )
Focuses the specified row.
Parameters:
  • row : Number
    The row index
Returns:
  • void
This method is defined by GridView.

getFooterPanel

public function getFooterPanel( Boolean doShow )
Gets a panel in the footer of the grid that can be used for toolbars etc. After modifying the contents of this panel a call to grid.autoSize() may be required to register any changes in size.
Parameters:
  • doShow : Boolean
    By default the footer is hidden. Pass true to show the panel
Returns:
  • Ext.Element
This method is defined by GridView.

getHeaderPanel

public function getHeaderPanel( Boolean doShow )
Gets a panel in the header of the grid that can be used for toolbars etc. After modifying the contents of this panel a call to grid.autoSize() may be required to register any changes in size.
Parameters:
  • doShow : Boolean
    By default the header is hidden. Pass true to show the panel
Returns:
  • Ext.Element
This method is defined by GridView.

getRowClass

public function getRowClass( Record record, Number index )
Override this function to apply custom css classes to rows during rendering
Parameters:
  • record : Record
    The record
  • index : Number
Returns:
  • void
This method is defined by GridView.

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.

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.

refresh

public function refresh( Boolean headersToo )
Refreshes the grid
Parameters:
  • headersToo : Boolean
Returns:
  • void
This method is defined by GridView.

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.

scrollToTop

public function scrollToTop()
Scrolls the grid to the top
Parameters:
  • None.
Returns:
  • void
This method is defined by GridView.

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.

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