DBA Data[Home] [Help]

PACKAGE: APPS.ICXUI_API_UTIL

Source


1 package icxui_api_util AUTHID CURRENT_USER as
2 /* $Header: ICXUIUTS.pls 115.0 99/10/28 23:26:53 porting ship    $ */
3 
4    /**
5     * Draw the Title Bar
6     *
7     * This routine generates the title bar used
8     * in the wizard, tabset and the dialog.
9     *
10     * The Title Bar consists of the Main Title and
11     * the Secondary Title displayed on the left side
12     * and the Help Icon displayed on the right side.
13     *
14     * @param p_title main title
15     * @param p_sec_title secondary title
16     * @param p_help_url valid URL for the help icon
17     */
18     procedure draw_title
19     (
20         p_title     in varchar2
21     );
22 
23    /**
24     * Draw the Image
25     *
26     * This routine draws the image associated
27     * with the wizard/tabset and dialog.
28     *
29     * @param p_image image to be displayed
30     */
31     procedure draw_image
32     (
33         p_image in varchar2
34     );
35 
36 
37    /**
38     * Draw the Footer
39     *
40     * This routine draws the footer associated with the wizard/tabset
41     * and dialog
42     *
43     */
44     procedure draw_footer;
45 
46 
47    /**
48     * Draw the Subheader
49     *
50     * This routine draws the subheader associated
51     * with the wizard/tabset and dialog.
52     *
53     * @param p_subheader_text subheader to be displayed
54     */
55     procedure draw_subheader
56     (
57         p_subheader_text in varchar2
58     );
59 
60    /**
61     * Draw the Help Text
62     *
63     * This routine draws the help (hint) text
64     * associated with the wizard/tabset and dialog.
65     *
66     * @param p_help_text help text to be displayed
67     */
68     procedure draw_helptext
69     (
70         p_help_text in varchar2
71     );
72 
73    /**
74     * Draw the Buttons
75     *
76     * This routine draws the required buttons
77     *
78     * @param p_buttons list of buttons to be displayed
79     */
80     procedure draw_buttons
81     (
82         p_buttons icxui_api_button_list
83     );
84 
85 
86     function formButton
87     (
88         cname       in varchar2 DEFAULT NULL,
89         cvalue      in varchar2 DEFAULT NULL,
90         cattributes in varchar2 DEFAULT NULL
91     )
92     return varchar2;
93 
94    /**
95     * Get the Text Style
96     *
97     * This routine returns the text with the font
98     * settings that is used for the wizard,
99     * tabsets and the dialog.
100     *
101     * @param p_str text to be formatted
102     * @returns the formatted text.
103     */
104     function get_text_style
105     (
106         p_str in varchar2
107     )
108     return varchar2;
109 
110    /**
111     * Draw the Path Text
112     *
113     * This routine draws the path text (folder path,
114     * page path) associated with the wizard/tabset
115     * and dialog.
116     *
117     * @param p_path_text path to be displayed
118     */
119     procedure draw_path_text
120     (
121         p_path_text in varchar2
122     );
123 
124 end icxui_api_util;