1. Configuring Siebel Open UI Guide
  2. Events That You Can Use to Customize List Applets

Events That You Can Use to Customize List Applets

The following table describes the events that you can use to customize a list applet.

Event Description

PHYEVENT_SELECT_ROW

Siebel Open UI triggers the PHYEVENT_SELECT_ROW event when the user chooses a row in a list applet. You can use it to determine whether or not the user clicked a row that is not the current row. Using this event might cause the state of objects that reside on the Siebel Server to be inconsistent with the state of objects that reside in the client.

You can use this event with the following objects:

  • rowIndex. Contains the index of the row that the user clicks. It uses 0 as the index for the first row.

  • shiftKey. Contains a Boolean value that indicates if the user pressed the Shift key while choosing a row.

  • controlKey. Contains a Boolean value that indicates if the user pressed the Ctrl key while choosing a row.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_SELECT
_ROW""),
  function (rowIndex, shiftKey, controlKey) {
    if (rowIndex === 0 && shiftKey){
      alert (""Do not multiselect all rows."");
      return (false);
    }
  });"

PHYEVENT_COLUMN_FOCUS

Siebel Open UI triggers the PHYEVENT_COLUMN_FOCUS event when a column in a list applet comes into focus. You can use it to identify the column that is in focus, and to call custom code. You can use this event with the following objects:

  • rowIndex. Contains the index of the current row. It uses 1 as the index for the first row.

  • control. Identifies the column control object that comes into focus.

  • value. Contains the value of the column control object.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_COLUMN
_FOCUS""),
  function (rowIndex, control, value) {
    if (rowIndex > 5) {
      return (true);
    }
    if (this.Get(""AppletInFocus""){
      var controlArray = this.Get(""FlaggedControlSet"");
      if (controlArray.indexOf(control) >= 0){
        // Declare the flagged control.
        var valueObject = this.GetProperty 
(""FlaggedControlsValue"");
        if (value > maxValue){
          // Flag value that is higher than allowed when receiving focus.
          this.SetProperty (""FlagHigher"", true);
        }
      }
    }
    return (true);
  });"

PHYEVENT_COLUMN_BLUR

Siebel Open UI triggers the PHYEVENT_COLUMN_BLUR event when a column in a list applet goes out of focus. You can use it to identify the column that is going out of focus, and to call custom code. You can use this event with the following objects:

  • rowIndex. Contains the index of the current row. It uses 1 as the index for the first row.

  • control. Identifies the column control object that is going out of focus.

  • value. Contains the value of the column control object.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_COLUMN
_BLUR""),
  function (rowIndex, control, value) {
  if (rowIndex > 5) {
    return (true);
  }
  if (this.Get(""AppletInFocus""){
    var controlArray = this.Get(""FlaggedControlSet"");
    if (controlArray.indexOf(control) >= 0)) {
      // This is a flagged control.
      var valueObject = this.GetProperty 
(""FlaggedControlsValue"");
      if (value > maxValue){
          // Value higher than allowed when receiving focus. 
Let's flag this.
          this.SetProperty (""FlagHigher"", true);
        }
      }
    }
    return (true);
  });"

PHYEVENT_DRILLDOWN_LIST

Siebel Open UI triggers the PHYEVENT_DRILLDOWN_LIST event when the user clicks a drilldown link in a list applet. You can use it to call custom code when the user clicks a drilldown link. You can use this event with the following objects:

  • rowIndex. Contains the index of the current row. It uses 1 as the index for the first row.

  • colName. Contains the name of the column where the drilldown link resides.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_DRILLD
OWN_LIST""),
  function (colName, rowIndex) {
  if (name === ""Type"")){
    varmaxOptyArray = this.Get(""mO"");
    if (maxOptyArray[rowIndex] >         
this.Get(""HigVal"")){
        alert (""Fix opportunity value before drilldown."");
        return (false);
      }
    }
    return (true);
  });"

PHYEVENT_VSCROLL_LIST

Siebel Open UI triggers the PHYEVENT_VSCROLL_LIST event when the user clicks the next page or previous page control in a list applet or tile applet. You can use it to call custom code when the user clicks one of these controls. Siebel Open UI does not trigger this event if the user uses a keyboard shortcut to do the pagination. You can use this event with the following objects:

  • direction. Includes one the following values that describes the type of pagination that the user attempted:

    • PAG_NEXT_RECORD. (Prior to Siebel CRM 17.0 only) User paginated to the next record.

    • PAG_PREV_RECORD. (Prior to Siebel CRM 17.0 only) User paginated to the previous record.

    • PAG_NEXT_SET. Displays the next record in the set.

    • PAG_PREV_SET. Displays the previous record in the set.

    • PAG_FIRST_SET. Displays the first record in the set.

    • PAG_LAST_SET. Displays the last record in the set.

    • PAG_SCROLL_UP. User scrolled up.

    • PAG_SCROLL_DN. User scrolled down.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_VSCROL
L_LIST""),
  function (direction) {
  if (direction 
===SiebelApp.Contants.Get(""PAG_NEXT_SET"")){
      alert (""Jump record by record. Not sets."");
      return (false);
    }
    return (true);
  });"

PHYEVENT_SORT_LIST

Siebel Open UI triggers the PHYEVENT_SORT_LIST event when the user sorts a list column. You can use it to call custom code when the user does this sort. You can use this event with the following objects:

  • colName. Identifies the name of the column that the user is sorting.

  • direction. Identifies one of the following directions:

    • SORT_ASCENDING. The user is sorting the column in ascending order.

    • SORT_DESCENDING. The user is sorting the column in descending order.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_SORT_L
IST""),
  function (colName, direction) {
  if (colName === ""Type""){
    if (direction === 
SiebelApp.Constants.Get(""SORT_ASCENDING"")){
        alert (""You cannot sort this column."");
        return (false);
      }
    }
    return (true);
  });"

PHYEVENT_HIER_EXPAND

Siebel Open UI triggers the PHYEVENT_HIER_EXPAND event when the user expands a row in a hierarchal list applet. You can use it to call custom code when the user does this expansion. Siebel Open UI uses this event only with hierarchal list applets. You can use this event with the following objects:

  • rowNum. Contains the row number that the user is expanding. It uses 0 as the number for the first row.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_HIER_E
XPAND""),
  function (rowNum) {
  if (rowNum === 0)){
    varhighValue = this.Get(""HighVal"");
    if (highValue < this.Get (""MinRangeForFlagged""){ 
        alert (""Sorry. Change the Range value to expand this row."");
        return (false);
      }
    }
    return (true);
  });"

PHYEVENT_HIER_COLLAPSE

Siebel Open UI triggers the PHYEVENT_HIER_COLLAPSE event when the user collapses a row in a hierarchal list applet. You can use it to call custom code when the user does this collapse. Siebel Open UI uses this event only with hierarchal list applets. You can use this event with the following objects:

  • rowNum. Contains the row number that the user is collapsing. It uses 0 as the number for the first row.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_HIER_C
OLLAPSE""),
  function (rowNum) {
  if (rowNum === 2)){
    varhighValue = this.Get(""HighVal"");
    if (highValue < this.Get (""MinRangeForFlagged""){
        alert (""Sorry, change the Range to collapse this row."");
        return (false);
      }
    }
    return (true);
  });"