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

Events That You Can Use to Customize Form Applets

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

Event Description

PHYEVENT_APPLET_FOCUS

Siebel Open UI triggers the PHYEVENT_APPLET_FOCUS event when an applet receives focus. You can use it to trigger custom code when Siebel Open UI sets the focus to the presentation model that the applet references as the result of a user action. No objects are available with this event. The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_APP
LET_FOCUS""),
  function () {
    // My applet recived focus.
    this.SetProperty (""AppletInFocus"", true);
    return (true);
  });"

PHYEVENT_CONTROL_FOCUS

Siebel Open UI triggers the PHYEVENT_CONTROL_FOCUS event when a control in an applet comes into focus. You can use this event to update the value for this control or to call code according to this value. You can use it with the following objects:

  • control. The control object that receives focus.

  • value. The value of the control object that receives focus.

The following code is an example usage of this event: 

this.AttachEventHandler(siebConsts.get("PHYEVENT_CONTR
OL_FOCUS"),
  function (control, value) {
    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_CONTROL_BLUR

Siebel Open UI triggers the PHYEVENT_CONTROL_BLUR event when a control in an applet goes out of focus. You can use this event to update the value for this control or to call code according to this value. You can use it with the following objects:

  • control. The control object that lost focus.

  • value. The value of the control object that lost focus.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_CON
TROL_BLUR""),
  function (control, value) {
    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 (valueObject[ control.GetName() ] !== value){
            // Value change. Need to update internal 
storage, and fire any potential extensions attached to 
the property.
            valueOjbect[ control.GetName() ] = value;
            this.SetProperty (""FlaggedControlsValue"", 
valueObject);
          }
        }
      }
    return (true);
  });"

PHYEVENT_INVOKE_CONTROL

Siebel Open UI triggers the PHYEVENT_INVOKE_CONTROL event when it calls a method that is associated with a control. Siebel Open UI makes this call in reply to a user action. You can use this event to configure Siebel Open UI to call a method at the physical layer before it makes this call at a proxy layer. You can use this event with the following objects:

  • method. The method that Siebel Open UI calls.

  • inputPS. The input property set that Siebel Open UI sends to the method that it calls.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_CONTROL""),
  function (method, inputPS, ai) {
    if (method === ""WriteRecord""){
      var valueObject = this.GetProperty 
(""FlaggedControlsValue"");
      var min = this.Get(""MinRangeForFlagged"");
      for (var value in valueObject){
        if (value < min){
          alert (""Invalid Values. Think again!"");
          return (false);
        }
      }
    }
    return (true);
  });"

PHYEVENT_INVOKE_PICK

Siebel Open UI triggers the PHYEVENT_INVOKE_PICK event when it calls a pop-up control for a picklist. Siebel Open UI makes this call in reply to a user action on the keyboard or mouse. You can use this event to configure Siebel Open UI to handle the action that the pop-up control requests. You can use it with the following objects:

  • control. The control object of the picklist that Siebel Open UI called.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_MVG""),
  function (control) {
    if (control === this.GetProperty(""AddressMVG"")){
      varhighValue = this.Get(""HighVal"");
      if (highValue < this.Get (""MinRangeForFlagged""){
        alert (""Sorry, can't popup this MVG"");
        return (false);
      }
    }
    return (true);
  });"

PHYEVENT_INVOKE_MVG

Siebel Open UI triggers the PHYEVENT_INVOKE_MVG event when it calls a pop-up control for a multivalue group. Siebel Open UI makes this call in reply to a user action on the keyboard or mouse. You can use this event to configure Siebel Open UI to handle the action that the pop-up control requests. You can use it with the following objects:

  • control. The control object of the multivalue group that Siebel Open UI called.

The following code is an example usage of this event:

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_MVG""),
  function (control) {
    if (control === this.GetProperty(""AddressMVG"")){
      varhighValue = this.Get(""HighVal"");
      if (highValue < this.Get (""MinRangeForFlagged""){
        alert (""Sorry, can't popup this MVG"");
        return (false);
      }
    }
    return (true);
  });"

PHYEVENT_INVOKE_DETAIL

Siebel Open UI triggers the PHYEVENT_INVOKE_DETAIL event when it calls a pop-up details control. Siebel Open UI makes this call in reply to a user action on the keyboard or mouse. You can use this event to configure Siebel Open UI to handle the action that the pop-up control requests. You can use it with the following objects:

  • control. The control object of the pop-up details control that Siebel Open UI called.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_DETAIL""),     
  function (control) {    
    if (control === this.GetProperty(""City"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){ 
        alert (""Sorry, can't use this Details"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_INVOKE_EFFDAT

Siebel Open UI triggers the PHYEVENT_INVOKE_EFFDAT event when it calls a pop-up effective dating control. Siebel Open UI makes this call in reply to a user action on the keyboard or mouse. You can use this event to configure Siebel Open UI to handle the action that the pop-up control requests. You can use it with the following objects:

  • control. The control object of the effective dating pop-up control that Siebel Open UI called.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_EFFDAT""),     
  function (control) {    
    if (control === this.GetProperty(""AccountTrail"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, can't open this Dating Popup"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_INVOKE_COMBO

Siebel Open UI triggers the PHYEVENT_INVOKE_COMBO event when it calls a combo box or dropdown list. Siebel Open UI makes this call in reply to a user action on the keyboard or mouse. You can use this event to configure Siebel Open UI to handle the open action that the combo box or dropdown list requests. You can use it with the following objects:

  • control. The control object of the combo box or dropdown list that Siebel Open UI called.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_COMBO""),     
  function (control) {    
    if (control === this.GetProperty(""Designation"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, can't open this Dropdown"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_INVOKE_CURRENCY

Siebel Open UI triggers the PHYEVENT_INVOKE_CURRENCY event when it calls a popup currency calculator. Siebel Open UI makes this call in reply to a user action on the keyboard or mouse. You can use this event to configure Siebel Open UI to handle the open action that the currency calculator requests. You can use it with the following objects:

  • control. The control object of the currency calculator that Siebel Open UI called.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_CURRENCY""),     
  function (control) {    
    if (control === 
this.GetProperty(""RevenueControl"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, can't open this currency 
field"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_INVOKE_TOGGLE

Siebel Open UI triggers the PHYEVENT_INVOKE_TOGGLE event when it calls a control that includes a toggle layout configuration. Siebel Open UI makes this call in reply to a user action to toggle the layout. You can use this event to configure Siebel Open UI to handle the action that the toggle layout requests. You can use it with the following objects:

  • value. Contains the value of the toggle control that exists after the user action.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_INV
OKE_TOGGLE""),     
  function (value) {    
    if (value === this.GetProperty(""FlaggedControl"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, change the Range value to 
toggle"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_DRILLDOWN_FORM

Siebel Open UI triggers the PHYEVENT_DRILLDOWN_FORM event when it calls a drilldown control that resides on a form applet. Siebel Open UI makes this call in reply to a user click on the drilldown. You can use this event to configure Siebel Open UI to handle the action that the drilldown requests. You can use it with the following objects:

  • control. Identifies the control object that contains the destination of the drilldown control.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_DRI
LLDOWN_FORM""),     
  function (control) {    
    if (control === this.GetProperty(""AccountDrill"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, change the Range value to 
drilldown"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_ENTER_KEY_PRESS

Siebel Open UI triggers the PHYEVENT_ENTER_KEY_PRESS event when the user presses the Enter key. Siebel Open UI triggers it only if a control is in focus. You can use this event to handle an Enter key press before the proxy layer uses the default configuration to handle it. You can use this event with the following objects:

  • control. Identifies the control object where the user used the Enter key.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_ENT
ER_KEY_PRESS""),     
  function (control) {    
    if (control === this.GetProperty(""Salary"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, change the Range value to 
commit"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_ESC_KEY_PRESS

Siebel Open UI triggers the PHYEVENT_ESC_KEY_PRESS event when the user presses the Esc (Escape) key. Siebel Open UI triggers it only if a control is in focus. You can use this event to handle an Esc key press before the proxy layer uses the default configuration to handle it. You can use this event with the following objects:

  • control. Identifies the control object where the user used the Esc key.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_ESC
_KEY_PRESS""),     
  function (control) {    
    if (control === this.GetProperty(""Salary"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, change the Range value to undo"");    
        return (false);    
      }    
    }    
    return (true);    
  });"

PHYEVENT_TAB_KEY_PRESS

Siebel Open UI triggers the PHYEVENT_TAB_KEY_PRESS event when the user presses the Tab key. Siebel Open UI triggers it only if a control is in focus. You can use this event to handle a Tab key press before the proxy layer uses the default configuration to handle it. You can use this event with the following objects:

  • control. Identifies the control object where the user used the Tab key.

The following code is an example usage of this event: 

"this.AttachEventHandler(siebConsts.get(""PHYEVENT_TAB
_KEY_PRESS""),     
  function (control) {    
    if (control === this.GetProperty(""Salary"")){    
      varhighValue = this.Get(""HighVal"");    
      if (highValue < this.Get (""MinRangeForFlagged""){    
        alert (""Sorry, change the Range value to undo"");    
        return (false);    
      }    
    }    
    return (true);    
  });"