com.wiris.quizzes.api.ui

Interface QuizzesComponentBuilder

public interface QuizzesComponentBuilder

Entry point to the Wiris Quizzes user interface API. An instance of this interface is always obtained from the Quizzes object. This class builds the user interface components to integrate Wiris Quizzes within the question forms and allow some configuration of them.

Since:

version 4.0.0

Method Summary

Modifier and Type	Method and Description
MathViewer	getMathViewer() Create a MathViewer instance in order to display MathML.
AnswerFeedback	newAnswerFeedback(QuestionInstance instance, Slot slot, AuthorAnswer authorAnswer) Create a QuizzesComponent with the feedback for an student's response based on the instance assertion checks.
AnswerField	newAnswerField(QuestionInstance instance, Slot slot) Create a QuizzesField for the student answer input field corresponding to a given Slot.
AuthoringField	newAuthoringField(Question question, Slot slot, AuthorAnswer authorAnswer) Create a QuizzesField that allows the user to define the grading criteria of a given AuthorAnswer.
AuxiliaryCasField	newAuxiliaryCasField(QuestionInstance instance, Slot slot) Create a CalcMe app component related to the student answer corresponding to a given Slot.
EmbeddedAnswersEditor	newEmbeddedAnswersEditor(Question question, QuestionInstance instance) Create an EmbeddedAnswersEditor object.
void	replaceFields(Question question, QuestionInstance instance, java.lang.Object element) Filters HTML replacing each placeholder element by the Wiris Quizzes JavaScript component.
void	setLanguage(java.lang.String lang) Set the language to be used in Wiris Quizzes UI components.

Method Detail

setLanguage

void setLanguage(java.lang.String lang)

Set the language to be used in Wiris Quizzes UI components. Call this function before creating any component if you want to use a language other than "en".

Parameters:

lang - The string language in ISO.

newAnswerFeedback

AnswerFeedback newAnswerFeedback(QuestionInstance instance,
                                 Slot slot,
                                 AuthorAnswer authorAnswer)

Create a QuizzesComponent with the feedback for an student's response based on the instance assertion checks.

Parameters:

instance - The QuestionInstance element with assertion checks that will be used to produce the feedback.

slot - The slot that corresponds to the student's answer being graded.

authorAnswer - The author answer that contains the criteria used to grade the student's answer.

newAnswerField

AnswerField newAnswerField(QuestionInstance instance,
                           Slot slot)

Create a QuizzesField for the student answer input field corresponding to a given Slot.

Parameters:

instance - The QuestionInstance element that will be updated through this field.

slot - The slot that corresponds to this answer field.

newAuthoringField

AuthoringField newAuthoringField(Question question,
                                 Slot slot,
                                 AuthorAnswer authorAnswer)

Create a QuizzesField that allows the user to define the grading criteria of a given AuthorAnswer.

Parameters:

question - The initial question object that contains the initial data to which the authoring field will be initialized. It will be updated through this field.

slot - The slot that corresponds to this author answer. It will be updated through this field.

authorAnswer - The author answer whose criteria will be defined by using this authoring field. It will be updated through this field.

newEmbeddedAnswersEditor

EmbeddedAnswersEditor newEmbeddedAnswersEditor(Question question,
                                               QuestionInstance instance)

Create an EmbeddedAnswersEditor object.

Parameters:

question - The question object with the initial definition of the question. It will be updated through the user interaction with this field.

instance - The initial question instance object used in the preview tab.

newAuxiliaryCasField

AuxiliaryCasField newAuxiliaryCasField(QuestionInstance instance,
                                       Slot slot)

Create a CalcMe app component related to the student answer corresponding to a given Slot. This is a Computer Algebra System where the student may do auxiliary computations or explain what they has done

Parameters:

instance - The question instance object that will be updated through the user interaction with this field. It may contain also the last value.

slot - The slot that corresponds to this auxiliary CAS field.

getMathViewer

MathViewer getMathViewer()

Create a MathViewer instance in order to display MathML.

Returns:

A MathViewer object.

replaceFields

void replaceFields(Question question,
                   QuestionInstance instance,
                   java.lang.Object element)

Filters HTML replacing each placeholder element by the Wiris Quizzes JavaScript component. This is an alternative way to build the Wiris Quizzes fields to building one by one using this object methods. The placeholders must be labeled using class attributes in elements. The available class placeholders are:

• "wirisquestion": The form element with this class contains the XML definition of the Question object. This question will be used with the filtered Quizzes fields if no question is provided to this method.
• "wirisquestioninstance": The form element with this class contains the XML definition of the QuestionInstance object. This question instance will be used with the filtered Quizzes fields if no question instance is provided to this method.
• "wirisauthoringfield": Authoring Wiris Quizzes field, for editing/authoring stage.
• "wirisanswerfield": Answer Wiris Quizzes field, for delivery/answering stage.
• "wirisauxiliarcasapplet": Placeholder for an auxiliar embedded Wiris Cas applet.
• "wirisanswerfeedback": Placeholder for automatic answer feedback, for review stage.
• "wirislang": Input value defining the language to be used in Quizzes fields. Availables are "en", "es", "ca", "it", "fr", "de".
• "wirissubmit": Submit button in delivery stage. Used to be disabled when the page is not ready to be submitted (for example, on Handwriting recognition).

Parameters:

instance - The question to be used with filtered fields. If set to null it will be searched within elements.

instance - The question instance to be used with filtered fields. If set to null it will be searched within elements.

element - The root element where to filter. If set to null the document element will be taken.