atg.svc.agent.ui.tables
Class GridConfiguration

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.svc.agent.ui.tables.TableConfiguration
              atg.svc.agent.ui.tables.GridConfiguration

All Implemented Interfaces:

atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging

public class GridConfiguration
extends TableConfiguration

The GridConfiguration class manages configuration for an instance of a UI grid. The goal of this feature is to allow ATG customers to extend the Grid controls (scrollable tables that are used to present and sort data throughout CSC) and provide support for additional columns and fields specific to an implementation as well as allow other columns that are not needed to be removed. Grid configuration manages the preservation of configurations and during the migration process between releases. Another goal of this feature is to define a methodology to incorporate customer-specific JSP fragments into the existing CSC grids � without having to edit any of the OTB CSC pages. Grid component configuration is managed through the application configuration layer and JSP fragments. To avoid migration issues, it is best to override both of these components in a separate application module dedicated to customizations. The configuration files for managing grids are located at: /atg/commerce/csr/ui/tables/order /atg/commerce/csr/ui/tables/customer /atg/commerce/csr/ui/tables/tickets The JSP fragments are found in various places under the web application root. Set the grid height in the grid properties file under /atg/commerce/custsvc/ui/tables. To add a column: 1. For the new column that is going to be added, follow the steps above to customize column content. Instead of opening an existing column configuration file, create a new properties file for the column. 2. Set the column properties as needed. 3. Open the properties file for the grid under /atg/commerce/custsvc/ui/tables and insert the column using the full nucleus path to the column configuration component in the desired location in the columns list. To remove a column: 1. Open the properties file for the grid under /atg/commerce/custsvc/ui/tables and delete the column component from the columns list. To reorder columns: 1. Open the properties file for the grid under /atg/commerce/custsvc/ui/tables and reorder the column components within the columns list. Here is a sample grid configuration 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/DBState rowsPerPage=10 formHandlerPath=/atg/commerce/custsvc/order/OrderHistoryTableFormHandler gridHeight=450px gridInstanceId=atg.commerce.csr.order.historyGridInstance gridWidgetId=atg_commerce_csr_customer_order_searchResultsTable progressNodeId=atg_commerce_csr_order_resultsGridStatus searchFormId=orderHistoryListForm dataModelPage=/atg/commerce/custsvc/ui/tables/order/OrderDataPage itemDetailPage=/atg/commerce/custsvc/ui/tables/order/OrderDetailPage

Field Summary

static java.lang.String	CLASS_VERSION
protected atg.web.PageFragment	mDataModelPage The page fragment containing the data model (e.g.
protected java.lang.String	mDetailFormId The DOM ID of the form node to submit to retrieve an item detail.
protected java.lang.String	mGridHeight The value assigned to the height CSS style for the table determining its visible height.
protected java.lang.String	mGridInstanceId The JavaScript variable name, should be unique for each instance of the table in the application.
protected atg.web.PageFragment	mGridPage The page fragment containing the grid implementation.
protected java.lang.String	mGridPath The nucleus path to the grid configuration component.
protected java.lang.String	mGridWidgetId The dojo ID of the table widget, should be unique for each instance of the table in the application.
protected atg.web.PageFragment	mItemDetailPage The page fragment containing the item details
protected java.lang.String	mPageBaseOffset The base of the paging: 0 for 0-based paging, 1 for 1-based paging, etc.
protected java.lang.String	mPageIndexElementName The element name of the page index form input
protected java.lang.String	mProgressNodeId The optional ID for a DOM node to render status messages, such as 'search in progress...' or 'No results found.' etc
protected java.lang.String	mSearchFormId The DOM ID of the form node to submit to retrieve orders
protected java.lang.String	mSelectLink Anchor tag template with pattern replacement for selecting the item in the application
protected java.lang.String	mViewLink Anchor tag template with pattern replacement for viewing the item in the application

Fields inherited from class atg.svc.agent.ui.tables.TableConfiguration

mColumns, mDefaultSortDirection, mDefaultSortField, mFormHandlerPath, mImageClosed, mImageOpen, mImagePath, mRowsPerPage, mTablePage, mTablePath

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

GridConfiguration()

Method Summary

atg.web.PageFragment	getDataModelPage()
java.lang.String	getDetailFormId()
java.lang.String	getGridHeight()
java.lang.String	getGridInstanceId()
atg.web.PageFragment	getGridPage()
java.lang.String	getGridPath()
java.lang.String	getGridWidgetId()
atg.web.PageFragment	getItemDetailPage()
java.lang.String	getPageBaseOffset()
java.lang.String	getPageIndexElementName()
java.lang.String	getProgressNodeId()
java.lang.String	getSearchFormId()
java.lang.String	getSelectLink()
java.lang.String	getViewLink()
void	setDataModelPage(atg.web.PageFragment pDataModelPage)
void	setDetailFormId(java.lang.String pDetailFormId)
void	setGridHeight(java.lang.String pGridHeight)
void	setGridInstanceId(java.lang.String pGridInstanceId)
void	setGridPage(atg.web.PageFragment pGridPage)
void	setGridPath(java.lang.String pGridPath)
void	setGridWidgetId(java.lang.String pGridWidgetId)
void	setItemDetailPage(atg.web.PageFragment pItemDetailPage)
void	setPageBaseOffset(java.lang.String pPageBaseOffset)
void	setPageIndexElementName(java.lang.String pPageIndexElementName)
void	setProgressNodeId(java.lang.String pProgressNodeId)
void	setSearchFormId(java.lang.String pSearchFormId)
void	setSelectLink(java.lang.String pSelectLink)
void	setViewLink(java.lang.String pViewLink)

Methods inherited from class atg.svc.agent.ui.tables.TableConfiguration

getColumns, getDefaultSortDirection, getDefaultSortField, getFormHandlerPath, getImageClosed, getImageOpen, getImagePath, getRowsPerPage, getTablePage, getTablePath, setColumns, setDefaultSortDirection, setDefaultSortField, setFormHandlerPath, setImageClosed, setImageOpen, setImagePath, setRowsPerPage, setTablePage, setTablePath

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLoggingIdentifier, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingIdentifier, setLoggingInfo, setLoggingTrace, setLoggingWarning

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

mDetailFormId

protected java.lang.String mDetailFormId

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

mGridHeight

protected java.lang.String mGridHeight

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

mGridInstanceId

protected java.lang.String mGridInstanceId

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

mGridPath

protected java.lang.String mGridPath

The nucleus path to the grid configuration component.

mGridWidgetId

protected java.lang.String mGridWidgetId

The dojo ID of the table widget, should be unique for each instance of the table in the application.

mPageBaseOffset

protected java.lang.String mPageBaseOffset

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

mPageIndexElementName

protected java.lang.String mPageIndexElementName

The element name of the page index form input

mProgressNodeId

protected java.lang.String mProgressNodeId

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

mSearchFormId

protected java.lang.String mSearchFormId

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

mSelectLink

protected java.lang.String mSelectLink

Anchor tag template with pattern replacement for selecting the item in the application

mViewLink

protected java.lang.String mViewLink

Anchor tag template with pattern replacement for viewing the item in the application

mGridPage

protected atg.web.PageFragment mGridPage

The page fragment containing the grid implementation.

mItemDetailPage

protected atg.web.PageFragment mItemDetailPage

The page fragment containing the item details

mDataModelPage

protected atg.web.PageFragment mDataModelPage

The page fragment containing the data model (e.g. JSON)

Constructor Detail

GridConfiguration

public GridConfiguration()

Method Detail

getDetailFormId

public java.lang.String getDetailFormId()

setDetailFormId

public void setDetailFormId(java.lang.String pDetailFormId)

getGridHeight

public java.lang.String getGridHeight()

setGridHeight

public void setGridHeight(java.lang.String pGridHeight)

getGridInstanceId

public java.lang.String getGridInstanceId()

setGridInstanceId

public void setGridInstanceId(java.lang.String pGridInstanceId)

getGridPath

public java.lang.String getGridPath()

setGridPath

public void setGridPath(java.lang.String pGridPath)

getGridWidgetId

public java.lang.String getGridWidgetId()

setGridWidgetId

public void setGridWidgetId(java.lang.String pGridWidgetId)

getPageBaseOffset

public java.lang.String getPageBaseOffset()

setPageBaseOffset

public void setPageBaseOffset(java.lang.String pPageBaseOffset)

getPageIndexElementName

public java.lang.String getPageIndexElementName()

setPageIndexElementName

public void setPageIndexElementName(java.lang.String pPageIndexElementName)

getProgressNodeId

public java.lang.String getProgressNodeId()

setProgressNodeId

public void setProgressNodeId(java.lang.String pProgressNodeId)

getSearchFormId

public java.lang.String getSearchFormId()

setSearchFormId

public void setSearchFormId(java.lang.String pSearchFormId)

getSelectLink

public java.lang.String getSelectLink()

setSelectLink

public void setSelectLink(java.lang.String pSelectLink)

getViewLink

public java.lang.String getViewLink()

setViewLink

public void setViewLink(java.lang.String pViewLink)

getGridPage

public atg.web.PageFragment getGridPage()

setGridPage

public void setGridPage(atg.web.PageFragment pGridPage)

getItemDetailPage

public atg.web.PageFragment getItemDetailPage()

setItemDetailPage

public void setItemDetailPage(atg.web.PageFragment pItemDetailPage)

getDataModelPage

public atg.web.PageFragment getDataModelPage()

setDataModelPage

public void setDataModelPage(atg.web.PageFragment pDataModelPage)