The BI Beans uiXML elements can be grouped into the following categories:
Definition elements -- Provide definitions of BI Beans thin beans, dialogs, and callbacks. Most definition elements are paired with a BI Beans rendering component that displays the object that is defined. The format for the name of a definition element is xxxDef, where xxx is the name of the defined object. For example, to define the ExportOptions dialog, use the exportOptionsDef element.
The following definition elements do not have paired rendering components:
The biThinSession element, callback elements, instance element, and method element do not require a rendering component.
Elements that you can render as buttons or links do not require a BI Beans uiXML rendering component because you can display these elements using any uiXML button or link. The elements in this category are dialogLinkDef, saveDef, and submitEventDef.
Rendering components -- Provide elements that display BI Beans thin beans, dialogs, and error messages. Rendering components (except for the errorDialog element and the explorerQuickSearch element) are paired with a definition element. The name of a paired rendering component is the same as the name of its definition element, except that the suffix "Def" is removed. For example, the rendering component for the exportOptions dialog is the exportOptions element.
The following table gives a brief description of the objects that relate to BI Beans uiXML elements and specifies the definition element and the rendering component for each object, where applicable.
Description | BI Beans Definition Element | BI Beans Rendering Component |
---|---|---|
BISession -- stores initialization information for the session | biThinSession (parent element for all BI definition elements other than instance and method) | Not applicable |
Callback that initializes the BISession | biSessionCallback (parent element for instance or method element) | Not applicable |
Callback that initializes a BI UIX page | preRenderingCallback (parent element for instance or method element) | Not applicable |
Instance -- Defines a Java instance to be used for page customization | instance | Not applicable |
Method -- Defines a static Java method to be used for page customization | method | Not applicable |
Code to fire the initialization event for a BI thin dialog | dialogLinkDef | None -- Use any uiXML button or link |
Code to fire the initialization event for the SaveConfirmation dialog | saveDef | None -- Use any uiXML button or link |
Code to fire an HTTP event for a BI thin dialog | submitEventDef | None -- Use any uiXML button or link |
ErrorDialog -- Provides a rendering component for the display of an error message | Not applicable | errorDialog |
ExplorerDetail -- Browses, searches, and accesses files in the BI Beans Catalog | explorerDetailDef | explorerDetail |
ExplorerQuickSearch -- Provides Catalog search controls apart from the ExplorerDetail | Uses the explorerDetailDef | explorerQuickSearch |
ExplorerTree -- Browses the BI Beans Catalog | explorerTreeDef | explorerTree |
ExportOptions dialog -- Exports a presentation | exportOptionsDef | exportOptions |
FavoriteTool -- Creates favorite selections | favoriteToolDef | favoriteTool |
FindMember dialog -- Selects dimension members for the page control of a presentation | findMemberDef | findMember |
Presentation -- Displays a BI thin graph, crosstab, or table | presentationDef | presentation |
PrinterFriendlyView -- Displays a printable version of a presentation | printerFriendlyViewDef | printerFriendlyView |
PrintOptions dialog -- Prints a presentation | printOptionsDef | printOptions |
RotateTool -- Manipulates the layout of the dimensions of a presentation | rotateToolDef | rotateTool |
SaveAs dialog -- Saves a presentation | saveAsDef | saveAs |
SaveConfirmation dialog -- Confirms or cancels the save of a presentation | saveConfirmationDef | saveConfirmation |
SortTool -- Sorts dimension members in a presentation | sortToolDef | sortTool |
ViewToolbar -- Provides a default toolbar for a presentation | viewToolbarDef | viewToolbar |
ViewTypeTool -- Changes the view type of a presentation (such as, from graph to crosstab) | viewTypeToolDef | viewTypeTool |
Related Topics
Creating a BI Beans uiXML
Application
Creating BI Beans uiXML Elements