Configuring Siebel Open UI > Application Programming Interface > Methods for Pop-Up Objects, Google Maps, and Property Sets >
Pop-Up Presentation Models and Physical Renderers
The PopupPModel presentation model specifies how to model pop-up objects. It uses the following syntax: SiebelApp.PopupPModel
The PopupRenderer physical renderer specifies how to render pop-up objects. It uses the following syntax: SiebelAppFacade.PopupRenderer
If the status of a reply from the Siebel Server is NewPopup, then Siebel Open UI starts processing this new pop-up object in the client. Siebel Open UI supports modal and nonmodal pop-up objects. The Popup method specifies how to render pop-up objects. Siebel Open UI typically renders a pop-up object as a dialog box.
A modal pop-up object is a type of pop-up object where the metadata for this object contains all of the following qualities:
- The URL property specifies a Siebel URL.
- The SWE_FULL_POPUP_WINDOW_STR property is false.
- The SWE_FREE_POPUP_STR property is false.
Siebel Open UI can create a modal pop-up in one of the following ways:
A nonmodal pop-up object is a type of pop-up object where the metadata for this object contains any of the following qualities:
- The URL property does not specify a Siebel URL.
- The SWE_FULL_POPUP_WINDOW_STR property is true.
- The SWE_FREE_POPUP_STR property is true.
Siebel Open UI uses a nonmodal pop-up object to open an external URL that it stores as data in a Siebel applet. Properties of the Pop-Up Presentation Model
Table 43 describes the properties of the PopupPM presentation model. The state, url, and content properties render and maintain the state of the pop-up object. It is recommended that you not set the content and the url properties for the same pop-up object.
Table 43. Properties of the Pop-Up Presentation Model
|
|
canProcessLayout |
Not applicable. |
closeByXDisabled |
Controls the X control of the pop-up object. You can set this property to one of the following values:
- true. Siebel Open UI disables the X control.
- false. Siebel Open UI enables the X control.
|
content |
Contains the HTML source code for the pop-up object. Setting this property configures Siebel Open UI to load the HTML source code into the target, and then to call the Initialize method on the pop-up proxy to update the data. |
currPopups |
Maintains an array of currency pop-ups. |
height |
Specifies the height of the pop-up object, in pixels. |
isCancelQryPopupOpen |
Includes one of the following return values:
- true. A cancel query object is open.
- false. No cancel query objects are open.
|
isCurrencyOpen |
Includes one of the following return values:
- true. A currency pop-up object is open.
- false. No currency pop-up objects are open.
|
isPopupClosedByX |
Includes one of the following return values:
- true. The user used the X control to close the pop-up object.
- false. The user did not use the X control to close the pop-up object.
|
isPrevPopupVisible |
- Sets the visibility of the parent pop-up object when Siebel Open UI displays a child pop-up object inside the parent. You can set this property to one of the following values:
- true. Siebel Open UI displays the parent.
- false. Siebel Open UI hides the parent.
|
noHide |
Determines whether or not Siebel Open UI can hide the pop-up object. You can set this property to one of the following values:
- true. Siebel Open UI can hide the object.
- false. Siebel Open UI cannot hide the object.
|
source |
Contains the source that Siebel Open UI uses to open the pop-up object. You can set this property to a URL. Siebel Open UI uses this source property to set the url and content properties of this pop-up object. |
state |
Opens or closes the pop-up object. You can set this property to one of the following values
- open. Siebel Open UI opens an empty dialog box.
- close. Siebel Open UI closes an open dialog box.
|
url |
Specifies the URL that Siebel Open UI uses to open the pop-up object according to the following mode that the pop-up object uses:
- Modal. Specifies the source URL that contains the content that Siebel Open UI displays in the pop-up object.
- Nonmodal. Specifies the URL that Siebel Open UI uses to load content into the target HTML element of the pop-up object.
Setting this property configures Siebel Open UI to get the layout for this pop-up from the Siebel Server, render this layout, and then to call the Initialize method on the pop-up proxy to load the data. |
width |
Specifies the width of the pop-up object, in pixels. |
Methods of the Popup Presentation Model
Table 44 describes the methods of the PopupPM presentation model. The parentheses that this table includes after each method name lists the arguments that each method supports. An empty set of parentheses indicates that the method supports no arguments.
Table 44. Methods of the Pop-Up Presentation Model
|
|
ClearPopup() |
Sets the pop-up visibility to false and resets various properties and method values after Siebel Open UI closes the pop-up object. |
OnLoadPopupContent() |
Loads the HTML for the pop-up object, initializes pop-up applets, and then calls the show method on the pop-up proxy. |
OpenPopup(source, height, width, full, free, bContent) |
Opens the pop-up object according to the arguments that the ProcessNewPopup method determines. It uses these arguments to set the properties of the pop-up object. Some of these arguments call other methods in the PopupPR physical renderer that load the content in the pop-up object. |
ProcessClearPopup(propSet) |
Calls the ClearPopup method. |
ProcessNewPopup(propset) |
Processes the property set that Siebel Open UI sends to this method as an argument, and then determines the following items:
- The mode that the pop-up object uses
- Various pop-up window features
- The width and height of the pop-up object, in pixels.
Siebel Open UI calls the OpenPopup method to open a modal pop-up object. It does not call OpenPopup to open a nonmodal pop-up object. Instead, it creates a nonmodal pop-up object from this ProcessNewPopup method. |
SetPopupVisible(bVisible) |
Modifies the state property of the pop-up object depending on whether the bVisible argument is true or false. |
|