atg.svc.agent.ui.tables
Class TableConfiguration

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GridConfiguration

public class TableConfiguration
extends atg.nucleus.logging.ApplicationLoggingImpl

The TableConfiguration class manages configuration for an instance of a UI table. Table 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 tables are located at: Order Search: /atg/commerce/custsvc/order/OrderSearchUIConfiguration Customer Profile Search: /atg/svc/agent/ui/CustomerProfileSearchUIConfiguration The JSP fragments are found in various places under the web application root. To add a column to the order search results table: 1. For the new column that is going to be added, follow the steps to create a new column configuration component. 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 order table under /atg/commerce/custsvc/order/OrderSearchUIConfiguration 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 from the order search results table: 1. Open the properties file for the table under /atg/commerce/custsvc/order/OrderSearchUIConfiguration and delete the column component from the columns list. To reorder order search columns: 1. Open the properties file for the table under /atg/commerce/custsvc/order/OrderSearchUIConfiguration and reorder the column components within the columns list. Here is a sample table configuration file for order search: $class=atg.svc.agent.ui.tables.TableConfiguration columns=\ /atg/commerce/custsvc/ui/tables/order/search/Toggle,\ /atg/commerce/custsvc/ui/tables/order/search/ViewLink,\ /atg/commerce/custsvc/ui/tables/order/search/LastName,\ /atg/commerce/custsvc/ui/tables/order/search/FirstName,\ /atg/commerce/custsvc/ui/tables/order/search/Total,\ /atg/commerce/custsvc/ui/tables/order/search/ItemsReturned,\ /atg/commerce/custsvc/ui/tables/order/search/DateSubmitted,\ /atg/commerce/custsvc/ui/tables/order/search/Originator,\ /atg/commerce/custsvc/ui/tables/order/search/State,\ /atg/commerce/custsvc/ui/tables/order/search/WorkOn imageClosed=icon_find.gif imageOpen=icon_find.gif imagePath=/images/icons/ rowsPerPage=10 defaultSortField^=/atg/svc/agent/ui/tables/customer/ViewLink.sortField defaultSortDirection^=/atg/svc/agent/ui/tables/customer/ViewLink.defaultSort tablePath=/atg/commerce/custsvc/order/OrderSearchUIConfiguration tablePage=/atg/commerce/custsvc/ui/tables/order/search/OrderSearchTablePage

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected ColumnConfiguration[]	mColumns This array contains the columns for the table in display order.
protected java.lang.String	mDefaultSortDirection The default sort direction either ascending or descending
protected java.lang.String	mDefaultSortField The default field to sort on
protected java.lang.String	mFormHandlerPath The nucleus path to the form handler to render the results.
protected java.lang.String	mImageClosed The file name of image to render when the grid item detail is not visible or closed.
protected java.lang.String	mImageOpen The file name of image to render when the table item detail is visible or open.
protected java.lang.String	mImagePath The URL path to the images.
protected java.lang.String	mRowsPerPage The size of the result set to send back from the form handler in each page.
protected atg.web.PageFragment	mTablePage The page fragment containing the table implementation.
protected java.lang.String	mTablePath The nucleus path to the table configuration component.

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

TableConfiguration()

TableConfiguration(java.lang.String loggingIdentifier)

TableConfiguration(java.lang.String loggingIdentifier, boolean autoInitListeners)

Method Summary

ColumnConfiguration[]	getColumns() Returns the array of columns
java.lang.String	getDefaultSortDirection() Returns the default sort direction
java.lang.String	getDefaultSortField() Returns the default sort field
java.lang.String	getFormHandlerPath() Returns the nucleus path to the form handler to render the results
java.lang.String	getImageClosed() Returns the file name of image
java.lang.String	getImageOpen() Returns the file name of image
java.lang.String	getImagePath() Returns the path to the images
java.lang.String	getRowsPerPage() Returns the number of rows that should be displayed in the table
atg.web.PageFragment	getTablePage() Returns the tablePage configuration.
java.lang.String	getTablePath() Returns the path to the table configuration component
void	setColumns(ColumnConfiguration[] pColumns) Sets the columns array
void	setDefaultSortDirection(java.lang.String pDefaultSortDirection) Sets the default sort direction
void	setDefaultSortField(java.lang.String pDefaultSortField) Sets the default sort field
void	setFormHandlerPath(java.lang.String pFormHandlerPath) Sets the nucleus path to the form handler to render the results
void	setImageClosed(java.lang.String pImageClosed) Sets the file name of image
void	setImageOpen(java.lang.String pImageOpen) Sets the file name of the image
void	setImagePath(java.lang.String pImagePath) Sets the path to the images
void	setRowsPerPage(java.lang.String pRowsPerPage) Sets the number of rows of search results to display
void	setTablePage(atg.web.PageFragment pTablePage) Sets the tablePage
void	setTablePath(java.lang.String pTablePath) Sets the tablePath

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

Class version string

See Also:

Constant Field Values

mColumns

protected ColumnConfiguration[] mColumns

This array contains the columns for the table in display order.

mFormHandlerPath

protected java.lang.String mFormHandlerPath

The nucleus path to the form handler to render the results.

mImageClosed

protected java.lang.String mImageClosed

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

mImageOpen

protected java.lang.String mImageOpen

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

mImagePath

protected java.lang.String mImagePath

The URL path to the images.

mTablePath

protected java.lang.String mTablePath

The nucleus path to the table configuration component.

mTablePage

protected atg.web.PageFragment mTablePage

The page fragment containing the table implementation.

mRowsPerPage

protected java.lang.String mRowsPerPage

The size of the result set to send back from the form handler in each page. This specifies how many search items the form handler should return per search result page.

mDefaultSortField

protected java.lang.String mDefaultSortField

The default field to sort on

mDefaultSortDirection

protected java.lang.String mDefaultSortDirection

The default sort direction either ascending or descending

Constructor Detail

TableConfiguration

public TableConfiguration()

TableConfiguration

public TableConfiguration(java.lang.String loggingIdentifier)

TableConfiguration

public TableConfiguration(java.lang.String loggingIdentifier,
                          boolean autoInitListeners)

Method Detail

getColumns

public ColumnConfiguration[] getColumns()

Returns the array of columns

Returns:

Array The columns

setColumns

public void setColumns(ColumnConfiguration[] pColumns)

Sets the columns array

Parameters:

pColumns - Array of columns

getFormHandlerPath

public java.lang.String getFormHandlerPath()

Returns the nucleus path to the form handler to render the results

Returns:

String The nucleus path to the form handler to render the results

setFormHandlerPath

public void setFormHandlerPath(java.lang.String pFormHandlerPath)

Sets the nucleus path to the form handler to render the results

Parameters:

pFormHandlerPath - The nucleus path to the form handler to render the results

getImageClosed

public java.lang.String getImageClosed()

Returns the file name of image

Returns:

String The file name of image

setImageClosed

public void setImageClosed(java.lang.String pImageClosed)

Sets the file name of image

Parameters:

pImageClosed - The file name of image

getImageOpen

public java.lang.String getImageOpen()

Returns the file name of image

Returns:

String The file name of image

setImageOpen

public void setImageOpen(java.lang.String pImageOpen)

Sets the file name of the image

Parameters:

pImageOpen - The file name of the image

getImagePath

public java.lang.String getImagePath()

Returns the path to the images

Returns:

String The path to the images

setImagePath

public void setImagePath(java.lang.String pImagePath)

Sets the path to the images

Parameters:

pImagePath - The path to the images

getTablePath

public java.lang.String getTablePath()

Returns the path to the table configuration component

Returns:

String The nucleus path to the table configuration component

setTablePath

public void setTablePath(java.lang.String pTablePath)

Sets the tablePath

Parameters:

pTablePath - The nucleus path to the table configuration component

getTablePage

public atg.web.PageFragment getTablePage()

Returns the tablePage configuration. The tablePage component should point to the page fragment that sets the JSP for the results table

Returns:

PageFragment

setTablePage

public void setTablePage(atg.web.PageFragment pTablePage)

Sets the tablePage

Parameters:

pTablePage - The page fragment component that points to the JSP for the results table

getRowsPerPage

public java.lang.String getRowsPerPage()

Returns the number of rows that should be displayed in the table

Returns:

String value of the number of rows that should be displayed

setRowsPerPage

public void setRowsPerPage(java.lang.String pRowsPerPage)

Sets the number of rows of search results to display

Parameters:

pRowsPerPage - value of the number of rows of search results to display

getDefaultSortField

public java.lang.String getDefaultSortField()

Returns the default sort field

Returns:

String value of the default sort field

setDefaultSortField

public void setDefaultSortField(java.lang.String pDefaultSortField)

Sets the default sort field

Parameters:

pDefaultSortField - value of the default sort field

getDefaultSortDirection

public java.lang.String getDefaultSortDirection()

Returns the default sort direction

Returns:

the default sort direction

setDefaultSortDirection

public void setDefaultSortDirection(java.lang.String pDefaultSortDirection)

Sets the default sort direction

Parameters:

pDefaultSortDirection - value of the default sort direction either ascending or descending