Bookshelf Home | Contents | Index | PDF |
Configuring Siebel Open UI > Application Programming Interface > Methods of the Siebel Open UI Application Programming Interface > GetEDEnabled MethodThe GetEDEnabled method determines whether or not an Effective Dating (ED) control is enabled. It returns one of the following values: The GetEnabledBmp method determines whether or not an image source is configured for a control, whether or not this image source exists, and whether or not this control is enabled. It returns one of the following values depending on whether or not the image exists:
The GetFieldName method returns a string that includes the name of the field where a control is configured. It uses the following syntax: For examples that use GetFieldName, see Customizing Methods in the Presentation Model to Store Field Values and CanNavigate Method. The GetHeight method returns a string that includes the height of a control, in pixels. It uses the following syntax: The GetIndex method returns the index of a control. This index identifies the control position in the applet. It uses the following syntax: The GetInputName method returns a string that includes the HTML Name attribute of a control. It uses the following syntax: For examples that use the GetInputName method, see the following topics:
The GetJustification method returns a string that indicates the text justification. It uses the following syntax: For an example that uses the GetJustification method, see LookupStringCache Method. The GetMaxSize method returns the maximum number of characters that the user can enter into a control. It uses the following syntax: The GetMethodName method returns a string that includes the name of a method that is configured on a control. It uses the following syntax: For an example that uses the GetMethodName method, see CanInvokeMethod Method for Presentation Models. The GetName method that Siebel Open UI uses for applet controls returns the name of an applet control. It returns this name in a string. It uses the following syntax: The following example uses the GetName method: if (control.GetName() === "Account"){ // This is the account control. alert ("You are leaving Account. This will trigger an immediate post change"); For other examples that use the GetName method, see the following topics:
For information about the GetName method that Siebel Open UI uses for other classes, see GetName Method for Applets see GetName Method for Application Models. The GetPMPropSet method gets the property set for a control. It uses the following syntax: control.GetPMPropSet(consts.get("SWE_CTRL_PM_PS") To view an example that uses this method, see Customizing Control User Properties for Presentation Models. The GetPopupHeight method returns a string that includes one of the following values:
For an example that uses the GetPopupHeight method, see GetPopupType Method. The GetPopupType method identifies the type of popup object that Siebel Open UI associates with a control. It returns a string that includes one of the following values:
The following example uses the GetPopupType method to make sure sufficient space exists to display the popup: if (control.GetPoupType !== "Pick"){ // There's a Pick defined on this control. var pHeight = control.GetPopupHeight(); var pWidth= control.GetPopupWidth(); if (pHeight > "60" || pWidth > "200"){ // The pop does not fit in the mobile screen, so we will disable this popup.) var htmlName = control.GetInputName(); // Set the control into readonly mode. $("[name=" + htmlName + "]").attr('readonly', true); The GetPopupWidth method returns a string that includes one of the following values:
For an example that uses the GetPopupWidth method, see GetPopupType Method. The GetPrompt method returns a string that includes the prompt text that Siebel Open UI displays with a control. It uses the following syntax: The following example includes the GetPrompt method: // Alert the user when he lands in the control if (document.getActiveElement === control.GetInputName(){ alert (SiebelApp.S_App.LookupStringCache(control.GetPrompt())); The GetUIType method returns a string that identifies the type of control. For example, multivalue group, picklist, calculator, and so on. It uses the following syntax: The GetWidth method returns a string that includes the width of a control, in pixels. It uses the following syntax: The HandleDeleteNotification method deletes the reference to record data that Siebel Open UI stored in the client for a control. For an example that uses the HandleDeleteNotification method, see Creating and Managing Client-Side Controls. The IsBoundedPick method returns one of the following values: The IsCalc method returns one of the following values: The IsDynamic method returns one of the following values: The IsEditEnabled method returns one of the following values: The IsSortable method returns one of the following values: The NewRecord method initializes a new record that Siebel Open UI adds to the database that resides on the Siebel Server. It uses the following syntax: BusComp.prototype.NewRecord = function (bInsertBefore, bInternal, pIdValue) {}
For examples that use the NewRecord method, see the following topics:
The NotifyNewData method sends an event notification to the client when Siebel Open UI modifies the value of a field. It returns nothing. It uses the following syntax: BusComp.prototype.NotifyNewData = function (field_name) {} You can use the NotifyNewData method to make sure Siebel Open UI synchronizes the modified field values between different applets that reside in the same client or that reside in different clients. NotifyNewData also notifies other fields that reference this field. You can configure Siebel Open UI to override the NotifyNewData method. The PreGetFormattedFieldValue method gets the format that a field uses to store the value of a control. For an example that uses the PreGetFormattedFieldValue method, see Creating and Managing Client-Side Controls. The PostLeaveField method temporarily stores a value that the user enters in a control. It stores this value in memory. You use the AddMethod to call the PostLeaveField method. Siebel Open UI then implicitly calls the PostLeaveField method from the LeaveField method that the listapplet.js file specifies. For an example that uses the PostLeaveField method, see Creating and Managing Client-Side Controls. The SetIndex method sets the index of a control. This index identifies the control position in the applet. The SetIndex method returns nothing. It uses the following syntax: The following example uses the SetIndex method: //listOfControls that contains an object of all the controls in the applet var listOfControls = <AppletPM>.Get("GetControls"); var accountControl = listOfControls["Account"]; var accountIndex= listOfControls["Account"].GetIndex(); var revenueControl = listOfControls["Revenue"]; var revenueIndex= listOfControls["Revenue"].GetIndex(); // Now we can swap the indeces and effectively the tabbing order too. accountControl.SetIndex (revenueIndex); revenueControl.SetIndex (accountIndex); This topic describes the methods that Siebel Open UI uses with the JQGridRenderer class. It includes the following information:
Siebel Open UIuses this class to render an applet as a form. The OnControlBlur method handles an onblur event for a control that resides in a form applet. It uses the following syntax: For information about the OnCtrlBlur method that Siebel Open UI uses with the presentation model for list applets, see OnCtrlBlur Method. The OnControlMvg method handles a multivalue group for a control that resides in a form applet. It uses the following syntax: The OnControlPick method handles a picklist for a control that resides in a form applet. It uses the following syntax: The OnPagination method handles a pagination that occurs in a form applet. It uses the following syntax: The OnRowSelect method handles a row click. It runs if the user clicks a row. It starts the PositionOnRow that updates the proxy business component. It uses the following syntax: |
Configuring Siebel Open UI | Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices. | |