The GridConfiguration object is located in ATG Service Agent classes and extends the TableConfiguration class. The columns are defined in order in an array of ColumnConfiguration components. The properties for GridConfiguration are:

Property

Description

columns

The array of ColumnConfiguration components that specify the columns for the grid in display order

dataModelPage

The page fragment component that contains the data model (for example, JSON). Include the full Nucleus path to the component

detailFormId

The DOM ID of the form node to submit to retrieve an item detail

formHandlerPath

The Nucleus path to the form handler that renders the results

gridHeight

The value assigned to the height CSS style for the table to determine its visible height.

gridInstanceId

The JavaScript variable name that should be unique for each instance of the table in the application

gridPage

The page fragment containing the grid implementation

gridPath

The Nucleus path to the grid configuration component

gridWidgetId

The Dojo ID of the table widget that should be unique for each instance of the table in the application

imageClosed

The file name of image to render when the grid item detail is not visible or closed

imageOpen

The file name of image to render when the grid item detail is visible or open

imagePath

The URL path to the images

itemDetailPage

The page fragment component containing the item details (currently implemented as a hover popup)

pageBaseOffset

The base of the paging: 0 for 0-based paging, 1 for 1-based paging, etc.

pageIndexElementName

The element name of the page index form input

progressNodeId

The optional ID for a DOM node to render status messages, such as ‘search in progress...’ or ‘No results found.’ etc.

rowsPerPage

The size of the result to send back from the form handler in each page

searchFormId

The DOM ID of the form node to submit to retrieve orders

selectLink

An anchor tag template with pattern replacement for selecting the item in the application

viewLink

An anchor tag template with pattern replacement for viewing the item in the application

The following is an example of the /atg/commerce/custsvc/ui/tables/order/
OrderHistoryGrid.properties
file:

$class=atg.svc.agent.ui.tables.GridConfiguration
# invisible data columns: DBState

columns=\
     /atg/commerce/custsvc/ui/tables/order/Toggle,\
     /atg/commerce/custsvc/ui/tables/order/ViewLink,\
     /atg/commerce/custsvc/ui/tables/order/Total,\
     /atg/commerce/custsvc/ui/tables/order/ItemCount,\
     /atg/commerce/custsvc/ui/tables/order/ItemSummary,\
     /atg/commerce/custsvc/ui/tables/order/SubmittedDate,\
     /atg/commerce/custsvc/ui/tables/order/Origin,\
     /atg/commerce/custsvc/ui/tables/order/State,\
     /atg/commerce/custsvc/ui/tables/order/SelectLink,\
     /atg/commerce/custsvc/ui/tables/order/ID,\
     /atg/commerce/custsvc/ui/tables/order/DBState

rowsPerPage=10

formHandlerPath=/atg/commerce/custsvc/order/OrderHistoryTableFormHandler

gridHeight=450px
gridInstanceId=atg.commerce.csr.order.historyGridInstance
gridPath=/atg/commerce/custsvc/ui/tables/order/OrderHistoryGrid
gridWidgetId=atg_commerce_csr_customer_order_searchResultsTable
progressNodeId=atg_commerce_csr_order_resultsGridStatus
searchFormId=orderHistoryListForm

dataModelPage=/atg/commerce/custsvc/ui/tables/order/OrderDataPage
gridPage=/atg/commerce/custsvc/ui/tables/order/OrderGridPage
itemDetailPage=/atg/commerce/custsvc/ui/tables/order/OrderDetailPage
 
loading table of contents...