FlashApplets

Quick documentation

• First a Simple example describes how to convert a "point and graph" flash applet to one that interacts with a WeBWorK question.

• Next we present several examples of the "point and graph" applet embedded in a WeBWorK question: http://hosted2.webwork.rochester.edu/webwork2/wikiExamples/PointAndGraph_AppletDemos/

• The key aspects of the code, with commentary is in the Problem techniques section at Applets, Point and Graph Flash Applet example

A summary of the methods required in applets in order for them to work with WeBWorK

External interface headers for flashApplets

////////////////////////////////////
// interface callbacks for PG question
////////////////////////////////////

ExternalInterface.addCallback("getAnswer", sendData);
ExternalInterface.addCallback("getXML", getXML);
ExternalInterface.addCallback("setXML", setXML);
ExternalInterface.addCallback("setConfig", config);
ExternalInterface.addCallback("isActive",isActive);
ExternalInterface.addCallback("debug",set_debug);

Flash Applets should respond when called by these functions

1. getAnswer - (was sendData) responds with a string formatted like an answer to a ww problem. This is the "answer" to the question that ww will grade. In many cases, it should not be written to the screen (i.e., the form containing text input boxes) as an intermediate step because then students could be confused about whether the current state of the applet or the current contents of the input box is being graded.
2. getXML - the applet is being asked for an XML description of the applet's state. The function in Flash should take no input and return a string containing xml data. The format of the data must be specified in the applet documentation.
3. setXML - the applet is being sent an XML description of a possible applet state and the applet should respond by putting itself into the appropriate state. The Flash function should take string input containing xml data holding the state information.
4. setConfig - (was config) the applet is being sent an initial configuration for the applet based on variables defined in webwork. The function in Flash should take a string containing xml data as input. The format of the data should be specified in the applet documentation as well as in an example of a ww problem using this applet.
5. isActive - a 1 or "true" response by the applet indicates that the applet is loaded, initialized and ready to go. A 0 or no response indicates that the applet is not ready. If you define an isActive() method in your flash applet make sure it returns 1 either immediately or as soon as auxiliary files are loaded.
6. debugMode - set when the applet is called from WW. If debugMode>=1 the WW question is in debug mode and if the applet has the ability to issue extra error messages these should be turned on. If debugMode==0 then these error messages should be turned off.

Additional documentation

POD documentation at:

http://webwork.maa.org/doc/cvs/pg_CURRENT/lib/Applet.html

and

http://webwork.maa.org/doc/cvs/pg_CURRENT/macros/AppletObjects.pl.html

and

http://hosted2.webwork.rochester.edu/webwork2_files/js/ww_applet_support.js

The interface is still being developed, so expect minor changes to continue along with significant new features.

Request additional features from the FlashObject working group:

http://webwork.maa.org/wiki/AIM07/Working_Groups