overrideColumnsOnRefresh

This method is called whenever a list is initially opened, each time the list is refreshed, and each time the user specifies columns in the Column Selector dialog. It provides a means for always appending columns or removing columns defined by the user.

To prevent users from modifying the columns, remove access to "SelectColumns" in userAccess.xml.

Syntax

classProto.overrideColumnsOnRefresh = function(oValue, oContext)

Parameters

  • oValue - (Object) An object that specifies the columns to display with the following properties:
    • oValue.columns[] - (Array of objects) Each object has the following properties that identify a column:
      • id - (string) Identifier for the attribute displayed in the column.
      • header - (string) Text identifying the attribute that displays in the column header.
      • width - (string) The width of the column (in pixels); a default will be used if this is null.
      • tooltip - (string) Text that displays when the cursor hovers over the column header.
    • oValue.userChanged - (boolean) A flag indicating whether or not the user has ever modified the value, facilitating logic related to default values. This value will be null if it is unknown whether the user has changed the value because the view was created prior to implementation of the callout interface.
  • oContext - (Object) An object that provides information about the list being modified with the following properties:
    • oContext.userName - (string read-only) The name of the logged-in user.
    • oContext.userGuid - (string read-only) A unique identifier for the logged-in user.
    • oContext.viewType - (string read-only) The view type of the list. The possible values are:
      • com.tibco.wcc.base.ListContainer.WORKVIEW (Work View)
      • com.tibco.wcc.base.ListContainer.PTVIEW (Process View)
      • com.tibco.wcc.base.ListContainer.EVENTVIEW (Event View)
    • oContext.viewName - (string read-only) The name of the view that created the list.
    • oContext.viewDescription - (string read-only) A description of the view.
    • oContext.isSystemView - (boolean read-only) True if the view is a system view; False if the view is a user-defined view.

Returns

The modified oValue object, or null if no changes are to be made.