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

cellRendererPage

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.

dataRendererPage

The page fragment component that returns server-side data in JSON that inserts a cell. Includes the full Nucleus path to the component.

defaultSort

Is set to either ascending or descending sorting or left blank for no sorting.

field

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.

sortField

The name of the data model field on which to sort, which is different than field. If this property is undefined and sorting is enabled using defaultSort, the data is sorted on the field property. If this property is defined and sorting is enabled using defaultSort, the data is sorted on the sortField property. This property allows a column to contain rendering and markup that does not interfere with the sorting of the field. For example, the ViewLink column can have a link to view an item where the column is not sorted on the link markup, but on a separate corresponding data value.

isVisible

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 onClick function in the ID field can use an invisible DBState field to identify what to do when an order is opened.

resourceBundle

The resource bundle that contains the column display name.

resourceKey

The key that references the column display name in the resource bundle.

width

The extent of the column using the Dojo-grid syntax (e.g. ‘5em’ or ‘auto’).

styles

The column CSS styles. Note: Styles are not modifiable for tables.

The following is an example of the /atg/commerce/custsvc/ui/tables/order/
ViewLink.properties
column configuration:

$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

dataRendererPage

The page fragment component that returns server-side data in JSON that inserts a cell. Includes the full Nucleus path to the component

field

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.

isVisible

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 onClick function in the ID field can use an invisible DBState field to identify what to do when an order is opened.

resourceBundle

The resource bundle that contains the column display name

resourceKey

The key that references the column display name in the resource bundle

width

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/
LastName.properties
column configuration:

$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

Copyright © 1997, 2013 Oracle and/or its affiliates. All rights reserved. Legal Notices