GridView (Ext GWT 3.0.0-beta3 API)

java.lang.Object
- com.sencha.gxt.widget.core.client.grid.GridView<M>

Direct Known Subclasses:

GroupingView, LiveGridView, TreeGridView
```
public class GridView<M>
extends Object
```
This class encapsulates the user interface of an Grid. Methods of this class may be used to access user interface elements to enable special display effects. Do not change the DOM structure of the user interface.

This class does not provide ways to manipulate the underlying data. The data model of a Grid is held in a ListStore.

Constructor Summary

Constructors
Constructor and Description

GridView()

Constructors
Constructor and Description
`GridView()`

Method Summary

Methods
Modifier and Type	Method and Description
`Point`	`ensureVisible(int row, int col, boolean hscroll)` Ensured the current row and column is visible.
`Element`	`findCell(Element elem)` Returns the cell.
`int`	`findCellIndex(Element elem, String requiredStyle)` Returns the cell index.
`Element`	`findRow(Element el)` Returns the row element.
`int`	`findRowIndex(Element elem)` Returns the row index.
`void`	`focusCell(int rowIndex, int colIndex, boolean hscroll)` Focus the cell and scrolls into view.
`void`	`focusRow(int rowIndex)` Focus the row and scrolls into view.
`ColumnConfig<M,?>`	`getAutoExpandColumn()` Returns the auto expand column id.
`int`	`getAutoExpandMax()` Returns the auto expand maximum width.
`int`	`getAutoExpandMin()` Returns the auto expand minimum width.
`XElement`	`getBody()` Returns the grid's body element.
`Element`	`getCell(int row, int col)` Returns the grid's <TD> HtmlElement at the specified coordinates.
`int`	`getCellSelectorDepth()` Returns the cell selector depth.
`Element`	`getEditorParent()` Returns the editor parent element.
`String`	`getEmptyText()` Returns the empty text.
`ColumnHeader<M>`	`getHeader()` Returns the grid's column header.
`Element`	`getHeaderCell(int index)` Returns the <TD> HtmlElement which represents the Grid's header cell for the specified column index.
`Element`	`getInnerCellElement(int row, int col)` Returns the HtmlElement that represents a cell for the given row and column.
`Element`	`getRow(int row)` Return the <TR> HtmlElement which represents a Grid row for the specified index.
`Element`	`getRow(M m)` Return the <TR> HtmlElement which represents a Grid row for the specified model.
`int`	`getRowSelectorDepth()` Returns the row selector depth.
`XElement`	`getScroller()` Returns the scroll element.
`Point`	`getScrollState()` Returns the current scroll state.
`GridViewConfig<M>`	`getViewConfig()` Returns the view config.
`boolean`	`isAdjustForHScroll()` Returns true if the grid width will be adjusted based on visibility of horizontal scroll bar.
`boolean`	`isAutoFill()` Returns true if auto fill is enabled.
`boolean`	`isForceFit()` Returns true if force fit is enabled.
`boolean`	`isSelectableTarget(Element target)` Returns true if the given element is selectable.
`boolean`	`isShowDirtyCells()` Returns true if dirty cell markers are enabled.
`boolean`	`isSortingEnabled()` Returns true if sorting is enabled.
`void`	`layout()` Lays out the grid view, adjusting the header and footer width and accounting for force fit and auto fill settings.
`void`	`refresh(boolean headerToo)` Rebuilds the grid using its current configuration and data.
`void`	`scrollToTop()` Scrolls the grid to the top.
`void`	`setAdjustForHScroll(boolean adjustForHScroll)` True to adjust the grid width when the horizontal scrollbar is hidden and visible (defaults to true).
`void`	`setAutoExpandColumn(ColumnConfig<M,?> autoExpandColumn)` The id of a column in this grid that should expand to fill unused space (pre-render).
`void`	`setAutoExpandMax(int autoExpandMax)` The maximum width the autoExpandColumn can have (if enabled) (defaults to 500, pre-render).
`void`	`setAutoExpandMin(int autoExpandMin)` The minimum width the autoExpandColumn can have (if enabled)(pre-render).
`void`	`setAutoFill(boolean autoFill)` True to auto expand the columns to fit the grid when the grid is created.
`void`	`setCellSelectorDepth(int cellSelectorDepth)` The number of levels to search for cells in event delegation (defaults to 4).
`void`	`setEmptyText(String emptyText)` Default text to display in the grid body when no rows are available (defaults to '').
`void`	`setForceFit(boolean forceFit)` True to auto expand/contract the size of the columns to fit the grid width and prevent horizontal scrolling.
`void`	`setRowSelectorDepth(int rowSelectorDepth)` The number of levels to search for rows in event delegation (defaults to 10).
`void`	`setShowDirtyCells(boolean showDirtyCells)` True to display a red triangle in the upper left corner of any cells which are "dirty" as defined by any existing records in the data store (defaults to true).
`void`	`setSortingEnabled(boolean sortable)` True to allow column sorting when the user clicks a column (defaults to true).
`void`	`setViewConfig(GridViewConfig<M> viewConfig)` Sets the view config.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GridView
```
public GridView()
```
- Method Detail
  - ensureVisible
```
public Point ensureVisible(int row,
                  int col,
                  boolean hscroll)
```
    Ensured the current row and column is visible.
    
    Parameters:
    row - the row index
    col - the column index
    hscroll - true to scroll horizontally if needed
    
    Returns:
    the calculated point
  - findCell
```
public Element findCell(Element elem)
```
    Returns the cell.
    
    Parameters:
    elem - the cell element or a child element
    
    Returns:
    the cell element
  - findCellIndex
```
public int findCellIndex(Element elem,
                String requiredStyle)
```
    Returns the cell index.
    
    Parameters:
    elem - the cell or child element
    requiredStyle - an optional required style name
    
    Returns:
    the cell index or -1 if not found
  - findRow
```
public Element findRow(Element el)
```
    Returns the row element.
    
    Parameters:
    el - the row element or any child element
    
    Returns:
    the matching row element
  - findRowIndex
```
public int findRowIndex(Element elem)
```
    Returns the row index.
    
    Parameters:
    elem - the row or child of the row element
    
    Returns:
    the index
  - focusCell
```
public void focusCell(int rowIndex,
             int colIndex,
             boolean hscroll)
```
    Focus the cell and scrolls into view.
    
    Parameters:
    rowIndex - the row index
    colIndex - the column index
    hscroll - true to scroll horizontally
  - focusRow
```
public void focusRow(int rowIndex)
```
    Focus the row and scrolls into view.
    
    Parameters:
    rowIndex - the row index
  - getAutoExpandColumn
```
public ColumnConfig<M,?> getAutoExpandColumn()
```
    Returns the auto expand column id.
    
    Returns:
    the auto expand column id
  - getAutoExpandMax
```
public int getAutoExpandMax()
```
    Returns the auto expand maximum width.
    
    Returns:
    the max width in pixels
  - getAutoExpandMin
```
public int getAutoExpandMin()
```
    Returns the auto expand minimum width.
    
    Returns:
    the minimum width in pixels
  - getBody
```
public XElement getBody()
```
    Returns the grid's body element.
    
    Returns:
    the body element
  - getCell
```
public Element getCell(int row,
              int col)
```
    Returns the grid's <TD> HtmlElement at the specified coordinates.
    
    Parameters:
    row - the row index in which to find the cell
    col - the column index of the cell
    
    Returns:
    the <TD> at the specified coordinates
  - getCellSelectorDepth
```
public int getCellSelectorDepth()
```
    Returns the cell selector depth.
    
    Returns:
    the cell selector depth
  - getEditorParent
```
public Element getEditorParent()
```
    Returns the editor parent element.
    
    Returns:
    the editor element
  - getEmptyText
```
public String getEmptyText()
```
    Returns the empty text.
    
    Returns:
    the empty text
  - getHeader
```
public ColumnHeader<M> getHeader()
```
    Returns the grid's column header.
    
    Returns:
    the header
  - getHeaderCell
```
public Element getHeaderCell(int index)
```
    Returns the <TD> HtmlElement which represents the Grid's header cell for the specified column index.
    
    Parameters:
    index - the column index
    
    Returns:
    the <TD> element.
  - getInnerCellElement
```
public Element getInnerCellElement(int row,
                          int col)
```
    Returns the HtmlElement that represents a cell for the given row and column.
    
    Parameters:
    row - the row index
    col - the column index
    
    Returns:
    the cell element
  - getRow
```
public Element getRow(int row)
```
    Return the <TR> HtmlElement which represents a Grid row for the specified index.
    
    Parameters:
    row - the row index
    
    Returns:
    the <TR> element
  - getRow
```
public Element getRow(M m)
```
    Return the <TR> HtmlElement which represents a Grid row for the specified model.
    
    Parameters:
    m - the model
    
    Returns:
    the <TR> element
  - getRowSelectorDepth
```
public int getRowSelectorDepth()
```
    Returns the row selector depth.
    
    Returns:
    the row selector depth
  - getScroller
```
public XElement getScroller()
```
    Returns the scroll element.
    
    Returns:
    the scroll element
  - getScrollState
```
public Point getScrollState()
```
    Returns the current scroll state.
    
    Returns:
    the scroll state
  - getViewConfig
```
public GridViewConfig<M> getViewConfig()
```
    Returns the view config.
    
    Returns:
    the view config
  - isAdjustForHScroll
```
public boolean isAdjustForHScroll()
```
    Returns true if the grid width will be adjusted based on visibility of horizontal scroll bar.
    
    Returns:
    true if adjusting
  - isAutoFill
```
public boolean isAutoFill()
```
    Returns true if auto fill is enabled.
    
    Returns:
    true for auto fill
  - isForceFit
```
public boolean isForceFit()
```
    Returns true if force fit is enabled.
    
    Returns:
    true for force fit
  - isSelectableTarget
```
public boolean isSelectableTarget(Element target)
```
    Returns true if the given element is selectable.
    
    Parameters:
    target - the element to check
    
    Returns:
    true if the given element is selectable
  - isShowDirtyCells
```
public boolean isShowDirtyCells()
```
    Returns true if dirty cell markers are enabled.
    
    Returns:
    true of dirty cell markers
  - isSortingEnabled
```
public boolean isSortingEnabled()
```
    Returns true if sorting is enabled.
    
    Returns:
    true for sorting
  - layout
```
public void layout()
```
    Lays out the grid view, adjusting the header and footer width and accounting for force fit and auto fill settings.
  - refresh
```
public void refresh(boolean headerToo)
```
    Rebuilds the grid using its current configuration and data.
    
    Parameters:
    headerToo - true to refresh the header
  - scrollToTop
```
public void scrollToTop()
```
    Scrolls the grid to the top.
  - setAdjustForHScroll
```
public void setAdjustForHScroll(boolean adjustForHScroll)
```
    True to adjust the grid width when the horizontal scrollbar is hidden and visible (defaults to true).
    
    Parameters:
    adjustForHScroll - true to adjust for horizontal scroll bar
  - setAutoExpandColumn
```
public void setAutoExpandColumn(ColumnConfig<M,?> autoExpandColumn)
```
    The id of a column in this grid that should expand to fill unused space (pre-render). This id can not be 0.
    
    Parameters:
    autoExpandColumn - the auto expand column
  - setAutoExpandMax
```
public void setAutoExpandMax(int autoExpandMax)
```
    The maximum width the autoExpandColumn can have (if enabled) (defaults to 500, pre-render).
    
    Parameters:
    autoExpandMax - the auto expand max
  - setAutoExpandMin
```
public void setAutoExpandMin(int autoExpandMin)
```
    The minimum width the autoExpandColumn can have (if enabled)(pre-render).
    
    Parameters:
    autoExpandMin - the auto expand min width
  - setAutoFill
```
public void setAutoFill(boolean autoFill)
```
    True to auto expand the columns to fit the grid when the grid is created.
    
    Parameters:
    autoFill - true to expand
  - setCellSelectorDepth
```
public void setCellSelectorDepth(int cellSelectorDepth)
```
    The number of levels to search for cells in event delegation (defaults to 4).
    
    Parameters:
    cellSelectorDepth - the cell selector depth
  - setEmptyText
```
public void setEmptyText(String emptyText)
```
    Default text to display in the grid body when no rows are available (defaults to '').
    
    Parameters:
    emptyText - the empty text
  - setForceFit
```
public void setForceFit(boolean forceFit)
```
    True to auto expand/contract the size of the columns to fit the grid width and prevent horizontal scrolling.
    
    Parameters:
    forceFit - true to force fit
  - setRowSelectorDepth
```
public void setRowSelectorDepth(int rowSelectorDepth)
```
    The number of levels to search for rows in event delegation (defaults to 10).
    
    Parameters:
    rowSelectorDepth - the row selector depth
  - setShowDirtyCells
```
public void setShowDirtyCells(boolean showDirtyCells)
```
    True to display a red triangle in the upper left corner of any cells which are "dirty" as defined by any existing records in the data store (defaults to true).
    
    Parameters:
    showDirtyCells - true to display the dirty flag
  - setSortingEnabled
```
public void setSortingEnabled(boolean sortable)
```
    True to allow column sorting when the user clicks a column (defaults to true).
    
    Parameters:
    sortable - true for sortable columns
  - setViewConfig
```
public void setViewConfig(GridViewConfig<M> viewConfig)
```
    Sets the view config.
    
    Parameters:
    viewConfig - the view config

Class GridView<M>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GridView

Method Detail

ensureVisible

findCell

findCellIndex

findRow

findRowIndex

focusCell

focusRow

getAutoExpandColumn

getAutoExpandMax

getAutoExpandMin

getBody

getCell

getCellSelectorDepth

getEditorParent

getEmptyText

getHeader

getHeaderCell

getInnerCellElement

getRow

getRow

getRowSelectorDepth

getScroller

getScrollState

getViewConfig

isAdjustForHScroll

isAutoFill

isForceFit

isSelectableTarget

isShowDirtyCells

isSortingEnabled

layout

refresh

scrollToTop

setAdjustForHScroll

setAutoExpandColumn

setAutoExpandMax

setAutoExpandMin

setAutoFill

setCellSelectorDepth

setEmptyText

setForceFit

setRowSelectorDepth

setShowDirtyCells

setSortingEnabled

setViewConfig