--- loncom/interface/lonhtmlcommon.pm 2004/02/16 22:28:55 1.49
+++ loncom/interface/lonhtmlcommon.pm 2004/06/05 14:46:12 1.75
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.49 2004/02/16 22:28:55 albertel Exp $
+# $Id: lonhtmlcommon.pm,v 1.75 2004/06/05 14:46:12 www Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -60,7 +60,6 @@ use Time::HiRes;
use Apache::lonlocal;
use strict;
-
##############################################
##############################################
@@ -164,9 +163,15 @@ sub textbox {
##############################################
##############################################
sub checkbox {
- my ($name,$value) = @_;
- my $Str = '<input type="checkbox" name="'.$name.'"'.
- ($value?' checked="1"':'').' />';
+ my ($name,$checked,$value) = @_;
+ my $Str = '<input type="checkbox" name="'.$name.'" ';
+ if (defined($value)) {
+ $Str .= 'value="'.$value.'"';
+ }
+ if ($checked) {
+ $Str .= ' checked="1"';
+ }
+ $Str .= ' />';
return $Str;
}
@@ -202,6 +207,13 @@ Also, to be explicit, a value of 'now' a
Additional html/javascript to be associated with each element in
the date_setter. See lonparmset for example usage.
+=item $includeempty
+
+=item $state
+
+Specifies the initial state of the form elements. Either 'disabled' or empty.
+Defaults to empty, which indiciates the form elements are not disabled.
+
=back
Bugs
@@ -213,7 +225,14 @@ The method used to restrict user input w
##############################################
##############################################
sub date_setter {
- my ($formname,$dname,$currentvalue,$special,$includeempty) = @_;
+ my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
+ $no_hh_mm_ss) = @_;
+ if (! defined($state) || $state ne 'disabled') {
+ $state = '';
+ }
+ if (! defined($no_hh_mm_ss)) {
+ $no_hh_mm_ss = 0;
+ }
if (! defined($currentvalue) || $currentvalue eq 'now') {
unless ($includeempty) {
$currentvalue = time;
@@ -222,7 +241,7 @@ sub date_setter {
}
}
# other potentially useful values: wkday,yrday,is_daylight_savings
- my ($sec,$min,$hour,$mday,$month,$year)=('','','','','','');
+ my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');
if ($currentvalue) {
($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) =
localtime($currentvalue);
@@ -262,19 +281,41 @@ sub date_setter {
}
}
+ function $dname\_disable() {
+ document.$formname.$dname\_month.disabled=true;
+ document.$formname.$dname\_day.disabled=true;
+ document.$formname.$dname\_year.disabled=true;
+ document.$formname.$dname\_hour.disabled=true;
+ document.$formname.$dname\_minute.disabled=true;
+ document.$formname.$dname\_second.disabled=true;
+ }
+
+ function $dname\_enable() {
+ document.$formname.$dname\_month.disabled=false;
+ document.$formname.$dname\_day.disabled=false;
+ document.$formname.$dname\_year.disabled=false;
+ document.$formname.$dname\_hour.disabled=false;
+ document.$formname.$dname\_minute.disabled=false;
+ document.$formname.$dname\_second.disabled=false;
+ }
+
function $dname\_opencalendar() {
- var calwin=window.open(
+ if (! document.$formname.$dname\_month.disabled) {
+ var calwin=window.open(
"/adm/announcements?pickdate=yes&formname=$formname&element=$dname&month="+
document.$formname.$dname\_month.value+"&year="+
document.$formname.$dname\_year.value,
"LONCAPAcal",
"height=350,width=350,scrollbars=yes,resizable=yes,menubar=no");
+ }
}
</script>
ENDJS
$result .= " <nobr><select name=\"$dname\_month\" ".$special.' '.
+ $state.' '.
"onChange=\"javascript:$dname\_checkday()\" >\n";
+ # Month
my @Months = qw/January February March April May June
July August September October November December/;
# Pad @Months with a bogus value to make indexing easier
@@ -286,37 +327,47 @@ ENDJS
$result .= "> ".&mt($Months[$m])." </option>\n";
}
$result .= " </select>\n";
- $result .= " <input type=\"text\" name=\"$dname\_day\" ".
+ # Day
+ $result .= " <input type=\"text\" name=\"$dname\_day\" ".$state.' '.
"value=\"$mday\" size=\"3\" ".$special.' '.
"onChange=\"javascript:$dname\_checkday()\" />\n";
- $result .= " <input type=\"year\" name=\"$dname\_year\" ".
+ # Year
+ $result .= " <input type=\"year\" name=\"$dname\_year\" ".$state.' '.
"value=\"$year\" size=\"5\" ".$special.' '.
"onChange=\"javascript:$dname\_checkday()\" />\n";
$result .= " ";
- $result .= " <select name=\"$dname\_hour\" ".$special." >\n";
- if ($includeempty) { $result.="<option value=''></option>"; }
- for (my $h = 0;$h<24;$h++) {
- $result .= " <option value=\"$h\" ";
- $result .= "selected " if ($hour == $h);
- $result .= "> ";
- my $timest='';
- if ($h == 0) {
- $timest .= "12 am";
- } elsif($h == 12) {
- $timest .= "12 noon";
- } elsif($h < 12) {
- $timest .= "$h am";
- } else {
- $timest .= $h-12 ." pm";
- }
- $timest=&mt($timest);
- $result .= $timest." </option>\n";
- }
- $result .= " </select>\n";
- $result .= " <input type=\"text\" name=\"$dname\_minute\" ".$special.' '.
- "value=\"$min\" size=\"3\" /> m\n";
- $result .= " <input type=\"text\" name=\"$dname\_second\" ".$special.' '.
- "value=\"$sec\" size=\"3\" /> s\n";
+ if (! $no_hh_mm_ss) {
+ # Hours
+ $result .= " <select name=\"$dname\_hour\" ".$special." ".$state.' '.
+ ">\n";
+ if ($includeempty) { $result.="<option value=''></option>"; }
+ for (my $h = 0;$h<24;$h++) {
+ $result .= " <option value=\"$h\" ";
+ $result .= "selected " if (defined($hour) && $hour == $h);
+ $result .= "> ";
+ my $timest='';
+ if ($h == 0) {
+ $timest .= "12 am";
+ } elsif($h == 12) {
+ $timest .= "12 noon";
+ } elsif($h < 12) {
+ $timest .= "$h am";
+ } else {
+ $timest .= $h-12 ." pm";
+ }
+ $timest=&mt($timest);
+ $result .= $timest." </option>\n";
+ }
+ $result .= " </select>\n";
+ $result .= " <input type=\"text\" name=\"$dname\_minute\" ".
+ $special.' '.
+ $state.' '.
+ "value=\"$min\" size=\"3\" /> m\n";
+ $result .= " <input type=\"text\" name=\"$dname\_second\" ".
+ $special.' '.
+ $state.' '.
+ "value=\"$sec\" size=\"3\" /> s\n";
+ }
$result .= "<a href=\"javascript:$dname\_opencalendar()\">".
&mt('Select Date')."</a></nobr>\n<!-- end $dname date setting form -->\n";
return $result;
@@ -360,18 +411,26 @@ sub get_date_from_form {
if (($tmpsec =~ /^\d+$/) && ($tmpsec >= 0) && ($tmpsec < 60)) {
$sec = $tmpsec;
}
+ if (!defined($tmpsec) || $tmpsec eq '') { $sec = 0; }
+ } else {
+ $sec = 0;
}
if (defined($ENV{'form.'.$dname.'_minute'})) {
my $tmpmin = $ENV{'form.'.$dname.'_minute'};
if (($tmpmin =~ /^\d+$/) && ($tmpmin >= 0) && ($tmpmin < 60)) {
$min = $tmpmin;
}
+ if (!defined($tmpmin) || $tmpmin eq '') { $min = 0; }
+ } else {
+ $min = 0;
}
if (defined($ENV{'form.'.$dname.'_hour'})) {
my $tmphour = $ENV{'form.'.$dname.'_hour'};
if (($tmphour =~ /^\d+$/) && ($tmphour >= 0) && ($tmphour < 24)) {
$hour = $tmphour;
}
+ } else {
+ $hour = 0;
}
if (defined($ENV{'form.'.$dname.'_day'})) {
my $tmpday = $ENV{'form.'.$dname.'_day'};
@@ -557,6 +616,15 @@ Inputs
=item $number_to_do The total number of items being processed.
+=item $type Either 'popup' or 'inline' (popup is assumed if nothing is
+ specified)
+
+=item $width Specify the width in charaters of the input field.
+
+=item $formname Only useful in the inline case, if a form already exists, this needs to be used and specfiy the name of the form, otherwise the Progress line will be created in a new form of it's own
+
+=item $inputname Only useful in the inline case, if a form and an input of type text exists, use this to specify the name of the input field
+
=back
Returns a hash containing the progress state data structure.
@@ -625,10 +693,18 @@ Returns: none
########################################################
########################################################
+my $uniq=0;
+sub get_uniq_name {
+ $uniq++;
+ return 'uniquename'.$uniq;
+}
+
# Create progress
sub Create_PrgWin {
- my ($r, $title, $heading, $number_to_do,$type,$formname,$inputname)=@_;
+ my ($r, $title, $heading, $number_to_do,$type,$width,$formname,
+ $inputname)=@_;
if (!defined($type)) { $type='popup'; }
+ if (!defined($width)) { $width=55; }
my %prog_state;
$prog_state{'type'}=$type;
if ($type eq 'popup') {
@@ -643,7 +719,7 @@ sub Create_PrgWin {
"<body bgcolor=\"#88DDFF\">".
"<h4>$heading</h4>".
"<form name=popremain>".
- '<input type="text" size="55" name="remaining" value="'.
+ '<input type="text" size="'.$width.'" name="remaining" value="'.
&mt('Starting').'"></form>'.
"</body></html>\');".
"popwin.document.close();}".
@@ -653,14 +729,15 @@ sub Create_PrgWin {
} elsif ($type eq 'inline') {
$prog_state{'window'}='window';
if (!$formname) {
- &r_print($r,'<form name="progresswindow">');
- $prog_state{'formname'}='progresswindow';
+ $prog_state{'formname'}=&get_uniq_name();
+ &r_print($r,'<form name="'.$prog_state{'formname'}.'">');
} else {
$prog_state{'formname'}=$formname;
}
if (!$inputname) {
- &r_print($r,'<input type="text" name="progressline" />');
- $prog_state{'inputname'}="progressline";
+ $prog_state{'inputname'}=&get_uniq_name();
+ &r_print($r,$heading.' <input type="text" name="'.$prog_state{'inputname'}.
+ '" size="'.$width.'" />');
} else {
$prog_state{'inputname'}=$inputname;
@@ -764,8 +841,11 @@ sub r_print {
# ------------------------------------------------------- Puts directory header
sub crumbs {
- my ($uri,$target,$prefix,$form)=@_;
- my $output='<br /><tt><b><font size="+2">'.$prefix.'/';
+ my ($uri,$target,$prefix,$form,$size)=@_;
+ if (! defined($size)) {
+ $size = '+2';
+ }
+ my $output='<br /><tt><b><font size="'.$size.'">'.$prefix.'/';
if ($ENV{'user.adv'}) {
my $path=$prefix.'/';
foreach (split('/',$uri)) {
@@ -785,6 +865,232 @@ sub crumbs {
return $output.'</font></b></tt><br />';
}
+# ------------------------------------------------- Output headers for HTMLArea
+
+sub htmlareaheaders {
+ if (&htmlareablocked()) { return ''; }
+ my $lang='en';
+ if (&mt('htmlarea_lang') ne 'htmlarea_lang') {
+ $lang=&mt('htmlarea_lang');
+ }
+ return (<<ENDHEADERS);
+<script type="text/javascript">
+_editor_url='/htmlarea/';
+_editor_lang='$lang';
+</script>
+<script type="text/javascript" src="/htmlarea/htmlarea.js"></script>
+ENDHEADERS
+}
+
+# ------------------------------------------------- Activate additional buttons
+
+sub htmlareaaddbuttons {
+ if (&htmlareablocked()) { return ''; }
+ return (<<ENDADDBUTTON);
+ var config=new HTMLArea.Config();
+ config.registerButton('ed_math','LaTeX Inline',
+ '/htmlarea/images/ed_math.gif',false,
+ function(editor,id) {
+ editor.surroundHTML('<m>\$','\$</m>');
+ }
+ );
+ config.registerButton('ed_math_eqn','LaTeX Equation',
+ '/htmlarea/images/ed_math_eqn.gif',false,
+ function(editor,id) {
+ editor.surroundHTML(
+ '<center><m>\\\\[','\\\\]</m></center>');
+ }
+ );
+ config.toolbar.push(['ed_math','ed_math_eqn']);
+ENDADDBUTTON
+}
+# ---------------------------------------------------------- Script to activate
+
+sub htmlareaactive {
+ if (&htmlareablocked()) { return ''; }
+ my $addbuttons=&htmlareaaddbuttons();
+ return (<<ENDSCRIPT);
+<script type="text/javascript" defer="1">
+ $addbuttons
+ HTMLArea.replaceAll(config);
+</script>
+ENDSCRIPT
+}
+
+# ----------------------------------------- Script to activate only some fields
+
+sub htmlareaselectactive {
+ my @fields=@_;
+ if (&htmlareablocked()) { return ''; }
+ my $output='<script type="text/javascript" defer="1">'.
+ &htmlareaaddbuttons();
+ foreach(@fields) {
+ $output.="\nHTMLArea.replace('$_',config);";
+ }
+ $output.="\nwindow.status='Activated Editfields';\n</script>";
+ return $output;
+}
+
+# --------------------------------------------------------------------- Blocked
+
+sub htmlareablocked {
+ unless (&htmlareabrowser()) { return 1; }
+ return 0;
+}
+
+# ---------------------------------------- Browser capable of running HTMLArea?
+
+sub htmlareabrowser {
+ return 1;
+}
+
+############################################################
+############################################################
+
+=pod
+
+=item breadcrumbs
+
+Compiles the previously registered breadcrumbs into an series of links.
+FAQ and BUG links will be placed on the left side of the table if they
+are defined for the last registered breadcrumb.
+Additionally supports a 'component', which will be displayed on the
+right side of the table (without a link).
+A link to help for the component will be included if one is specified.
+
+All inputs can be undef without problems.
+
+Inputs: $color (the background color of the table returned),
+ $component (the large text on the right side of the table),
+ $component_help
+ $function (role to get colors from)
+ $domain (domian of role)
+ $menulink (boolean, controls whether to include a link to /adm/menu)
+
+Returns a string containing breadcrumbs for the current page.
+
+=item clear_breadcrumbs
+
+Clears the previously stored breadcrumbs.
+
+=item add_breadcrumb
+
+Pushes a breadcrumb on the stack of crumbs.
+
+input: $breadcrumb, a hash reference. The keys 'href','title', and 'text'
+are required. If present the keys 'faq' and 'bug' will be used to provide
+links to the FAQ and bug sites.
+
+returns: nothing
+
+=cut
+
+############################################################
+############################################################
+{
+ my @Crumbs;
+
+ sub breadcrumbs {
+ my ($color,$component,$component_help,$function,$domain,$menulink) =
+ @_;
+ if (! defined($color)) {
+ if (! defined($function)) {
+ $function = &Apache::loncommon::get_users_function();
+ }
+ $color = &Apache::loncommon::designparm($function.'.tabbg',
+ $domain);
+ }
+ #
+ my $Str = "\n".
+ '<table width="100%" border="0" cellpadding="0" cellspacing="0">'.
+ '<tr><td bgcolor="'.$color.'">'.
+ '<font size="-1">';
+ #
+ # Make the faq and bug data cascade
+ my $faq = '';
+ my $bug = '';
+ # The last breadcrumb does not have a link, so handle it separately.
+ my $last = pop(@Crumbs);
+ #
+ # The first one should be the course or a menu link
+ if (!defined($menulink)) { $menulink=1; }
+ if ($menulink) {
+ my $description = 'Menu';
+ if (exists($ENV{'request.course.id'}) &&
+ $ENV{'request.course.id'} ne '') {
+ $description =
+ $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
+ }
+ unshift(@Crumbs,{
+ href =>'/adm/menu',
+ title =>'Go to main menu',
+ target =>'_top',
+ text =>$description,
+ });
+ }
+ my $links .=
+ join('->',
+ map {
+ $faq = $_->{'faq'} if (exists($_->{'faq'}));
+ $bug = $_->{'bug'} if (exists($_->{'bug'}));
+ my $result = '<a href="'.$_->{'href'}.'" ';
+ if (defined($_->{'target'}) && $_->{'target'} ne '') {
+ $result .= 'target="'.$_->{'target'}.'" ';
+ }
+ $result .='title="'.&mt($_->{'title'}).'">'.
+ &mt($_->{'text'}).'</a>';
+ $result;
+ } @Crumbs
+ );
+ $links .= '->' if ($links ne '');
+ $links .= '<b>'.$last->{'text'}.'</b>';
+ #
+ my $icons = '';
+ $faq = $last->{'faq'} if (exists($last->{'faq'}));
+ $bug = $last->{'bug'} if (exists($last->{'bug'}));
+ if ($faq ne '') {
+ $icons .= &Apache::loncommon::help_open_faq($faq);
+ }
+ if ($bug ne '') {
+ $icons .= &Apache::loncommon::help_open_bug($bug);
+ }
+ if ($icons ne '') {
+ $Str .= $icons.' ';
+ }
+ #
+ $Str .= $links.'</font></td>';
+ #
+ if (defined($component)) {
+ $Str .= '<td align="right" bgcolor="'.$color.'">'.
+ '<font size="+1">'.&mt($component).'</font>';
+ if (defined($component_help)) {
+ $Str .=
+ &Apache::loncommon::help_open_topic($component_help);
+ }
+ $Str.= '</td>';
+ }
+ $Str .= '</tr></table>'."\n";
+ #
+ # Return the @Crumbs stack to what we started with
+ push(@Crumbs,$last);
+ shift(@Crumbs);
+ #
+ return $Str;
+ }
+
+ sub clear_breadcrumbs {
+ undef(@Crumbs);
+ }
+
+ sub add_breadcrumb {
+ push (@Crumbs,@_);
+ }
+
+} # End of scope for @Crumbs
+
+############################################################
+############################################################
+
1;