edu.xtec.jclic

Interface PlayStation

All Superinterfaces:

ResourceBridge

All Known Implementing Classes:

ExtendedPlayer, Player

public interface PlayStation
extends ResourceBridge

A PlayStation is a container for activities. All the classes capables of showing and running JClic activities must implement this interface. It describes the necessary methods to make JClic activities work. These methods are called by the activities to get resources, play media or notify events.

Author:

Francesc Busquets (fbusquets@xtec.cat)

Method Summary

Methods

Modifier and Type	Method and Description
void	activityFinished(boolean completedOk) Activity panels use this method to notify Players that the user has finished the current activity.
Action	getAction(int id) The action corresponding to this index.
ActiveMediaPlayer	getActiveMediaPlayer(MediaContent mediaContent) Provides an appropiated MediaPlayer suitable for a specific media.
int	getCounterValue(int counterId) Gets the current value of the specified counter.
Cursor	getCustomCursor(int type) Obtains the Cursor resource of the specified type.
FressaFunctions	getFressa() FressaFunctions offers special accessibility features like atomatic scanning and voice synthesis.
void	incCounterValue(int counterId) Increments the value of the specified counter, or decrements it when in countDown mode.
void	playMedia(MediaContent mediaContent, ActiveBox mediaPlacement) Plays, performs or executes a MediaContent.
void	playMsg() Performs or executes the media associated with the current content of the player's message box, if any.
void	reportEndActivity(Activity act, boolean solved) Notifies the Reporter (if any) that an action has been finished.
void	reportNewAction(Activity act, String type, String source, String dest, boolean ok, int currentScore) Notifies the Reporter (if any) that an action has been performed.
void	reportNewActivity(Activity act, int currentScore) Notifies the player that the activity has been started.
void	setCountDown(int counterId, int maxValue) Changes the mode of operation of the specified counter to count down, starting by the indicated value and stopping at zero.
void	setCounterEnabled(int counterId, boolean bEnabled) Enables or disables the specified counter.
void	setCounterValue(int counterId, int newValue) Sets the specified counter to a specific value.
void	setMsg(ActiveBoxContent abc) Sets the content of the messages area of the player.
void	setSystemMessage(String msg1, String msg2) Sets the text of the system messages, usually displayed in the status bar of the player.
void	setWaitCursor(boolean state) Enables or disables the wait cursor (hourglass).
boolean	showHelp(JComponent hlpComponent, String hlpMsg) Instructs the Player to show a help dialog window displaying a content associated with the current activity.
void	startActivity(Activity.Panel actp) Turns on the specified Activity.Panel.
void	stopMedia(int level) Stops all the media content currently playing that has a priority level equal or below the specified.

Methods inherited from interface edu.xtec.util.ResourceBridge

displayUrl, getComponent, getMsg, getOptions, getProgressInputStream

Method Detail

getAction

Action getAction(int id)

The action corresponding to this index. The indexes of actions are defined as constants in edu.xtec.jclic.Constants.

Parameters:

id - The index for the requested action.

Returns:

The action coresponding to this index, or null if it does not exist.

setMsg

void setMsg(ActiveBoxContent abc)

Sets the content of the messages area of the player.

Parameters:

abc - The content to show in the message box.

playMsg

void playMsg()

Performs or executes the media associated with the current content of the player's message box, if any.

setSystemMessage

void setSystemMessage(String msg1,
                    String msg2)

Sets the text of the system messages, usually displayed in the status bar of the player. There are two system messages in JClic: The main message, that describes the error or action being performed, and the secondary message, used to complement the main information with filenames or other details.

Parameters:

msg1 - Text of the main message.

msg2 - Text of the secondary message.

setWaitCursor

void setWaitCursor(boolean state)

Enables or disables the wait cursor (hourglass). This method uses a counter that increments or decrements as called with true or false params. The hourglass is maintained while the counter remains >0.

Parameters:

state - To enable or disable the wait cursor.

getCustomCursor

Cursor getCustomCursor(int type)

Obtains the Cursor resource of the specified type. Identifiers for all the available cursors are defined in edu.xtec.jclic.Constants.

Parameters:

type - The type of cursor requested (hand, stop, record...)

Returns:

The Cursor resource, or null if it does no exist.

getActiveMediaPlayer

ActiveMediaPlayer getActiveMediaPlayer(MediaContent mediaContent)

Provides an appropiated MediaPlayer suitable for a specific media.

Parameters:

mediaContent - The MediaContent to be used in this MediaPlayer.

Returns:

A MediaPlayer useful for this MediaContent.

playMedia

void playMedia(MediaContent mediaContent,
             ActiveBox mediaPlacement)

Plays, performs or executes a MediaContent. If the media has graphical content, the specified ActiveBox will be used to display it.

Parameters:

mediaContent - The MediaContent to be performed.

mediaPlacement - The ActiveBox where the graphical content of the media (if any) will be displayed.

stopMedia

void stopMedia(int level)

Stops all the media content currently playing that has a priority level equal or below the specified.

Parameters:

level - The priority level under wich all media contents will be halted, or -1 to stop all media.

setCounterEnabled

void setCounterEnabled(int counterId,
                     boolean bEnabled)

Enables or disables the specified counter.

Parameters:

counterId - The identifier of the counter to enable or disable, as specified in edu.xtec.jclic.Constants.

bEnabled - true to enable the counter, false otherwise.

setCountDown

void setCountDown(int counterId,
                int maxValue)

Changes the mode of operation of the specified counter to count down, starting by the indicated value and stopping at zero.

Parameters:

counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.

maxValue - The value to initially assign to the counter.

incCounterValue

void incCounterValue(int counterId)

Increments the value of the specified counter, or decrements it when in countDown mode.

Parameters:

counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.

setCounterValue

void setCounterValue(int counterId,
                   int newValue)

Sets the specified counter to a specific value.

Parameters:

counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.

newValue - The value to be assigned to the counter.

getCounterValue

int getCounterValue(int counterId)

Gets the current value of the specified counter.

Parameters:

counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.

Returns:

The current value of the conuter.

startActivity

void startActivity(Activity.Panel actp)

Turns on the specified Activity.Panel.

Parameters:

actp - The activity panel that will be started.

activityFinished

void activityFinished(boolean completedOk)

Activity panels use this method to notify Players that the user has finished the current activity.

Parameters:

completedOk - true if the activity was successfully finished.

reportNewActivity

void reportNewActivity(Activity act,
                     int currentScore)

Notifies the player that the activity has been started.

Parameters:

act - The Activity that has been started.

currentScore - The score at the beggining of the activity (usually zero, but can be different in some cases)

reportNewAction

void reportNewAction(Activity act,
                   String type,
                   String source,
                   String dest,
                   boolean ok,
                   int currentScore)

Notifies the Reporter (if any) that an action has been performed. This method is only used by activities that explicity have the reportActions flag set.

Parameters:

act - The activity in wich panel the action has been performed.

type - The type of action, as defined in Activity.

source - The description of the object (cell, word, letter...) in wich the action has been performed.

dest - If the action involves more than one object, the description of the second one.

ok - true if the action was successful, false otherwise.

currentScore - Score obtained just after the action.

reportEndActivity

void reportEndActivity(Activity act,
                     boolean solved)

Notifies the Reporter (if any) that an action has been finished.

Parameters:

act - The Activity yhat has been finished.

solved - true if the activity was solved, false otherwise.

showHelp

boolean showHelp(JComponent hlpComponent,
               String hlpMsg)

Instructs the Player to show a help dialog window displaying a content associated with the current activity.

Parameters:

hlpComponent - The JComponent to be placed in the help dialog, or null if no special content must be used. Activities usually use HelpActivityComponent objects for this param.

hlpMsg - A message to be displayed on the help window, usually used in place of a specific JComponent. This parameter can be null.

Returns:

true if the user clicks on the OK button of the help dialog, false otherwise.

getFressa

FressaFunctions getFressa()

FressaFunctions offers special accessibility features like atomatic scanning and voice synthesis.

Returns:

The FressaFunctions object, or null if accessibility features are not enabled