GridPanel

A GridPanel is a XVW component that's used to display (in a tabular form) a list of items (provided by a data source). It provides built-in mechanisms to sort, group the data, etc. The items in a GridPanel are paginated by default (50 items per page)

Items in the table can be selected and clicked which can in turn trigger specific actions (such as opening a new window when double clicking a given row in the table)

A GridPanel should be used inside a Panel component.

XML Definition

A GridPanel is declared as following:

<xvw:gridPanel 
 datasource="#{viewBean.dataSource}"
 ...
 otherAttributes
 ...
>

</xvw:gridPanel>

Component from which the Grid Panel Extends

• None

Components that Extend Grid Panel

• List
• Bridge
• GridExplorer

GridPanel Properties

currentSortTerms='NAME_OF_COLUMN_IN_GRID_PANEL'|desc

HashMap<String, ArrayList<String>>

HashMap<String,String>

Possible Child Components:

• ColumnAttribute (to choose which columns should appear in the table)
• GridNavBar (to choose if a given number of options should be present in the bottom navigational bar of the GridPanel)
• ToolBar (Each GridPanel has a default toolbar wich can be overriden)

Property DataSource:

XEOObjectListConnector: The XEOObjectListConnector receives a boObjectList as an argument of the contructor and can be used to incorporate any list of boObjects in the GridPanel

XEOBridgeListConnector: The XEOBridgeListConnector receives a bridgeHandler as an argument of the constructor and can be used to display a bridge of objects in the GridPanel.

Example: Imagine that we want to display all instances of the system model "Ebo_Perf" in a given GridPanel, the dataSource property of the Bean could be a method like this:

public DataListConnector getDataSource()
{
      String boql = 'select Ebo_Perf';
      boObjectList listOfUsers = boObjectList.list(getEboContext(), boql);
      return new XEOObjectListConnector(listOfUsers);

}

Aggregating Numeric Column Values

If you want to aggregate numeric columns in a GridPanel you must do the following:

1. Set the enableAggregate property to true
2. Set the enableAggregate property to true in the xvw:columnAttribute/xeo:columnAttribute component which is to the aggregated to true. The column must be a numeric type

Example XML declaration

<xvw:gridPanel enableGroupBy="true" enableAggregate="true">
    <xvw:columnAttribute dataField="NUMERIC_FIELD" enableAggregate="true" />
</xvw:gridPanel>

You can aggregate by four different functions: Average, Minimum, Maximum and Sum.

WORK_IN_PROGRESS