The ColumnConfiguration
object is located in atg.svc.agent.ui.tables
, and manages column configuration for an instance of a UI grid.
Dojo Grid Column Configuration
The properties for ColumnConfiguration
within Dojo are:
Property | Description |
---|---|
| The page fragment component that can contain a client-side JavaScript function to render the cell contents. Includes the full Nucleus path to the component. |
| The page fragment component that returns server-side data in JSON that inserts a cell. Includes the full Nucleus path to the component. |
| Is set to either ascending or descending sorting or left blank for no sorting. |
| The field name identifier for the data to render in the column from the data model. UI-only columns without a backing data representation should leave the field parameter undefined. |
| The name of the data model field on which to sort, which is different than |
| Whether to display the column in the UI or only to send back the data for the column. This is useful for JavaScript widgets that store invisible column data for other columns. For example, an |
| The resource bundle that contains the column display name. |
| The key that references the column display name in the resource bundle. |
| The extent of the column using the Dojo-grid syntax (e.g. ‘5em’ or ‘auto’). |
| The column CSS styles. Note: Styles are not modifiable for tables. |
The following is an example of the /atg/commerce/custsvc/ui/tables/order/
column configuration:
ViewLink.properties
$class=atg.svc.agent.ui.tables.ColumnConfiguration defaultSort=ascending field=viewLink sortField=id width=4em resourceBundle=atg.commerce.csr.Messages resourceKey=view-order isVisible=true dataRendererPage=/atg/commerce/custsvc/ui/tables/order/ColumnRendererPage
HTML Table Column Configuration
The properties for ColumnConfiguration
using an HTML table are:
Property | Description |
---|---|
| The page fragment component that returns server-side data in JSON that inserts a cell. Includes the full Nucleus path to the component |
| The field name identifier for the data to render in the column from the data model. UI-only columns without a backing data representation should leave the field parameter undefined. |
| Whether to display the column in the UI or only to send back the data for the column. This is useful for JavaScript widgets that store invisible column data for other columns. For example, an |
| The resource bundle that contains the column display name |
| The key that references the column display name in the resource bundle |
| The extent of the column using the Dojo-grid syntax (e.g. ‘5em’ or ‘auto’) |
The following is an example of the /atg/commerce/custsvc/ui/tables/ticket/
column configuration:
LastName.properties
$class=atg.svc.agent.ui.tables.ColumnConfiguration field=lastName width=10% resourceBundle=atg.svc.agent.WebAppResources resourceKey=relatedTickets.lastName isVisible=true dataRendererPage=/atg/commerce/custsvc/ui/tables/ticket/ColumnRendererPage