net.mumie.mathletfactory.appletskeleton

Interface MathletContext

All Superinterfaces:

BasicAppletContext, MathletExerciseContext, MathletUIContext

All Known Subinterfaces:

MultipleChoiceExerciseIF, MultipleTasksIF, MumieExerciseIF, SelectableDataIF

All Known Implementing Classes:

AbstractMathlet, BaseApplet, CardMathlet, DefaultMathlet, MCProblemApplet, MCRandomProblemApplet, NoCanvasApplet, SideBySideCanvasApplet, SideBySideG2DCanvasApplet, SideBySideJ3DCanvasApplet, SingleCanvasApplet, SingleG2DCanvasApplet, SingleJ3DCanvasApplet, SingleJR3DCanvasApplet, UpperLowerCanvasApplet, UpperLowerG2DCanvasApplet, UpperMiddleLowerCanvasApplet, UpperMiddleLowerG2DCanvasApplet

public interface MathletContext
extends BasicAppletContext, MathletUIContext, MathletExerciseContext

This interface technically describes a Mumie Mathlet with all of its properties and capabilities. It acts as a base interface for all mathlets.

Author:

gronau

Document status:

finished

Field Summary

Fields inherited from interface net.mumie.mathletfactory.appletskeleton.system.MathletUIContext

BOTTOM_CENTER_PANE, BOTTOM_LEFT_PANE, BOTTOM_NORTH_PANE, BOTTOM_PANE, BOTTOM_RIGHT_PANE, BOTTOM_SOUTH_PANE, CONTROL_PANE, TOP_PANE

Method Summary

Methods

Modifier and Type	Method and Description
void	clearInternalFields() Sets all internal accessible fields to null in order to release any consumed heap space.
java.lang.Class	getAppletClass() Returns the runtime class of this mathlet.
javax.swing.JApplet	getJApplet() Returns this mathlet as a JApplet.
java.util.Locale	getLocale() Returns the locale of this mathlet context.
MathletRuntime	getMathletRuntime() Returns the runtime for this mathlet.
java.lang.String	getMessage(java.lang.String key) Returns the localized message for the given key or null if no corresponding message is found neither in the global nor in the applet specific messages file.
java.lang.String	getMessage(java.lang.String key, java.lang.Object[] params) Returns the localized parametrized message for the given key and parameters or null if no corresponding message is found neither in the global nor in the applet specific messages file.
java.lang.String	getPackageName() Returns the package name of this mathlet.
java.lang.String	getParameter(java.lang.String name, java.lang.String defaultValue) Returns the value of the named parameter or the default value if no such parameter was set.
MathletRuntimeSupport	getRuntimeSupport() Returns the runtime support for this mathlet context.
java.lang.String	getShortName() Returns the short class name of this mathlet (i.e. class name without package name).
boolean	hasErrors() Returns whether errors have been reported to the mathlet runtime system.
boolean	isInitialized() Returns whether this mathlet has been fully initialized.
void	postInit() This method will be called after the initialisation of the mathlet is finished.
java.lang.String	readParameter(java.lang.String name) Reads in and returns the value of the named parameter from the HTML tag or null if no such parameter was set.
void	reportError(java.lang.Throwable error) Reports an error to the mathlet runtime system.

Methods inherited from interface net.mumie.mathletfactory.appletskeleton.system.BasicAppletContext

destroy, getParameter, init, start, stop

Methods inherited from interface net.mumie.mathletfactory.appletskeleton.system.MathletUIContext

addControl, getAppletContentPane, getAppletFrame, removeControl, setTitle, setTitle, setTitleVisible, showConfirmDialog, showDialog, showErrorDialog, showMessageDialog, showMessageDialog

Methods inherited from interface net.mumie.mathletfactory.appletskeleton.system.MathletExerciseContext

getExerciseSupport, isDebugMode, isHomeworkMode, isOfflineMode, isOnlineMode, isPreviewMode

Method Detail

getParameter

java.lang.String getParameter(java.lang.String name,
                            java.lang.String defaultValue)

Returns the value of the named parameter or the default value if no such parameter was set.

Parameters:

name - name of the parameter

defaultValue - default value

See Also:

Applet.getParameter(java.lang.String)

readParameter

java.lang.String readParameter(java.lang.String name)

Reads in and returns the value of the named parameter from the HTML tag or null if no such parameter was set.

Parameters:

name - name of the parameter

getLocale

java.util.Locale getLocale()

Returns the locale of this mathlet context.

getJApplet

javax.swing.JApplet getJApplet()

Returns this mathlet as a JApplet.

getMathletRuntime

MathletRuntime getMathletRuntime()

Returns the runtime for this mathlet.

getRuntimeSupport

MathletRuntimeSupport getRuntimeSupport()

Returns the runtime support for this mathlet context.

getAppletClass

java.lang.Class getAppletClass()

Returns the runtime class of this mathlet.

getShortName

java.lang.String getShortName()

Returns the short class name of this mathlet (i.e. class name without package name).

getPackageName

java.lang.String getPackageName()

Returns the package name of this mathlet.

getMessage

java.lang.String getMessage(java.lang.String key)

Returns the localized message for the given key or null if no corresponding message is found neither in the global nor in the applet specific messages file.

getMessage

java.lang.String getMessage(java.lang.String key,
                          java.lang.Object[] params)

Returns the localized parametrized message for the given key and parameters or null if no corresponding message is found neither in the global nor in the applet specific messages file.

reportError

void reportError(java.lang.Throwable error)

Reports an error to the mathlet runtime system.

See Also:

MathletRuntimeSupport.reportError(Throwable)

hasErrors

boolean hasErrors()

Returns whether errors have been reported to the mathlet runtime system.

See Also:

MathletRuntimeSupport.hasErrors()

clearInternalFields

void clearInternalFields()

Sets all internal accessible fields to null in order to release any consumed heap space. This method should only be invoked from inside the BasicAppletContext.destroy() method of the applet. Note that only non-final and non-private fields may be cleared.

isInitialized

boolean isInitialized()

Returns whether this mathlet has been fully initialized.

postInit

void postInit()

This method will be called after the initialisation of the mathlet is finished. This method is intended to be overwritten in mathlet classes.