Bookshelf Home | Contents | Index | PDF | ![]() ![]() |
Configuring Siebel Open UI > Siebel Open UI Application Programming Interface > Methods of the Siebel Open UI Application Programming Interface > Component ClassThis topic describes the methods that Siebel Open UI uses with the Component class. It includes the following information:
Component MethodThe Component method is a constructor that creates a component object. It returns nothing. It uses the following syntax: var cmpObj = new SiebelAppFacade.Component(); GetChildren MethodThe GetChildren method identifies all child components that a parent component contains. It returns these child components in an array. If no child components exist, then it returns nothing. It uses the following syntax: var childrenCmp = cmpObj.GetChildren(); GetParent MethodThe GetParent method gets the parent component object. Siebel Open UI uses a tree structure to manage components. It uses this structure to identify the parent component that a query examines. It uses the following syntax: var parentObj = cmpObj.GetParent(); GetPM Method for ComponentsThe GetPM method that Siebel Open UI uses for components returns the presentation model object that the component references. It uses the following syntax: If you use GetPM before Siebel Open UI runs the setup call for the component, then GetPM returns a value that indicates that Siebel Open UI has not yet defined the presentation model object that this component references. For information about the GetPM method that Siebel Open UI uses for physical renderers, see GetPM Method for Physical Renderers. GetPR MethodThe GetPR method returns a physical renderer object that is associated with a component. It uses the following syntax: Siebel Open UI defers creating the physical renderer until it calls the Show function in the component. GetSiblings MethodThe GetSiblings method returns all siblings. In this context, a sibling is a component that reside at same the level in the component tree structure as the component that it calls. It returns these values in an array. If no other components reside at the same level, then it returns nothing. The GetSiblings method uses the following syntax: var siblingObjs = cmpObj.GetSiblings(); Setup Method for ComponentsThe Setup method that Siebel Open UI uses with components does the basic setup for the component instance, and then prepares the presentation model that this component instance references. It calls the Setup method that resides in this presentation model. It uses the following syntax:
The Component Manager calls the Setup method. It is recommended that you do not configure Siebel Open UI to directly call the setup method on any component object. For more information about the Setup method that Siebel Open UI uses with presentation models, see Setup Method for Presentation Models. Show Method for ComponentsThe Show method that Siebel Open UI uses for components shows a component. It uses the following syntax: Siebel Open UI uses the Component Manager to call the Show method for a component. This Show method does the following work during this call:
In some situations, Siebel Open UI might not finish calling the Setup method if it creates the component after the Component Manager life cycle finishes. In this situation, Siebel Open UI can use the Show method to call this component to make sure that it completes this life cycle successfully. For more information, see Setup Method for Components. It is recommended that you not configure Siebel Open UI to make a direct call to the Show method for a component. For more information about using the Show method, see Life Cycle Flows of User Interface Elements. For information about the Show method that Siebel Open UI uses for component managers, see Show Method for Component Managers. |
![]() |
![]() ![]() |
Configuring Siebel Open UI | Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices. | |