Siebel 2018: Plug-in Wrapper Class

Configuring Siebel Open UI > Application Programming Interface > Methods of the Siebel Open UI Application Programming Interface >

Plug-in Wrapper Class

This topic describes the methods that Siebel Open UI uses with the basepw, which is the Plug-in Wrapper base class. The methods exposed by basepw are as follows:

GetEl Method

The GetEl method simplifies the process of finding DOM element associated with a particular control in the applet region. It can detect if the control has multiple instances in the DOM and if so, it will them return all. If a single instance is required, the index must be passed to this function. It uses the following syntax:

GetEI(index)

Where index is a numerical value representing the row number of the DOM element of the control that is required. This argument is optional.

Returns the associated jQuery based DOM reference for the control or NULL.

For example, the following code uses the GetUI method to retrieve all DOM element of a particular control:

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

For another example, the following code uses the GetUI method to retrieve index-based DOM elements of a particular control when the control has multiple DOM instances, as in a list applet:

var el = this.GetUIWrapper( control ).GetEl( index );

ShowUI Method

The ShowUI method performs show-related activities for a control. It requires the GetEl method and the Template Manager to accomplish its purpose.

BindEvents Method

The BindEvents method attaches events to the DOM instance of a control. It requires the GetEl method and the Event Helper to accomplish its purpose.

For more information, see BindEvents Method.

SetValue Method

The SetValue method sets the value in the DOM instance of control. If there are multiple DOM instances for the control, the index argument is used to used to determine the instance to which the value should be set.Customized plug-in wrappers must use this index to find associated DOM instances and call appropriate value modification APIs in the DOM to reflect the customization.

It uses the following syntax:

SetValue(value, index)

Where value identifies the value of the control DOM instance.

Where index is a numerical value representing the row number of the DOM element of the control that is required.

GetValue Method

The GetValue method gets the value of the control field from the DOM. If multiple instances of the control exist, then the index parameter is used to identify the value of the particular control that is needed. It uses the following syntax:

GetValue(index)

Where index is a numerical value representing the row number of the DOM element of the control that is required.

BeginQuery Method

The BeginQuery method indicates to a customized PW that it is entering query mode. It uses the following syntax:

BeginQuery()

It includes no arguments.

EndQuery Method

The EndQuery method indicates to a customized PW that it is exiting query mode. It uses the following syntax:

EndQuery()

It includes no arguments.

GetIconMap Method

The GetIconMap method determines if there are any configured icon maps for a customized PW control. If it does, the appropriate icon map is returned. It uses the following syntax:

GetIconMap()

It includes no arguments.

SetState Method

The SetState method provides an indicator to a customized PW to set a state to the associated DOM instances. If there are multiple DOM instances, use the index argument to retrieve the appropriate element. It uses the following syntax:

SetState(state, flag, index)

Where state is one of the following values:

EDITABLE. Can be edited.
ENABLE. Is enabled.
SHOW. Is visible.
FOCUS. Is focussed.

Where flag indicates if the state should be reversed, and is one of the following values:

TRUE. The state should be reversed.
FALSE. The state should be maintained.
For example, if the state is set to EDITABLE, and the flag is set to TRUE, the value of state will be reversed to NON-EDITABLE.

Where index is a numerical value representing the row number of the DOM element of the control that is required.

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