1 package htp as
2
3 /* STRUCTURE tags */
4 procedure htmlOpen;
5 procedure htmlClose;
6 procedure headOpen;
7 procedure headClose;
8 procedure bodyOpen(cbackground in varchar2 DEFAULT NULL,
9 cattributes in varchar2 DEFAULT NULL) ;
10 procedure bodyClose;
11 /* END STRUCTURE tags */
12
13 /* HEAD Related elements tags */
14 procedure title (ctitle in varchar2 character set any_cs) ;
15 procedure htitle(ctitle in varchar2 character set any_cs,
16 nsize in integer DEFAULT 1,
17 calign in varchar2 DEFAULT NULL,
18 cnowrap in varchar2 DEFAULT NULL,
19 cclear in varchar2 DEFAULT NULL,
20 cattributes in varchar2 DEFAULT NULL) ;
21 procedure base( ctarget in varchar2 DEFAULT NULL,
22 cattributes in varchar2 DEFAULT NULL);
23 procedure isindex(cprompt in varchar2 character set any_cs DEFAULT NULL,
24 curl in varchar2 DEFAULT NULL) ;
25 procedure linkRel(crel in varchar2,
26 curl in varchar2,
27 ctitle in varchar2 character set any_cs DEFAULT NULL) ;
28 procedure linkRev(crev in varchar2,
29 curl in varchar2,
30 ctitle in varchar2 character set any_cs DEFAULT NULL) ;
31 procedure meta(chttp_equiv in varchar2,
32 cname in varchar2,
33 ccontent in varchar2) ;
34 procedure nextid(cidentifier in varchar2) ;
35 procedure style(cstyle in varchar2 character set any_cs) ;
36 procedure script(cscript in varchar2,
37 clanguage in varchar2 DEFAULT NULL) ;
38 /* END HEAD Related elements tags */
39
40 /* BODY ELEMENT tags */
41 procedure hr (cclear in varchar2 DEFAULT NULL,
42 csrc in varchar2 DEFAULT NULL,
43 cattributes in varchar2 DEFAULT NULL) ;
44 procedure line(cclear in varchar2 DEFAULT NULL,
45 csrc in varchar2 DEFAULT NULL,
46 cattributes in varchar2 DEFAULT NULL) ;
47 procedure br(cclear in varchar2 DEFAULT NULL,
48 cattributes in varchar2 DEFAULT NULL) ;
49 procedure nl(cclear in varchar2 DEFAULT NULL,
50 cattributes in varchar2 DEFAULT NULL) ;
51
52 procedure header(nsize in integer,
53 cheader in varchar2 character set any_cs,
54 calign in varchar2 DEFAULT NULL,
55 cnowrap in varchar2 DEFAULT NULL,
56 cclear in varchar2 DEFAULT NULL,
57 cattributes in varchar2 DEFAULT NULL) ;
58 procedure anchor(curl in varchar2,
59 ctext in varchar2 character set any_cs,
60 cname in varchar2 DEFAULT NULL,
61 cattributes in varchar2 DEFAULT NULL) ;
62 procedure anchor2(curl in varchar2,
63 ctext in varchar2 character set any_cs,
64 cname in varchar2 DEFAULT NULL,
65 ctarget in varchar2 DEFAULT NULL,
66 cattributes in varchar2 DEFAULT NULL) ;
67 procedure mailto(caddress in varchar2,
68 ctext in varchar2 character set any_cs,
69 cname in varchar2 character set any_cs DEFAULT NULL,
70 cattributes in varchar2 DEFAULT NULL) ;
71 procedure img(curl in varchar2,
72 calign in varchar2 DEFAULT NULL,
73 calt in varchar2 DEFAULT NULL,
74 cismap in varchar2 DEFAULT NULL,
75 cattributes in varchar2 DEFAULT NULL) ;
76 procedure img2(curl in varchar2,
77 calign in varchar2 DEFAULT NULL,
78 calt in varchar2 DEFAULT NULL,
79 cismap in varchar2 DEFAULT NULL,
80 cusemap in varchar2 DEFAULT NULL,
81 cattributes in varchar2 DEFAULT NULL) ;
82 procedure area( ccoords in varchar2,
83 cshape in varchar2 DEFAULT NULL,
84 chref in varchar2 DEFAULT NULL,
85 cnohref in varchar2 DEFAULT NULL,
86 ctarget in varchar2 DEFAULT NULL,
87 cattributes in varchar2 DEFAULT NULL);
88
89 procedure mapOpen(cname in varchar2,
90 cattributes in varchar2 DEFAULT NULL);
91 procedure mapClose;
92
93 procedure bgsound(csrc in varchar2,
94 cloop in varchar2 DEFAULT NULL,
95 cattributes in varchar2 DEFAULT NULL);
96
97
98 procedure para;
99 procedure paragraph(calign in varchar2 DEFAULT NULL,
100 cnowrap in varchar2 DEFAULT NULL,
101 cclear in varchar2 DEFAULT NULL,
102 cattributes in varchar2 DEFAULT NULL) ;
103 procedure div( calign in varchar2 DEFAULT NULL,
104 cattributes in varchar2 DEFAULT NULL) ;
105 procedure address(cvalue in varchar2 character set any_cs,
106 cnowrap in varchar2 DEFAULT NULL,
107 cclear in varchar2 DEFAULT NULL,
108 cattributes in varchar2 DEFAULT NULL) ;
109 procedure comment(ctext in varchar2 character set any_cs) ;
110 procedure preOpen(cclear in varchar2 DEFAULT NULL,
111 cwidth in varchar2 DEFAULT NULL,
112 cattributes in varchar2 DEFAULT NULL) ;
113 procedure preClose;
114 procedure listingOpen;
115 procedure listingClose;
116 procedure nobr(ctext in varchar2 character set any_cs);
117 procedure wbr;
118 procedure center(ctext in varchar2 character set any_cs);
119 procedure centerOpen;
120 procedure centerClose;
121
122 procedure blockquoteOpen(cnowrap in varchar2 DEFAULT NULL,
123 cclear in varchar2 DEFAULT NULL,
124 cattributes in varchar2 DEFAULT NULL) ;
125 procedure blockquoteClose;
126
127 /* LIST tags */
128 procedure listHeader(ctext in varchar2 character set any_cs,
129 cattributes in varchar2 DEFAULT NULL) ;
130 procedure listItem(ctext in varchar2 character set any_cs DEFAULT NULL,
131 cclear in varchar2 DEFAULT NULL,
132 cdingbat in varchar2 DEFAULT NULL,
133 csrc in varchar2 DEFAULT NULL,
134 cattributes in varchar2 DEFAULT NULL) ;
135 procedure ulistOpen(cclear in varchar2 DEFAULT NULL,
136 cwrap in varchar2 DEFAULT NULL,
137 cdingbat in varchar2 DEFAULT NULL,
138 csrc in varchar2 DEFAULT NULL,
139 cattributes in varchar2 DEFAULT NULL) ;
140 procedure ulistClose;
141 procedure olistOpen(cclear in varchar2 DEFAULT NULL,
142 cwrap in varchar2 DEFAULT NULL,
143 cattributes in varchar2 DEFAULT NULL) ;
144 procedure olistClose;
145 procedure dlistOpen(cclear in varchar2 DEFAULT NULL,
146 cattributes in varchar2 DEFAULT NULL) ;
147 procedure dlistTerm(ctext in varchar2 character set any_cs DEFAULT NULL,
148 cclear in varchar2 DEFAULT NULL,
149 cattributes in varchar2 DEFAULT NULL) ;
150 procedure dlistDef(ctext in varchar2 character set any_cs DEFAULT NULL,
151 cclear in varchar2 DEFAULT NULL,
152 cattributes in varchar2 DEFAULT NULL) ;
153 procedure dlistClose;
154
155 procedure menulistOpen;
156 procedure menulistClose;
157 procedure dirlistOpen;
158 procedure dirlistClose;
159 /* END LIST tags */
160
161 /* SEMANTIC FORMAT ELEMENTS */
162 procedure dfn(ctext in varchar2 character set any_cs,
163 cattributes in varchar2 DEFAULT NULL) ;
164 procedure cite(ctext in varchar2 character set any_cs,
165 cattributes in varchar2 DEFAULT NULL) ;
166 procedure code(ctext in varchar2 character set any_cs,
167 cattributes in varchar2 DEFAULT NULL) ;
168 procedure em(ctext in varchar2 character set any_cs,
169 cattributes in varchar2 DEFAULT NULL) ;
170 procedure emphasis(ctext in varchar2 character set any_cs,
171 cattributes in varchar2 DEFAULT NULL) ;
172 procedure keyboard(ctext in varchar2 character set any_cs,
173 cattributes in varchar2 DEFAULT NULL) ;
174 procedure kbd(ctext in varchar2 character set any_cs,
175 cattributes in varchar2 DEFAULT NULL) ;
176 procedure sample(ctext in varchar2 character set any_cs,
177 cattributes in varchar2 DEFAULT NULL) ;
178 procedure strong(ctext in varchar2 character set any_cs,
179 cattributes in varchar2 DEFAULT NULL) ;
180 procedure variable(ctext in varchar2 character set any_cs,
181 cattributes in varchar2 DEFAULT NULL) ;
182 procedure big( ctext in varchar2 character set any_cs,
183 cattributes in varchar2 DEFAULT NULL);
184 procedure small(ctext in varchar2 character set any_cs,
185 cattributes in varchar2 DEFAULT NULL);
186 procedure sub( ctext in varchar2 character set any_cs,
187 calign in varchar2 DEFAULT NULL,
188 cattributes in varchar2 DEFAULT NULL);
189 procedure sup( ctext in varchar2 character set any_cs,
190 calign in varchar2 DEFAULT NULL,
191 cattributes in varchar2 DEFAULT NULL);
192
193 /* END SEMANTIC FORMAT ELEMENTS */
194
195 /* PHYSICAL FORMAT ELEMENTS */
196 procedure basefont(nsize in integer);
197 procedure fontOpen( ccolor in varchar2 DEFAULT NULL,
198 cface in varchar2 DEFAULT NULL,
199 csize in varchar2 DEFAULT NULL,
200 cattributes in varchar2 DEFAULT NULL);
201 procedure fontClose;
202 procedure bold(ctext in varchar2 character set any_cs,
203 cattributes in varchar2 DEFAULT NULL) ;
204 procedure italic(ctext in varchar2 character set any_cs,
205 cattributes in varchar2 DEFAULT NULL) ;
206 procedure teletype(ctext in varchar2 character set any_cs,
207 cattributes in varchar2 DEFAULT NULL) ;
208 procedure plaintext(ctext in varchar2 character set any_cs,
209 cattributes in varchar2 DEFAULT NULL) ;
210 procedure s(ctext in varchar2 character set any_cs,
211 cattributes in varchar2 DEFAULT NULL) ;
212 procedure strike(ctext in varchar2 character set any_cs,
213 cattributes in varchar2 DEFAULT NULL) ;
214 procedure underline(ctext in varchar2 character set any_cs,
215 cattributes in varchar2 DEFAULT NULL) ;
216 /* END PHYSICAL FORMAT ELEMENTS */
217
218 /* HTML FORMS */
219 procedure formOpen(curl in varchar2,
220 cmethod in varchar2 DEFAULT 'post',
221 ctarget in varchar2 DEFAULT NULL,
222 cenctype in varchar2 DEFAULT NULL,
223 cattributes in varchar2 DEFAULT NULL);
224
225 procedure formCheckbox(cname in varchar2,
226 cvalue in varchar2 character set any_cs DEFAULT 'on',
227 cchecked in varchar2 DEFAULT NULL,
228 cattributes in varchar2 DEFAULT NULL);
229 procedure formFile(cname in varchar2,
230 caccept in varchar2 DEFAULT NULL,
231 cattributes in varchar2 DEFAULT NULL);
232 procedure formHidden(cname in varchar2,
233 cvalue in varchar2 character set any_cs DEFAULT NULL,
234 cattributes in varchar2 DEFAULT NULL);
235 procedure formImage(cname in varchar2,
236 csrc in varchar2,
237 calign in varchar2 DEFAULT NULL,
238 cattributes in varchar2 DEFAULT NULL);
239 procedure formPassword(cname in varchar2,
240 csize in varchar2 DEFAULT NULL,
241 cmaxlength in varchar2 DEFAULT NULL,
242 cvalue in varchar2 character set any_cs DEFAULT NULL,
243 cattributes in varchar2 DEFAULT NULL);
244 procedure formRadio(cname in varchar2,
245 cvalue in varchar2 character set any_cs,
246 cchecked in varchar2 DEFAULT NULL,
247 cattributes in varchar2 DEFAULT NULL);
248 procedure formReset(cvalue in varchar2 character set any_cs DEFAULT 'Reset',
249 cattributes in varchar2 DEFAULT NULL);
250 procedure formSubmit(cname in varchar2 DEFAULT NULL,
251 cvalue in varchar2 character set any_cs DEFAULT 'Submit',
252 cattributes in varchar2 DEFAULT NULL);
253 procedure formText(cname in varchar2,
254 csize in varchar2 DEFAULT NULL,
255 cmaxlength in varchar2 DEFAULT NULL,
256 cvalue in varchar2 character set any_cs DEFAULT NULL,
257 cattributes in varchar2 DEFAULT NULL);
258
259 procedure formSelectOpen(cname in varchar2,
260 cprompt in varchar2 character set any_cs DEFAULT NULL,
261 nsize in integer DEFAULT NULL,
262 cattributes in varchar2 DEFAULT NULL);
263 procedure formSelectOption(cvalue in varchar2 character set any_cs,
264 cselected in varchar2 DEFAULT NULL,
265 cattributes in varchar2 DEFAULT NULL);
266 procedure formSelectClose;
267
268 procedure formTextarea(cname in varchar2,
269 nrows in integer,
270 ncolumns in integer,
271 calign in varchar2 DEFAULT NULL,
272 cattributes in varchar2 DEFAULT NULL);
273
274 procedure formTextarea2(cname in varchar2,
275 nrows in integer,
276 ncolumns in integer,
277 calign in varchar2 DEFAULT NULL,
278 cwrap in varchar2 DEFAULT NULL,
279 cattributes in varchar2 DEFAULT NULL);
280
281 procedure formTextareaOpen(cname in varchar2,
282 nrows in integer,
283 ncolumns in integer,
284 calign in varchar2 DEFAULT NULL,
285 cattributes in varchar2 DEFAULT NULL);
286
287 procedure formTextareaOpen2(cname in varchar2,
288 nrows in integer,
289 ncolumns in integer,
290 calign in varchar2 DEFAULT NULL,
291 cwrap in varchar2 DEFAULT NULL,
292 cattributes in varchar2 DEFAULT NULL);
293 procedure formTextareaClose;
294
295 procedure formClose;
296 /* END HTML FORMS */
297
298 /* HTML TABLES */
299 procedure tableOpen(cborder in varchar2 DEFAULT NULL,
300 calign in varchar2 DEFAULT NULL,
301 cnowrap in varchar2 DEFAULT NULL,
302 cclear in varchar2 DEFAULT NULL,
303 cattributes in varchar2 DEFAULT NULL);
304 procedure tableCaption(ccaption in varchar2 character set any_cs,
305 calign in varchar2 DEFAULT NULL,
306 cattributes in varchar2 DEFAULT NULL);
307 procedure tableRowOpen(calign in varchar2 DEFAULT NULL,
308 cvalign in varchar2 DEFAULT NULL,
309 cdp in varchar2 DEFAULT NULL,
310 cnowrap in varchar2 DEFAULT NULL,
311 cattributes in varchar2 DEFAULT NULL);
312 procedure tableHeader(cvalue in varchar2 character set any_cs DEFAULT NULL,
313 calign in varchar2 DEFAULT NULL,
314 cdp in varchar2 DEFAULT NULL,
315 cnowrap in varchar2 DEFAULT NULL,
316 crowspan in varchar2 DEFAULT NULL,
317 ccolspan in varchar2 DEFAULT NULL,
318 cattributes in varchar2 DEFAULT NULL);
319 procedure tableData(cvalue in varchar2 character set any_cs DEFAULT NULL,
320 calign in varchar2 DEFAULT NULL,
321 cdp in varchar2 DEFAULT NULL,
322 cnowrap in varchar2 DEFAULT NULL,
323 crowspan in varchar2 DEFAULT NULL,
324 ccolspan in varchar2 DEFAULT NULL,
325 cattributes in varchar2 DEFAULT NULL);
326 procedure tableRowClose;
327
328 procedure tableClose;
329 /* END HTML TABLES */
330
331 /* BEGIN HTML FRAMES - Netscape Extensions FRAMESET, FRAME tags */
332 procedure framesetOpen( crows in varchar2 DEFAULT NULL, /* row height value list */
333 ccols in varchar2 DEFAULT NULL,
334 cattributes in varchar2 DEFAULT NULL); /* column width list */
335 procedure framesetClose;
336 procedure frame( csrc in varchar2, /* URL */
337 cname in varchar2 DEFAULT NULL, /* Window Name */
338 cmarginwidth in varchar2 DEFAULT NULL, /* Value in pixels */
339 cmarginheight in varchar2 DEFAULT NULL, /* Value in pixels */
340 cscrolling in varchar2 DEFAULT NULL, /* yes | no | auto */
341 cnoresize in varchar2 DEFAULT NULL,
342 cattributes in varchar2 DEFAULT NULL); /* Not resizable by user */
343 procedure noframesOpen;
344 procedure noframesClose;
345
346 /* END FRAMES */
347
348 /* BEGIN SPECIAL HTML TAGS */
349 procedure appletOpen( ccode in varchar2,
350 cwidth in integer,
351 cheight in integer,
352 cattributes in varchar2 DEFAULT NULL);
353 procedure param( cname in varchar2,
354 cvalue in varchar2 character set any_cs);
355 procedure appletClose;
356
357 /* END BODY ELEMENT tags */
358
359 /* TYPES FOR htp.print */
360 -- PL/SQL table used for output buffering
361 HTBUF_LEN number := 255;
362 type htbuf_arr is table of varchar2(256) index by binary_integer;
363 type htraw_arr is table of raw(256) index by binary_integer;
364
365 /* SPECIAL PROCEDURES */
366 procedure init;
367 -- call addDefaultHTMLHdr(FALSE) before your first call
368 -- to prn or print to suppress HTML header generation
369 -- if not present
370 procedure addDefaultHTMLHdr(bAddHTMLHdr in boolean);
371 procedure flush;
372
373 /* Start of OAS specific helper procedures */
374 procedure flush_charset_convert (charset in varchar2);
375 procedure get_page_charset_convert (thepage out NOCOPY htbuf_arr,
376 irows in out integer, charset in varchar2);
377 /* End of OAS specific helper procedures */
378
379 function get_line (irows out integer) return varchar2;
380 procedure get_page (thepage out NOCOPY htbuf_arr, irows in out integer);
381
382 /* Add RAW transfer API */
383 procedure get_page_raw (thepage out NOCOPY htraw_arr, irows in out integer);
384 procedure showpage;
385 procedure reset_get_page;
386
387 /* Following procedures are for file download feature */
388 procedure download_file(sFileName in varchar2,
389 bCompress in boolean default false);
390 procedure get_download_files_list(sFilesList out varchar2,
391 nCompress out binary_integer);
392
393 -- Output Procedures
394 -- skwong: Added "character set any_cs"
395 procedure print (cbuf in varchar2 character set any_cs DEFAULT NULL);
396 procedure print (dbuf in date);
397 procedure print (nbuf in number);
398
399 -- Output without the newline
400 -- skwong: Added "character set any_cs"
401 procedure prn (cbuf in varchar2 character set any_cs DEFAULT NULL);
402 procedure prn (dbuf in date);
403 procedure prn (nbuf in number);
404
405 -- Abbrev call to print()
406 -- skwong: Added "character set any_cs"
407 procedure p (cbuf in varchar2 character set any_cs DEFAULT NULL);
408 procedure p (dbuf in date);
409 procedure p (nbuf in number);
410
411 -- Raw output functions
412 /* Allow direct writes of raw content, e.g. to produce images or
413 ** literally anything. */
414 procedure putraw (bbuf in raw, buflen pls_integer DEFAULT NULL);
415
416 procedure prints(ctext in varchar2 character set any_cs);
417 procedure ps(ctext in varchar2 character set any_cs);
418 procedure escape_sc(ctext in varchar2 character set any_cs);
419 procedure setHTTPCharset(iana_charset in varchar2,
420 ora_charset varchar2 default NULL);
421 procedure print_header(cbuf in varchar2, nline in number);
422 /* Set raw transfer mode */
423 procedure set_transfer_mode(tmode in varchar2);
424 /* END SPECIAL PROCEDURES */
425 end;
[Home] [Help]