2 # Common functions for generating HTML for Webmin user interface elements
4 ####################### table generation functions
6 # ui_table_start(heading, [tabletags], [cols], [&default-tds])
7 # A table with a heading and table inside
10 return &theme_ui_table_start(@_) if (defined(&theme_ui_table_start));
11 local ($heading, $tabletags, $cols, $tds) = @_;
12 if (defined($main::ui_table_cols)) {
13 # Push on stack, for nested call
14 push(@main::ui_table_cols_stack, $main::ui_table_cols);
15 push(@main::ui_table_pos_stack, $main::ui_table_pos);
16 push(@main::ui_table_default_tds_stack, $main::ui_table_default_tds);
19 $rv .= "<table class='ui_table' border $tabletags>\n";
20 $rv .= "<tr $tb> <td><b>$heading</b></td> </tr>\n" if (defined($heading));
21 $rv .= "<tr $cb> <td><table width=100%>\n";
22 $main::ui_table_cols = $cols || 4;
23 $main::ui_table_pos = 0;
24 $main::ui_table_default_tds = $tds;
29 # The end of a table started by ui_table_start
32 return &theme_ui_table_end(@_) if (defined(&theme_ui_table_end));
34 if ($main::ui_table_cols == 4 && $main::ui_table_pos) {
35 # Add an empty block to balance the table
36 $rv .= &ui_table_row(" ", " ");
38 if (@main::ui_table_cols_stack) {
39 $main::ui_table_cols = pop(@main::ui_table_cols_stack);
40 $main::ui_table_pos = pop(@main::ui_table_pos_stack);
41 $main::ui_table_default_tds = pop(@main::ui_table_default_tds_stack);
44 $main::ui_table_cols = undef;
45 $main::ui_table_pos = undef;
46 $main::ui_table_default_tds = undef;
48 $rv .= "</table></td></tr></table>\n";
52 # ui_columns_start(&headings, [width-percent], [noborder], [&tdtags], [heading])
53 # Returns HTML for a multi-column table, with the given headings
56 return &theme_ui_columns_start(@_) if (defined(&theme_ui_columns_start));
57 local ($heads, $width, $noborder, $tdtags, $heading) = @_;
59 $rv .= "<table".($noborder ? "" : " border").
60 (defined($width) ? " width=$width%" : "")." class='ui_columns'>\n";
62 $rv .= "<tr $tb><td colspan=".scalar(@$heads).
63 " class='ui_columns_heading'><b>$heading</b></td></tr>\n";
65 $rv .= "<tr $tb class='ui_columns_heads'>\n";
67 for($i=0; $i<@$heads; $i++) {
68 $rv .= "<td ".$tdtags->[$i]."><b>".
69 ($heads->[$i] eq "" ? "<br>" : $heads->[$i])."</b></td>\n";
75 # ui_columns_row(&columns, &tdtags)
76 # Returns HTML for a row in a multi-column table
79 return &theme_ui_columns_row(@_) if (defined(&theme_ui_columns_row));
80 local ($cols, $tdtags) = @_;
82 $rv .= "<tr $cb class='ui_columns_row'>\n";
84 for($i=0; $i<@$cols; $i++) {
85 $rv .= "<td ".$tdtags->[$i].">".
86 ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i])."</td>\n";
92 # ui_columns_header(&columns, &tdtags)
93 # Returns HTML for a row in a multi-column table, with a header background
96 return &theme_ui_columns_header(@_) if (defined(&theme_ui_columns_header));
97 local ($cols, $tdtags) = @_;
99 $rv .= "<tr $tb class='ui_columns_header'>\n";
101 for($i=0; $i<@$cols; $i++) {
102 $rv .= "<td ".$tdtags->[$i]."><b>".
103 ($cols->[$i] eq "" ? "<br>" : $cols->[$i])."</b></td>\n";
109 # ui_checked_columns_row(&columns, &tdtags, checkname, checkvalue, [checked?],
111 # Returns HTML for a row in a multi-column table, in which the first
112 # column is a checkbox
113 sub ui_checked_columns_row
115 return &theme_ui_checked_columns_row(@_) if (defined(&theme_ui_checked_columns_row));
116 local ($cols, $tdtags, $checkname, $checkvalue, $checked, $disabled) = @_;
118 $rv .= "<tr $cb class='ui_checked_columns'>\n";
119 $rv .= "<td class='ui_checked_checkbox' ".$tdtags->[0].">".
120 &ui_checkbox($checkname, $checkvalue, undef, $checked, undef, $disabled).
123 for($i=0; $i<@$cols; $i++) {
124 $rv .= "<td ".$tdtags->[$i+1].">";
125 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
126 $rv .= "<label for=\"".
127 "e_escape("${checkname}_${checkvalue}")."\">";
129 $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
130 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
139 # ui_radio_columns_row(&columns, &tdtags, checkname, checkvalue, [checked])
140 # Returns HTML for a row in a multi-column table, in which the first
141 # column is a radio button
142 sub ui_radio_columns_row
144 return &theme_ui_radio_columns_row(@_) if (defined(&theme_ui_radio_columns_row));
145 local ($cols, $tdtags, $checkname, $checkvalue, $checked) = @_;
147 $rv .= "<tr $cb class='ui_radio_columns'>\n";
148 $rv .= "<td class='ui_radio_radio' ".$tdtags->[0].">".
149 &ui_oneradio($checkname, $checkvalue, "", $checked)."</td>\n";
151 for($i=0; $i<@$cols; $i++) {
152 $rv .= "<td ".$tdtags->[$i+1].">";
153 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
154 $rv .= "<label for=\"".
155 "e_escape("${checkname}_${checkvalue}")."\">";
157 $rv .= ($cols->[$i] !~ /\S/ ? "<br>" : $cols->[$i]);
158 if ($cols->[$i] !~ /<a\s+href|<input|<select|<textarea/) {
168 # Returns HTML to end a table started by ui_columns_start
171 return &theme_ui_columns_end(@_) if (defined(&theme_ui_columns_end));
175 ####################### form generation functions
177 # ui_form_start(script, method, [target], [tags])
178 # Returns HTML for a form that submits to some script
181 return &theme_ui_form_start(@_) if (defined(&theme_ui_form_start));
182 local ($script, $method, $target, $tags) = @_;
184 $rv .= "<form class='ui_form' action='".&html_escape($script)."' ".
185 ($method eq "post" ? "method=post" :
186 $method eq "form-data" ?
187 "method=post enctype=multipart/form-data" :
189 ($target ? " target=$target" : "").
195 # ui_form_end([&buttons], [width])
196 # Returns HTML for the end of a form, optionally with a row of submit buttons
199 return &theme_ui_form_end(@_) if (defined(&theme_ui_form_end));
200 local ($buttons, $width) = @_;
202 if ($buttons && @$buttons) {
203 $rv .= "<table class='ui_form_end_buttons' ".($width ? " width=$width" : "")."><tr>\n";
205 foreach $b (@$buttons) {
207 $rv .= "<td".(!$width ? "" :
208 $b eq $buttons->[0] ? " align=left" :
209 $b eq $buttons->[@$buttons-1] ?
210 " align=right" : " align=center").">".
211 &ui_submit($b->[1], $b->[0], $b->[3], $b->[4]).
212 ($b->[2] ? " ".$b->[2] : "")."</td>\n";
215 $rv .= "<td>$b</td>\n";
218 $rv .= "<td> </td>\n";
221 $rv .= "</tr></table>\n";
227 # ui_textbox(name, value, size, [disabled?], [maxlength], [tags])
228 # Returns HTML for a text input
231 return &theme_ui_textbox(@_) if (defined(&theme_ui_textbox));
232 local ($name, $value, $size, $dis, $max, $tags) = @_;
233 $size = &ui_max_text_width($size);
234 return "<input name=\""."e_escape($name)."\" ".
235 "value=\""."e_escape($value)."\" ".
236 "size=$size ".($dis ? "disabled=true" : "").
237 ($max ? " maxlength=$max" : "").
242 # ui_bytesbox(name, bytes, [size], [disabled?])
243 # Returns HTML for entering a number of bytes, but with friendly kB/MB/GB
244 # options. May truncate values to 2 decimal points!
247 local ($name, $bytes, $size, $dis) = @_;
249 if ($bytes >= 10*1024*1024*1024) {
250 $units = 1024*1024*1024;
252 elsif ($bytes >= 10*1024*1024) {
255 elsif ($bytes >= 10*1024) {
262 $bytes = sprintf("%.2f", ($bytes*1.0)/$units);
265 $size = &ui_max_text_width($size || 8);
266 return &ui_textbox($name, $bytes, $size, $dis)." ".
267 &ui_select($name."_units", $units,
268 [ [ 1, "bytes" ], [ 1024, "kB" ], [ 1024*1024, "MB" ],
269 [ 1024*1024*1024, "GB" ] ], undef, undef, undef, $dis);
272 # ui_upload(name, size, [disabled?], [tags])
273 # Returns HTML for a file upload input
276 return &theme_ui_upload(@_) if (defined(&theme_ui_upload));
277 local ($name, $size, $dis, $tags) = @_;
278 $size = &ui_max_text_width($size);
279 return "<input type=file name=\""."e_escape($name)."\" ".
281 ($dis ? "disabled=true" : "").
282 ($tags ? " ".$tags : "").">";
285 # ui_password(name, value, size, [disabled?], [maxlength])
286 # Returns HTML for a password text input
289 return &theme_ui_password(@_) if (defined(&theme_ui_password));
290 local ($name, $value, $size, $dis, $max) = @_;
291 $size = &ui_max_text_width($size);
292 return "<input type=password name=\""."e_escape($name)."\" ".
293 "value=\""."e_escape($value)."\" ".
294 "size=$size ".($dis ? "disabled=true" : "").
295 ($max ? " maxlength=$max" : "").
299 # ui_hidden(name, value)
300 # Returns HTML for a hidden field
303 return &theme_ui_hidden(@_) if (defined(&theme_ui_hidden));
304 local ($name, $value) = @_;
305 return "<input type=hidden name=\""."e_escape($name)."\" ".
306 "value=\""."e_escape($value)."\">\n";
309 # ui_select(name, value|&values, &options, [size], [multiple],
310 # [add-if-missing], [disabled?], [javascript])
311 # Returns HTML for a drop-down menu or multiple selection list
314 return &theme_ui_select(@_) if (defined(&theme_ui_select));
315 local ($name, $value, $opts, $size, $multiple, $missing, $dis, $js) = @_;
317 $rv .= "<select name=\""."e_escape($name)."\"".
318 ($size ? " size=$size" : "").
319 ($multiple ? " multiple" : "").
320 ($dis ? " disabled=true" : "")." ".$js.">\n";
321 local ($o, %opt, $s);
322 local %sel = ref($value) ? ( map { $_, 1 } @$value ) : ( $value, 1 );
323 foreach $o (@$opts) {
324 $o = [ $o ] if (!ref($o));
325 $rv .= "<option value=\""."e_escape($o->[0])."\"".
326 ($sel{$o->[0]} ? " selected" : "").">".
327 ($o->[1] || $o->[0])."\n";
330 foreach $s (keys %sel) {
331 if (!$opt{$s} && $missing) {
332 $rv .= "<option value=\""."e_escape($s)."\"".
333 "selected>".($s eq "" ? " " : $s)."\n";
336 $rv .= "</select>\n";
340 # ui_radio(name, value, &options, [disabled?])
341 # Returns HTML for a series of radio buttons
344 return &theme_ui_radio(@_) if (defined(&theme_ui_radio));
345 local ($name, $value, $opts, $dis) = @_;
348 foreach $o (@$opts) {
349 local $id = "e_escape($name."_".$o->[0]);
350 local $label = $o->[1] || $o->[0];
352 if ($label =~ /^(.*?)((<a\s+href|<input|<select|<textarea)[\000-\377]*)$/i) {
356 $rv .= "<input type=radio name=\""."e_escape($name)."\" ".
357 "value=\""."e_escape($o->[0])."\"".
358 ($o->[0] eq $value ? " checked" : "").
359 ($dis ? " disabled=true" : "").
361 " $o->[2]> <label for=\"$id\">".
362 $label."</label>".$after."\n";
367 # ui_yesno_radio(name, value, [yes], [no], [disabled?])
368 # Like ui_yesno, but always displays just two inputs (yes and no)
371 local ($name, $value, $yes, $no, $dis) = @_;
372 return &theme_ui_yesno_radio(@_) if (defined(&theme_ui_yesno_radio));
373 $yes = 1 if (!defined($yes));
374 $no = 0 if (!defined($no));
375 $value = int($value);
376 return &ui_radio($name, $value, [ [ $yes, $text{'yes'} ],
377 [ $no, $text{'no'} ] ], $dis);
380 # ui_checkbox(name, value, label, selected?, [tags], [disabled?])
381 # Returns HTML for a single checkbox
384 return &theme_ui_checkbox(@_) if (defined(&theme_ui_checkbox));
385 local ($name, $value, $label, $sel, $tags, $dis) = @_;
387 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
391 return "<input type=checkbox name=\""."e_escape($name)."\" ".
392 "value=\""."e_escape($value)."\" ".
393 ($sel ? " checked" : "").($dis ? " disabled=true" : "").
394 " id=\""."e_escape("${name}_${value}")."\"".
396 ($label eq "" ? $after :
397 "<label for=\""."e_escape("${name}_${value}").
398 "\">$label</label>$after")."\n";
401 # ui_oneradio(name, value, label, selected?, [tags], [disabled?])
402 # Returns HTML for a single radio button
405 return &theme_ui_oneradio(@_) if (defined(&theme_ui_oneradio));
406 local ($name, $value, $label, $sel, $tags, $dis) = @_;
407 local $id = "e_escape("${name}_${value}");
409 if ($label =~ /^([^<]*)(<[\000-\377]*)$/) {
413 return "<input type=radio name=\""."e_escape($name)."\" ".
414 "value=\""."e_escape($value)."\" ".
415 ($sel ? " checked" : "").($dis ? " disabled=true" : "").
417 " $tags> <label for=\"$id\">$label</label>$after\n";
420 # ui_textarea(name, value, rows, cols, [wrap], [disabled?], [tags])
421 # Returns HTML for a multi-line text input
424 return &theme_ui_textarea(@_) if (defined(&theme_ui_textarea));
425 local ($name, $value, $rows, $cols, $wrap, $dis, $tags) = @_;
426 $cols = &ui_max_text_width($cols, 1);
427 return "<textarea name=\""."e_escape($name)."\" ".
428 "rows=$rows cols=$cols".($wrap ? " wrap=$wrap" : "").
429 ($dis ? " disabled=true" : "").
430 ($tags ? " $tags" : "").">".
431 &html_escape($value).
435 # ui_user_textbox(name, value, [form], [disabled?], [tags])
436 # Returns HTML for a Unix user input
439 return &theme_ui_user_textbox(@_) if (defined(&theme_ui_user_textbox));
440 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
441 &user_chooser_button($_[0], 0, $_[2]);
444 # ui_group_textbox(name, value, [form], [disabled?], [tags])
445 # Returns HTML for a Unix group input
448 return &theme_ui_group_textbox(@_) if (defined(&theme_ui_group_textbox));
449 return &ui_textbox($_[0], $_[1], 13, $_[3], undef, $_[4])." ".
450 &group_chooser_button($_[0], 0, $_[2]);
453 # ui_opt_textbox(name, value, size, option1, [option2], [disabled?],
454 # [&extra-fields], [max])
455 # Returns HTML for a text field that is optional
458 return &theme_ui_opt_textbox(@_) if (defined(&theme_ui_opt_textbox));
459 local ($name, $value, $size, $opt1, $opt2, $dis, $extra, $max) = @_;
460 local $dis1 = &js_disable_inputs([ $name, @$extra ], [ ]);
461 local $dis2 = &js_disable_inputs([ ], [ $name, @$extra ]);
463 $size = &ui_max_text_width($size);
464 $rv .= &ui_radio($name."_def", $value eq '' ? 1 : 0,
465 [ [ 1, $opt1, "onClick='$dis1'" ],
466 [ 0, $opt2 || " ", "onClick='$dis2'" ] ], $dis)."\n";
467 $rv .= "<input name=\""."e_escape($name)."\" ".
468 "size=$size value=\""."e_escape($value)."\" ".
469 ($value eq "" || $dis ? "disabled=true" : "").
470 ($max ? " maxlength=$max" : "").">\n";
474 # ui_submit(label, [name], [disabled?], [tags])
475 # Returns HTML for a form submit button
478 return &theme_ui_submit(@_) if (defined(&theme_ui_submit));
479 local ($label, $name, $dis, $tags) = @_;
480 return "<input type=submit".
481 ($name ne '' ? " name=\""."e_escape($name)."\"" : "").
482 " value=\""."e_escape($label)."\"".
483 ($dis ? " disabled=true" : "").
484 ($tags ? " ".$tags : "").">\n";
488 # ui_reset(label, [disabled?])
489 # Returns HTML for a form reset button
492 return &theme_ui_reset(@_) if (defined(&theme_ui_reset));
493 local ($label, $dis) = @_;
494 return "<input type=reset value=\""."e_escape($label)."\"".
495 ($dis ? " disabled=true" : "").">\n";
499 # ui_button(label, [name], [disabled?], [tags])
500 # Returns HTML for a form button
503 return &theme_ui_button(@_) if (defined(&theme_ui_button));
504 local ($label, $name, $dis, $tags) = @_;
505 return "<input type=button".
506 ($name ne '' ? " name=\""."e_escape($name)."\"" : "").
507 " value=\""."e_escape($label)."\"".
508 ($dis ? " disabled=true" : "").
509 ($tags ? " ".$tags : "").">\n";
512 # ui_date_input(day, month, year, day-name, month-name, year-name, [disabled?])
513 # Returns HTML for a date-selection field
516 local ($day, $month, $year, $dayname, $monthname, $yearname, $dis) = @_;
518 $rv .= &ui_textbox($dayname, $day, 3, $dis);
520 $rv .= &ui_select($monthname, $month,
521 [ map { [ $_, $text{"smonth_$_"} ] } (1 .. 12) ],
524 $rv .= &ui_textbox($yearname, $year, 5, $dis);
528 # ui_table_row(label, value, [cols], [&td-tags])
529 # Returns HTML for a row in a table started by ui_table_start, with a 1-column
530 # label and 1+ column value.
533 return &theme_ui_table_row(@_) if (defined(&theme_ui_table_row));
534 local ($label, $value, $cols, $tds) = @_;
536 $tds ||= $main::ui_table_default_tds;
538 if ($main::ui_table_pos+$cols+1 > $main::ui_table_cols &&
539 $main::ui_table_pos != 0) {
540 # If the requested number of cols won't fit in the number
541 # remaining, start a new row
543 $main::ui_table_pos = 0;
545 $rv .= "<tr>\n" if ($main::ui_table_pos%$main::ui_table_cols == 0);
546 $rv .= "<td valign=top $tds->[0]><b>$label</b></td>\n" if (defined($label));
547 $rv .= "<td valign=top colspan=$cols $tds->[1]>$value</td>\n";
548 $main::ui_table_pos += $cols+(defined($label) ? 1 : 0);
549 if ($main::ui_table_pos%$main::ui_table_cols == 0) {
551 $main::ui_table_pos = 0;
559 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
565 $rv .= "<tr> <td colspan=$main::ui_table_cols><hr></td> </tr>\n";
569 # ui_table_span(text)
570 # Outputs a table row that spans the whole table, and contains the given text
574 return &theme_ui_table_hr(@_) if (defined(&theme_ui_table_hr));
580 $rv .= "<tr> <td colspan=$main::ui_table_cols>$text</td> </tr>\n";
587 return &theme_ui_buttons_start(@_) if (defined(&theme_ui_buttons_start));
588 return "<table width=100%>\n";
594 return &theme_ui_buttons_end(@_) if (defined(&theme_ui_buttons_end));
598 # ui_buttons_row(script, button-label, description, [hiddens], [after-submit],
602 return &theme_ui_buttons_row(@_) if (defined(&theme_ui_buttons_row));
603 local ($script, $label, $desc, $hiddens, $after, $before) = @_;
604 return "<form action=$script>\n".
606 "<tr> <td nowrap width=20% valign=top>".($before ? $before." " : "").
607 &ui_submit($label).($after ? " ".$after : "")."</td>\n".
608 "<td valign=top width=80% valign=top>$desc</td> </tr>\n".
612 # ui_buttons_hr([title])
616 return &theme_ui_buttons_hr(@_) if (defined(&theme_ui_buttons_hr));
618 return "<tr> <td colspan=2><table cellpadding=0 cellspacing=0 width=100%><tr> <td width=50%><hr></td> <td nowrap>$title</td> <td width=50%><hr></td> </tr></table></td> </tr>\n";
621 return "<tr> <td colspan=2><hr></td> </tr>\n";
625 ####################### header and footer functions
627 # ui_post_header([subtext])
628 # Returns HTML to appear directly after a standard header() call
631 return &theme_ui_post_header(@_) if (defined(&theme_ui_post_header));
634 $rv .= "<center class='ui_post_header'><font size=+1>$text</font></center>\n" if (defined($text));
635 if (!$tconfig{'nohr'} && !$tconfig{'notophr'}) {
636 $rv .= "<hr id='post_header_hr'>\n";
642 # Returns HTML to appear directly before a standard footer() call
645 return &theme_ui_pre_footer(@_) if (defined(&theme_ui_pre_footer));
647 if (!$tconfig{'nohr'} && !$tconfig{'nobottomhr'}) {
648 $rv .= "<hr id='pre_footer_hr'>\n";
653 # ui_print_header(subtext, args...)
654 # Print HTML for a header with the post-header line. The args are the same
655 # as those passed to header()
658 &load_theme_library();
659 return &theme_ui_print_header(@_) if (defined(&theme_ui_print_header));
660 local ($text, @args) = @_;
662 print &ui_post_header($text);
665 # ui_print_unbuffered_header(subtext, args...)
666 # Like ui_print_header, but ensures that output for this page is not buffered
667 # or contained in a table.
668 sub ui_print_unbuffered_header
670 &load_theme_library();
671 return &theme_ui_print_unbuffered_header(@_) if (defined(&theme_ui_print_unbuffered_header));
674 &ui_print_header(@_);
677 # ui_print_footer(args...)
678 # Print HTML for a footer with the pre-footer line. Args are the same as those
682 return &theme_ui_print_footer(@_) if (defined(&theme_ui_print_footer));
684 print &ui_pre_footer();
688 # ui_config_link(text, &subs)
689 # Returns HTML for a module config link. The first non-null sub will be
690 # replaced with the appropriate URL.
693 return &theme_ui_config_link(@_) if (defined(&theme_ui_config_link));
694 local ($text, $subs) = @_;
695 local @subs = map { $_ || "../config.cgi?$module_name" }
696 ($subs ? @$subs : ( undef ));
697 return "<p>".&text($text, @subs)."<p>\n";
700 # ui_print_endpage(text)
701 # Prints HTML for an error message followed by a page footer with a link to
702 # /, then exits. Good for main page error messages.
705 return &theme_ui_print_endpage(@_) if (defined(&theme_ui_print_endpage));
707 print $text,"<p class='ui_footer'>\n";
709 &ui_print_footer("/", $text{'index'});
713 # ui_subheading(text, ...)
714 # Returns HTML for a section heading
717 return &theme_ui_subheading(@_) if (defined(&theme_ui_subheading));
718 return "<h3 class='ui_subheading'>".join("", @_)."</h3>\n";
721 # ui_links_row(&links)
722 # Returns HTML for a row of links, like select all / invert selection / add..
725 return &theme_ui_links_row(@_) if (defined(&theme_ui_links_row));
727 return @$links ? join("\n|\n", @$links)."<br>\n"
731 ########################### collapsible section / tab functions
733 # ui_hidden_javascript()
734 # Returns <script> and <style> sections for hiding functions and CSS
735 sub ui_hidden_javascript
737 return &theme_ui_hidden_javascript(@_)
738 if (defined(&theme_ui_hidden_javascript));
740 local $imgdir = "$gconfig{'webprefix'}/images";
741 local ($jscb, $jstb) = ($cb, $tb);
747 .opener_shown {display:inline}
748 .opener_hidden {display:none}
751 // Open or close a hidden section
752 function hidden_opener(divid, openerid)
754 var divobj = document.getElementById(divid);
755 var openerobj = document.getElementById(openerid);
756 if (divobj.className == 'opener_shown') {
757 divobj.className = 'opener_hidden';
758 openerobj.innerHTML = '<img border=0 src=$imgdir/closed.gif>';
761 divobj.className = 'opener_shown';
762 openerobj.innerHTML = '<img border=0 src=$imgdir/open.gif>';
767 function select_tab(name, tabname, form)
769 var tabnames = document[name+'_tabnames'];
770 var tabtitles = document[name+'_tabtitles'];
771 for(var i=0; i<tabnames.length; i++) {
772 var tabobj = document.getElementById('tab_'+tabnames[i]);
773 var divobj = document.getElementById('div_'+tabnames[i]);
774 var title = tabtitles[i];
775 if (tabnames[i] == tabname) {
777 tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
778 '<td valign=top $jscb>'+
779 '<img src=$imgdir/lc2.gif alt=""></td>'+
781 ' <b>'+title+'</b> </td>'+
782 '<td valign=top $jscb>'+
783 '<img src=$imgdir/rc2.gif alt=""></td>'+
785 divobj.className = 'opener_shown';
789 tabobj.innerHTML = '<table cellpadding=0 cellspacing=0><tr>'+
790 '<td valign=top $jstb>'+
791 '<img src=$imgdir/lc1.gif alt=""></td>'+
793 ' <a href=\\'\\' onClick=\\'return select_tab("'+
794 name+'", "'+tabnames[i]+'")\\'>'+title+'</a> </td>'+
795 '<td valign=top $jstb>'+
796 '<img src=$imgdir/rc1.gif alt=""></td>'+
798 divobj.className = 'opener_hidden';
801 if (document.forms[0] && document.forms[0][name]) {
802 document.forms[0][name].value = tabname;
810 # ui_hidden_start(title, name, status, thisurl)
811 # Returns HTML for the start of a collapsible hidden section, such as for
815 return &theme_ui_hidden_start(@_) if (defined(&theme_ui_hidden_start));
816 local ($title, $name, $status, $url) = @_;
818 if (!$main::ui_hidden_start_donejs++) {
819 $rv .= &ui_hidden_javascript();
821 local $divid = "hiddendiv_$name";
822 local $openerid = "hiddenopener_$name";
823 local $defimg = $status ? "open.gif" : "closed.gif";
824 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
825 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg' alt='*'></a>\n";
826 $rv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
827 $rv .= "<div class='$defclass' id='$divid'>\n";
831 # ui_hidden_end(name)
832 # Returns HTML for the end of a hidden section
835 return &theme_ui_hidden_end(@_) if (defined(&theme_ui_hidden_end));
840 # ui_hidden_table_row_start(title, name, status, thisurl)
841 # Similar to ui_hidden_start, but for use within a table started with
843 sub ui_hidden_table_row_start
845 return &theme_ui_hidden_table_row_start(@_)
846 if (defined(&theme_ui_hidden_table_row_start));
847 local ($title, $name, $status, $url) = @_;
849 if (!$main::ui_hidden_start_donejs++) {
850 $rv .= &ui_hidden_javascript();
852 local $divid = "hiddendiv_$name";
853 local $openerid = "hiddenopener_$name";
854 local $defimg = $status ? "open.gif" : "closed.gif";
855 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
856 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a>\n";
857 $rrv .= "<a href=\"javascript:hidden_opener('$divid', '$openerid')\">$title</a><br>\n";
858 $rv .= &ui_table_row(undef, $rrv, $main::ui_table_cols);
860 $rv .= "<div class='$defclass' id='$divid'>\n";
861 $rv .= "<table width=100%>\n";
865 # ui_hidden_table_row_end(name)
866 sub ui_hidden_table_row_end
868 return &theme_ui_hidden_table_row_end(@_)
869 if (defined(&theme_ui_hidden_table_row_end));
871 return "</table></div><table width=100%>\n";
874 # ui_hidden_table_start(heading, [tabletags], [cols], name, status,
876 # A table with a heading and table inside, and which is collapsible
877 sub ui_hidden_table_start
879 return &theme_ui_hidden_table_start(@_)
880 if (defined(&theme_ui_hidden_table_start));
881 local ($heading, $tabletags, $cols, $name, $status, $tds) = @_;
883 if (!$main::ui_hidden_start_donejs++) {
884 $rv .= &ui_hidden_javascript();
886 local $divid = "hiddendiv_$name";
887 local $openerid = "hiddenopener_$name";
888 local $defimg = $status ? "open.gif" : "closed.gif";
889 local $defclass = $status ? 'opener_shown' : 'opener_hidden';
890 local $text = defined($tconfig{'cs_text'}) ? $tconfig{'cs_text'} :
891 defined($gconfig{'cs_text'}) ? $gconfig{'cs_text'} : "000000";
892 $rv .= "<table class='ui_table' border $tabletags class='ui_table'>\n";
893 $rv .= "<tr $tb> <td><a href=\"javascript:hidden_opener('$divid', '$openerid')\" id='$openerid'><img border=0 src='$gconfig{'webprefix'}/images/$defimg'></a> <a href=\"javascript:hidden_opener('$divid', '$openerid')\"><b><font color=#$text>$heading</font></b></a></td> </tr>\n" if (defined($heading));
894 $rv .= "<tr $cb> <td><div class='$defclass' id='$divid'><table width=100%>\n";
895 $main::ui_table_cols = $cols || 4;
896 $main::ui_table_pos = 0;
897 $main::ui_table_default_tds = $tds;
901 # ui_hidden_table_end(name)
902 # Returns HTML for the end of table with hiding, as started by
903 # ui_hidden_table_start
904 sub ui_hidden_table_end
907 return &theme_ui_hidden_table_end(@_) if (defined(&theme_ui_hidden_table_end));
908 return "</table></div></td></tr></table>\n";
911 # ui_tabs_start(&tabs, name, selected, show-border)
912 # Render a row of tabs from which one can be selected. Each tab is an array
913 # ref containing a name, title and link.
916 return &theme_ui_tabs_start(@_) if (defined(&theme_ui_tabs_start));
917 local ($tabs, $name, $sel, $border) = @_;
919 if (!$main::ui_hidden_start_donejs++) {
920 $rv .= &ui_hidden_javascript();
923 # Build list of tab titles and names
924 local $tabnames = "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$tabs)."]";
925 local $tabtitles = "[".join(",", map { "\"".&html_escape($_->[1])."\"" } @$tabs)."]";
927 $rv .= "document.${name}_tabnames = $tabnames;\n";
928 $rv .= "document.${name}_tabtitles = $tabtitles;\n";
929 $rv .= "</script>\n";
932 local $imgdir = "$gconfig{'webprefix'}/images";
933 $rv .= &ui_hidden($name, $sel)."\n";
934 $rv .= "<table border=0 cellpadding=0 cellspacing=0>\n";
935 $rv .= "<tr><td bgcolor=#ffffff colspan=".(scalar(@$tabs)*2+1).">";
936 if ($ENV{'HTTP_USER_AGENT'} !~ /msie/i) {
937 # For some reason, the 1-pixel space above the tabs appears huge on IE!
938 $rv .= "<img src=$imgdir/1x1.gif>";
940 $rv .= "</td></tr>\n";
942 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
943 foreach my $t (@$tabs) {
944 if ($t ne $tabs[0]) {
946 $rv .= "<td width=2 bgcolor=#ffffff>".
947 "<img src=$imgdir/1x1.gif></td>\n";
949 local $tabid = "tab_".$t->[0];
950 $rv .= "<td id=${tabid}>";
951 $rv .= "<table cellpadding=0 cellspacing=0 border=0><tr>";
952 if ($t->[0] eq $sel) {
954 $rv .= "<td valign=top $cb>".
955 "<img src=$imgdir/lc2.gif alt=\"\"></td>";
956 $rv .= "<td $cb nowrap>".
957 " <b>$t->[1]</b> </td>";
958 $rv .= "<td valign=top $cb>".
959 "<img src=$imgdir/rc2.gif alt=\"\"></td>";
962 # Other tab (which has a link)
963 $rv .= "<td valign=top $tb>".
964 "<img src=$imgdir/lc1.gif alt=\"\"></td>";
965 $rv .= "<td $tb nowrap>".
966 " <a href='$t->[2]' ".
967 "onClick='return select_tab(\"$name\", \"$t->[0]\")'>".
968 "$t->[1]</a> </td>";
969 $rv .= "<td valign=top $tb>".
970 "<img src=$imgdir/rc1.gif ".
974 $rv .= "</tr></table>";
977 $rv .= "<td bgcolor=#ffffff width=1><img src=$imgdir/1x1.gif></td>\n";
981 # All tabs are within a grey box
982 $rv .= "<table width=100% cellpadding=0 cellspacing=0 border=0>\n";
983 $rv .= "<tr> <td bgcolor=#ffffff rowspan=3 width=1><img src=$imgdir/1x1.gif></td>\n";
984 $rv .= "<td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
985 $rv .= "<tr> <td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
986 $rv .= "<td valign=top>";
988 $main::ui_tabs_selected = $sel;
992 # ui_tabs_end(border)
995 return &theme_ui_tabs_end(@_) if (defined(&theme_ui_tabs_end));
996 local ($border) = @_;
998 local $imgdir = "$gconfig{'webprefix'}/images";
1001 $rv .= "<td $cb width=2><img src=$imgdir/1x1.gif></td>\n";
1003 $rv .= "<tr> <td $cb colspan=3 height=2><img src=$imgdir/1x1.gif></td> </tr>\n";
1004 $rv .= "</table>\n";
1009 # ui_tabs_start_tab(name, tab)
1010 # Must be called before outputting the HTML for the named tab
1011 sub ui_tabs_start_tab
1013 return &theme_ui_tabs_start_tab(@_) if (defined(&theme_ui_tabs_start_tab));
1014 local ($name, $tab) = @_;
1015 local $defclass = $tab eq $main::ui_tabs_selected ?
1016 'opener_shown' : 'opener_hidden';
1017 local $rv = "<div id='div_$tab' class='$defclass'>\n";
1021 # ui_tabs_start_tabletab(name, tab)
1022 # Behaves like ui_tabs_start_tab, but for use within a ui_table_start block
1023 sub ui_tabs_start_tabletab
1025 return &theme_ui_tabs_start_tabletab(@_)
1026 if (defined(&theme_ui_tabs_start_tabletab));
1027 local $div = &ui_tabs_start_tab(@_);
1028 return "</table>\n".$div."<table width=100%>\n";
1033 return &theme_ui_tabs_end_tab(@_) if (defined(&theme_ui_tabs_end_tab));
1037 sub ui_tabs_end_tabletab
1039 return &theme_ui_tabs_end_tabletab(@_)
1040 if (defined(&theme_ui_tabs_end_tabletab));
1041 return "</table></div><table width=100%>\n";
1044 # ui_max_text_width(width, [text-area?])
1045 # Returns a new width for a text field, based on theme settings
1046 sub ui_max_text_width
1048 local ($w, $ta) = @_;
1049 local $max = $ta ? $tconfig{'maxareawidth'} : $tconfig{'maxboxwidth'};
1050 return $max && $w > $max ? $max : $w;
1053 ####################### radio hidden functions
1055 # ui_radio_selector(&opts, name, selected)
1056 # Returns HTML for a set of radio buttons, each of which shows a different
1057 # block of HTML when selected. &opts is an array ref to arrays containing
1058 # [ value, label, html ]
1059 sub ui_radio_selector
1061 return &theme_ui_radio_selector(@_) if (defined(&theme_ui_radio_selector));
1062 local ($opts, $name, $sel) = @_;
1064 if (!$main::ui_radio_selector_donejs++) {
1065 $rv .= &ui_radio_selector_javascript();
1068 "[".join(",", map { "\"".&html_escape($_->[0])."\"" } @$opts)."]";
1069 foreach my $o (@$opts) {
1070 $rv .= &ui_oneradio($name, $o->[0], $o->[1], $sel eq $o->[0],
1071 "onClick='selector_show(\"$name\", \"$o->[0]\", $optnames)'");
1074 foreach my $o (@$opts) {
1075 local $cls = $o->[0] eq $sel ? "selector_shown" : "selector_hidden";
1076 $rv .= "<div id=sel_${name}_$o->[0] class=$cls>".$o->[2]."</div>\n";
1081 sub ui_radio_selector_javascript
1085 .selector_shown {display:inline}
1086 .selector_hidden {display:none}
1089 function selector_show(name, value, values)
1091 for(var i=0; i<values.length; i++) {
1092 var divobj = document.getElementById('sel_'+name+'_'+values[i]);
1093 divobj.className = value == values[i] ? 'selector_shown'
1094 : 'selector_hidden';
1101 ####################### grid layout functions
1103 # ui_grid_table(&elements, columns, [width-percent], [tds], [tabletags],
1105 # Given a list of HTML elements, formats them into a table with the given
1106 # number of columns. However, themes are free to override this to use fewer
1107 # columns where space is limited.
1110 return &theme_ui_grid_table(@_) if (defined(&theme_ui_grid_table));
1111 local ($elements, $cols, $width, $tds, $tabletags, $title) = @_;
1112 return "" if (!@$elements);
1113 local $rv = "<table".
1114 ($width ? " width=$width%" : "").
1115 ($tabletags ? " ".$tabletags : "").
1118 for($i=0; $i<@$elements; $i++) {
1119 $rv .= "<tr>" if ($i%$cols == 0);
1120 $rv .= "<td ".$tds->[$i%$cols]." valign=top>".$elements->[$i]."</td>\n";
1121 $rv .= "</tr>" if ($i%$cols == $cols-1);
1125 $rv .= "<td ".$tds->[$i%$cols]."><br></td>\n";
1130 $rv .= "</table>\n";
1131 if (defined($title)) {
1132 $rv = "<table class=ui_table border ".
1133 ($width ? " width=$width%" : "").">\n".
1134 ($title ? "<tr $tb> <td><b>$title</b></td> </tr>\n" : "").
1135 "<tr $cb> <td>$rv</td> </tr>\n".
1141 # ui_radio_table(name, selected, &rows)
1142 # Returns HTML for a table of radio buttons, each of which has a label and
1143 # some associated inputs to the right.
1146 return &theme_ui_radio_table(@_) if (defined(&theme_ui_radio_table));
1147 local ($name, $sel, $rows) = @_;
1148 return "" if (!@$rows);
1149 local $rv = "<table>\n";
1150 foreach my $r (@$rows) {
1152 $rv .= "<td valign=top><b>".&ui_oneradio($name, $r->[0], $r->[1],
1153 $r->[0] eq $sel)."</b></td>\n";
1154 $rv .= "<td valign=top>".$r->[2]."</td>\n";
1157 $rv .= "</table>\n";
1161 # ui_up_down_arrows(uplink, downlink, up-show, down-show)
1162 # Returns HTML for moving some objects in a table up or down
1163 sub ui_up_down_arrows
1165 return &theme_ui_up_down_arrows(@_) if (defined(&theme_ui_up_down_arrows));
1166 local ($uplink, $downlink, $upshow, $downshow) = @_;
1168 local $imgdir = "$gconfig{'webprefix'}/images";
1170 $mover .= "<a href=\"$downlink\">".
1171 "<img src=$imgdir/movedown.gif border=0></a>";
1174 $mover .= "<img src=$imgdir/movegap.gif>";
1177 $mover .= "<a href=\"$uplink\">".
1178 "<img src=$imgdir/moveup.gif border=0></a>";
1181 $mover .= "<img src=$imgdir/movegap.gif>";
1186 ####################### javascript functions
1188 # js_disable_input(&disable-inputs, &enable-inputs, [tag])
1189 # Returns Javascript to disable some form elements and enable others
1190 sub js_disable_inputs
1194 foreach $f (@{$_[0]}) {
1195 $rv .= "e = form.elements[\"$f\"]; e.disabled = true; ";
1196 $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = true; } ";
1198 foreach $f (@{$_[1]}) {
1199 $rv .= "e = form.elements[\"$f\"]; e.disabled = false; ";
1200 $rv .= "for(i=0; i<e.length; i++) { e[i].disabled = false; } ";
1202 foreach $f (@{$_[1]}) {
1203 if ($f =~ /^(.*)_def$/ && &indexof($1, @{$_[1]}) >= 0) {
1204 # When enabling both a _def field and its associated text field,
1205 # disable the text if the _def is set to 1
1207 $rv .= "e = form.elements[\"$f\"]; for(i=0; i<e.length; i++) { if (e[i].checked && e[i].value == \"1\") { form.elements[\"$tf\"].disabled = true } } ";
1210 return $_[2] ? "$_[2]='$rv'" : $rv;
1213 # js_checkbox_disable(name, &checked-disable, &checked-enable, [tag])
1214 sub js_checkbox_disable
1218 foreach $f (@{$_[1]}) {
1219 $rv .= "form.elements[\"$f\"].disabled = $_[0].checked; ";
1221 foreach $f (@{$_[2]}) {
1222 $rv .= "form.elements[\"$f\"].disabled = !$_[0].checked; ";
1224 return $_[3] ? "$_[3]='$rv'" : $rv;