Menu
▾
▴
[WWcvs] pg: minor changes to refine the applet interface and to make it work smoothly in both debuMode and non-debugMode Also changed
|
From: Mike G. v. a. <we...@ma...> - 2009-03-22 18:44:08
|
Log Message:
-----------
minor changes to refine the applet interface and to make
it work smoothly in both debuMode and non-debugMode
Also changed the name of the reset_button to the reinitialize_button
and the title the button carries
Modified Files:
--------------
pg/macros:
AppletObjects.pl
pg/lib:
Applet.pm
Revision Data
-------------
Index: AppletObjects.pl
===================================================================
RCS file: /webwork/cvs/system/pg/macros/AppletObjects.pl,v
retrieving revision 1.19
retrieving revision 1.20
diff -Lmacros/AppletObjects.pl -Lmacros/AppletObjects.pl -u -r1.19 -r1.20
--- macros/AppletObjects.pl
+++ macros/AppletObjects.pl
@@ -111,11 +111,13 @@
# debugMode can be turned on by setting it to 1 in either the applet definition or at insertAll time
my $debugMode = (defined($options{debug}) and $options{debug}==1) ? 1 : 0;
+ my $includeAnswerBox = (defined($options{includeAnswerBox}) and $options{includeAnswerBox}==1) ? 1 : 0;
$debugMode = $debugMode || $self->debugMode;
$self->debugMode( $debugMode);
- my $reset_button = $options{reset_button} || 0;
+ my $reset_button = $options{reinitialize_button} || 0;
+ warn qq! please change "reset_button=>1" to "reinitialize_button=>1" in the applet->installAll() command ! if defined($options{reset_button});
# prepare html code for storing state
my $appletName = $self->appletName;
my $appletStateName = "${appletName}_state";
@@ -124,9 +126,8 @@
my $getConfig = $self->getConfigAlias;
my $setConfig = $self->setConfigAlias;
- my $base64_initialState = $self->base64_state;
+ my $base64_initialState = encode_base64($self->initialState);
main::RECORD_FORM_LABEL($appletStateName); #this insures that they'll be saved from one invocation to the next
- #main::RECORD_FORM_LABEL("previous_$appletStateName");
my $answer_value = '';
if ( defined( ${$main::inputs_ref}{$appletStateName} ) and ${$main::inputs_ref}{$appletStateName} =~ /\S/ ) {
@@ -183,21 +184,27 @@
my $state_input_element = ($debugMode) ? $debug_input_element :
qq!\n<input type="hidden" name = "$appletStateName" value ="$base_64_encoded_answer_value">!;
my $reset_button_str = ($reset_button) ?
- qq!<br/><input type='button' value='set applet state to restart' onClick="setAppletStateToRestart('$appletName')">
- <input type="button" value="reinitialize applet" onClick="getQE('$appletStateName').value='$base64_initialState'"/><br/>!
- : ''
- ;
+ qq!<input type='button' value='return this question to its initial state' onClick="setAppletStateToRestart('$appletName')"><br/>!
+ : '' ;
+ # <input type="button" value="reinitialize applet" onClick="getQE('$appletStateName').value='$base64_initialState'"/><br/>
# always base64 encode the hidden answer value to prevent problems with quotes.
#
- $state_storage_html_code = qq!<input type="hidden" name="previous_$appletStateName" value = "$base_64_encoded_answer_value">!
- . $reset_button_str
- . $state_input_element
+ $state_storage_html_code = qq!<input type="hidden" name="previous_$appletStateName" value = "$base_64_encoded_answer_value">!
+ . $state_input_element. $reset_button_str
;
- $answerBox_code = qq!<br/><input type="input" name="answerBox" value="" size =50><br/>
- <input type="button" value="get Answer from applet" onClick="eval(ww_applet_list['$appletName'].submitActionScript )"/>
- <br/>
- !;
- $answerBox_code = ($debugMode) ? $answerBox_code : q!<input type="hidden" name="answerBox" value="" size =50>!;
+ my $answerBox_code ='';
+ if ($includeAnswerBox) {
+ if ($debugMode) {
+
+ $answerBox_code = $main::BR . main::NAMED_ANS_RULE('answerBox', 50 );
+ $answerBox_code .= qq!
+ <br/><input type="button" value="get Answer from applet" onClick="eval(ww_applet_list['$appletName'].submitActionScript )"/>
+ <br/>
+ !;
+ } else {
+ $answerBox_code = main::NAMED_HIDDEN_ANS_RULE('answerBox', 50 );
+ }
+ }
#######
# insert header material
#######
Index: Applet.pm
===================================================================
RCS file: /webwork/cvs/system/pg/lib/Applet.pm,v
retrieving revision 1.21
retrieving revision 1.22
diff -Llib/Applet.pm -Llib/Applet.pm -u -r1.21 -r1.22
--- lib/Applet.pm
+++ lib/Applet.pm
@@ -31,7 +31,8 @@
setStateAlias => 'setXML',
getStateAlias => 'getXML',
setConfigAlias => 'config',
- answerBoxAlias => 'receivedField',
+ answerBoxAlias => 'answerBox',
+ submitActionScript => qq{ getQE('answerBox').value = getApplet("$appletName").getAnswer() },
);
###################################
@@ -48,8 +49,9 @@
###################################
TEXT( MODES(TeX=>'object code', HTML=>$applet->insertAll(
+ includeAnswerBox => 1
debug=>0,
- reset_button=>1,
+ reinitialize_button=>1,
)));
@@ -151,13 +153,12 @@
header stores the text to be added to the header section of the html page
object stores the text which places the applet on the html page
- debug in debug mode several alerts mark progress through the procedure of calling the applet
+ debugMode in debug mode several alerts mark progress through the procedure of calling the applet
- config configuration are those customizable attributes of the applet which don't
+ configuration configuration contains those customizable attributes of the applet which don't
change as it is used. When stored in hidden answer fields
it is usually stored in base64 encoded format.
- base64_config base64 encode version of the contents of config
-
+
configAlias (default: setConfig ) names the applet command called with the contents of $self->config
to configure the applet. The parameters are passed to the applet in plain text using <xml>
The outer tags must be <xml> ..... </xml>
@@ -176,8 +177,6 @@
setStateAlias (default: setState) alias for the command called to reset the state of the applet.
The state is passed in plain text in xml format with outer tags: <xml>....</xml>
- base64_state returns the base64 encoded version of the state stored in the applet object.
-
initializeActionAlias -- (default: initializeAction) the name of the javaScript subroutine called to initialize the applet (some overlap with config/ and setState
submitActionAlias -- (default: submitAction)the name of the javaScript subroutine called when the submit button of the
.pg question is pressed.
@@ -363,10 +362,10 @@
width => 550,
height => 400,
bgcolor => "#869ca7",
- base64_state => undef, # this is a state to use for initializing the first occurence of the question.
- base64_config => undef, # this is the initial (and final?) configuration
-# configuration => '', # configuration defining the applet
- initialState => '', # initial state. (I'm considering storing everything as ascii and converting on the fly to base64 when needed.)
+# base64_state => undef, # this is a state to use for initializing the first occurence of the question.
+# base64_config => undef, # this is the initial (and final?) configuration
+ configuration => '', # configuration defining the applet
+ initialState => '', # initial state.
getStateAlias => 'getXML',
setStateAlias => 'setXML',
configAlias => '', # deprecated
@@ -395,7 +394,7 @@
warn "use setConfigAlias instead of configAlias";
$self->{configAlias}='';
}
- $self->config('<xml></xml>');
+ $self->configuration('<xml></xml>');
return $self;
}
@@ -532,35 +531,44 @@
$self->{initialState} = $str ||$self->{initialState}; # replace the current string if non-empty
$self->{initialState};
}
-
-sub config {
+sub configuration {
my $self = shift;
my $str = shift;
- $self->{base64_config} = encode_base64($str) || $self->{base64_config}; # replace the current string if non-empty
- $self->{base64_config} =~ s/\n//g;
- decode_base64($self->{base64_config});
+ $self->{configuration} = $str || $self->{configuration}; # replace the current string if non-empty
+ $self->{configuration} =~ s/\n//g;
+ $self->{configuration};
}
+
#######################
# soon to be deprecated?
#######################
+
+sub config {
+ my $self = shift;
+ my $str = shift;
+ warn "use $self->configuration instead of $self->config. Internally this string is ascii, not base64 encoded", join(' ', caller());
+# $self->{base64_config} = encode_base64($str) || $self->{base64_config}; # replace the current string if non-empty
+# $self->{base64_config} =~ s/\n//g;
+# decode_base64($self->{base64_config});
+}
sub state {
my $self = shift;
my $str = shift;
- $self->{base64_state} = encode_base64($str) ||$self->{base64_state}; # replace the current string if non-empty
- $self->{base64_state} =~ s/\n//g;
- decode_base64($self->{base64_state});
+ warn "use $self->initialState instead of $self->state. Internally this string is ascii, not base64 encoded", join(' ', caller());
+# $self->{base64_state} = encode_base64($str) ||$self->{base64_state}; # replace the current string if non-empty
+# $self->{base64_state} =~ s/\n//g;
+# decode_base64($self->{base64_state});
}
sub base64_state{
my $self = shift;
- $self->{base64_state} = shift ||$self->{base64_state}; # replace the current string if non-empty
- $self->{base64_state};
+ warn "use $self->InitialState instead of $self->state. Internally this string is ascii, not base64 encoded", join(' ', caller());
+
+
}
sub base64_config {
my $self = shift;
- $self->{base64_config} = shift ||$self->{base64_config}; # replace the current string if non-empty
- $self->{base64_config} =$self->{base64_config};
- $self->{base64_config};
+ warn "use $self->configuration instead of $self->config. Internally this string is ascii, not base64 encoded";
}
sub returnFieldName {
@@ -581,9 +589,7 @@
my $codebase = $self->codebase;
my $appletId = $self->appletId;
my $appletName = $self->appletName;
- my $base64_initialState = $self->base64_state;
my $initializeActionAlias = $self->initializeActionAlias;
- my $submitActionAlias = $self->submitActionAlias;
my $submitActionScript = $self->submitActionScript;
my $setStateAlias = $self->setStateAlias;
my $getStateAlias = $self->getStateAlias;
@@ -591,19 +597,23 @@
my $setConfigAlias = $self->setConfigAlias;
my $getConfigAlias = $self->getConfigAlias;
my $maxInitializationAttempts = $self->maxInitializationAttempts;
- my $base64_config = $self->base64_config;
my $debugMode = ($self->debugMode) ? "1": "0";
my $answerBoxAlias = $self->{answerBoxAlias};
my $headerText = $self->header();
- $submitActionScript =~ s/"/\\"/g; # escape quotes for ActionScript
+ #$submitActionScript =~ s/"/\\"/g; # escape quotes for ActionScript
# other variables should not have quotes.
$submitActionScript =~ s/\n/ /g; # replace returns with spaces -- returns in the wrong spot can cause trouble with javaScript
$submitActionScript =~ s/\r/ /g; # replace returns with spaces -- returns can cause trouble
my $base64_submitActionScript = encode_base64($submitActionScript);
+ my $base64_configuration = encode_base64($self->configuration);
+ my $base64_initialState = encode_base64($self->initialState);
+
$base64_submitActionScript =~s/\n//g;
+ $base64_initialState =~s/\n//g; # base64 encoded xml
+ $base64_configuration =~s/\n//g; # base64 encoded xml
$headerText =~ s/(\$\w+)/$1/gee; # interpolate variables p17 of Cookbook
@@ -674,15 +684,15 @@
ww_applet_list["$appletName"].codebase = "$codebase";
ww_applet_list["$appletName"].appletID = "$appletID";
ww_applet_list["$appletName"].base64_state = "$base64_initializationState";
- ww_applet_list["$appletName"].initialState = Base64.decode("$base64_intialState");
- ww_applet_list["$appletName"].base64_config = "$base64_config";
+ ww_applet_list["$appletName"].initialState = Base64.decode("$base64_initialState");
+ ww_applet_list["$appletName"].configuration = Base64.decode("$base64_configuration");;
ww_applet_list["$appletName"].getStateAlias = "$getStateAlias";
ww_applet_list["$appletName"].setStateAlias = "$setStateAlias";
ww_applet_list["$appletName"].setConfigAlias = "$setConfigAlias";
ww_applet_list["$appletName"].getConfigAlias = "$getConfigAlias";
ww_applet_list["$appletName"].initializeActionAlias = "$initializeActionAlias";
ww_applet_list["$appletName"].submitActionAlias = "$submitActionAlias";
- ww_applet_list["$appletName"].submitActionScript = Base64.decode("$submitActionScript_base64");
+ ww_applet_list["$appletName"].submitActionScript = Base64.decode("$base64_submitActionScript");
ww_applet_list["$appletName"].answerBoxAlias = "$answerBoxAlias";
ww_applet_list["$appletName"].maxInitializationAttempts = $maxInitializationAttempts;
ww_applet_list["$appletName"].debugMode = "$debugMode";
|
