Configuring Siebel Open UI > Post-Upgrade Configuration Tasks > Updating Physical Renderer Customizations for Controls >

Control DOM Access and Changes


Beginning in Siebel Innovation Pack 2014, Siebel Open UI uses plug-in wrappers to oversee controls and their Document Object Model (DOM) manipulations. Any renderer code required to work with control level DOM elements defers to its respective control plug-in wrapper interface to get the DOM representation.

Any changes required to the DOM will need to be completed by way of the control plug-in wrapper interface. The renderer should not make the changes in itself. The plug-in wrapper should be decorated with the ability to do what is required on the physical UI based on the logical control that it is representing.

In order to adhere to the conventions used in Siebel Innovation Pack 2014, you will need to determine if you have code that needs to be modified. To do this you must find the control DOM access with specific types in your custom renderer code, and replace that code with new code.

To find and modify the control DOM access types in your custom renderer code

  1. Determine if you have code that needs to be modified by searching for calls similar to either of the following code samples:
    • var controElement = $('[name="' + control.GetInputName() + '"]');
    • var controElement = $('#' + control.GetInputName());

      NOTE:  Access is not limited to these calls. Similar types of calls that attempt to find the DOM element using the control object should also be replaced.

  2. Replace all instances of calls similar to code discovered in Step 1 using following convention:

    var controElement = this.GetUIWrapper(control).GetEl();

    These modifications help ensure that the correct jQuery element representing the control on the UI is retrieved, irrespective of the type of renderer from which the call is being made.

GetUIWrapper is a plug-in builder API that is injected into all physical renderers. It returns the plug-in wrapper of the control object that is passed to it. There are various APIs, such as GetEl(), that are executable in the wrapper. For more information about these plug-in wrappers, see Plug-in Wrapper Class.

Configuring Siebel Open UI Copyright © 2015, Oracle and/or its affiliates. All rights reserved. Legal Notices.