Player (JClic API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - edu.xtec.jclic.Player

All Implemented Interfaces:

Constants, PlayStation, RunnableComponent, ResourceBridge, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

ExtendedPlayer
```
public class Player
extends JPanel
implements Constants, RunnableComponent, PlayStation, ActionListener
```
Player is one of the the main classes of the JClic system. It implements the PlayStation interface, so it can read and play JClic projects from files or streams. In order to allow activities to run, Player provides them of all the necessary resources: media bags (to load and realize images and other media contents), sequence control, report system management, user interface (loading and management of skins), display of system messages, etc. Player is also a RunnableComponent, so it can be embedded in applets, frames and other containers.

Version:

13.09.10

Author:

Francesc Busquets (fbusquets@xtec.cat)

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`ACTION_ICONS` List of the names of the internal resources corresponding to the default icons associated to the basic actions defined in `Constants`.
`protected Action[]`	`actions` Array containing the `Action` objects used by the player.
`protected ActiveMediaBag`	`activeMediaBag` Bag of realized media objects, ready to play.
`protected Activity.Panel`	`actPanel` The UI element (`Panel`)of the `Activity` currently running in the `Player`.
`protected String`	`appName` The main name of the application in wich this `Player` is running.
`protected boolean`	`audioEnabled` This flag indicates if the `Player` must play the sounds (including system sounds) and other media contents of the activities.
`static String`	`DEFAULT_APP_NAME` The default name of the application (JClic)
`static String[]`	`DEFAULT_EVENT_SOUNDS` List of the names of the internal resources corresponding to the default event sounds used by JClic.
`static String`	`DEFAULT_REPORTER` Name of the default reporter used by JClic.
`static String`	`DEFAULT_SKIN` Name of the resource corresponding to the default skin of JClic.
`protected Skin`	`defaultSkin` Default skin of this `Player`.
`protected EventSounds`	`eventSounds` Current set of system sonds used in this `Player`.
`protected PlayerHistory`	`history` This object manages a list with the names of all the activities currently played by the user in this `Player`.
`protected Messages`	`messages` The main `Messages` object.
`protected boolean`	`navButtonsAlways` When this flag is `true`, the navigation buttons are always enabled, despite of the indications made by the activities or the sequence control system.
`protected boolean`	`navButtonsDisabled` This flag indicates if the navigation buttons (go to next activity and go back) are enabled o disabled.
`protected JClicProject`	`project` The `JClicProject` currently hosted by the `Player`.
`protected Reporter`	`reporter` Current reporter used by this `Player`.
`protected Skin`	`skin` Current `Skin` of the `Player`.
`protected Timer`	`timer` Main `Timer`, used to feed the time conter.
`protected boolean`	`trace` This flag indicates if the program must write verbose info to the system console.

Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface edu.xtec.jclic.Constants
AC_MARGIN, ACTION_AUDIO, ACTION_HLP, ACTION_INFO, ACTION_NAME, ACTION_NEXT, ACTION_PREV, ACTION_REPORTS, ACTION_RESET, ACTION_RETURN, ACTIONS_COUNTER, ACTIVITY_OBJECT, AUDIO_ENABLED, BG_COLOR, COMMON_SETTINGS, COMPRESS_IMAGES, COOKIE, counterNames, DEFAULT, DEFAULT_BUNDLE, DEFAULT_RENDERING_HINTS, DYNAMIC_ACTIONS, ENABLED, EXIT_URL, EXTERNAL_OBJECT, FALSE, HAND_CURSOR, ID, INFO_URL_FRAME, JMF, LOGO_ICON, MEDIA_OBJECT, MEDIA_SYSTEM, MEDIA_SYSTEMS, MIN_CELL_SIZE, MYURL, NAV_BUTTONS_ALWAYS, NO_MEDIASYSTEM_WARN, NUM_ACTIONS, NUM_COUNTERS, OK_CURSOR, PRE_DRAW_IMAGES, PROGRAM, PROJECT_OBJECT, QT, QT61, REC_CURSOR, REPORTER_CLASS, REPORTER_PARAMS, SCORE_COUNTER, SEQUENCE_OBJECT, SKIN, SKIN_OBJECT, SYSTEM_SOUNDS, T_ACTIVITY, T_ANIM, T_AUDIO, T_CLIC, T_EXTERNAL, T_FONT, T_IMAGE, T_INST, T_JCLIC, T_MEDIA, T_MIDI, T_SEQUENCE, T_TEXT, T_UNKNOWN_MEDIA, T_URL, T_VIDEO, T_XML, TIME_COUNTER, TRACE, TRUE, URL_BASE, URL_OBJECT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`Player(Options options)` Creates a new `Player` object.
`Player(Options options, JClicProject project)` Creates a new `Player` object that will be initially loaded with a specific `JClicProject`.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)`
`void`	`activate()` This method is called when the container gains the focus for the first time or when losts it.
`void`	`activityFinished(boolean completedOk)` Activity panels use this method to notify Players that the user has finished the current activity.
`void`	`addTo(RootPaneContainer cont, Object constraints)` Instructs this `RunnableComponent` to be self-placed into the specified `RootPaneContainer`.
`protected void`	`buildActions()`
`void`	`closeHelpWindow()` If open, closes the help dialog window.
`protected void`	`createCursors()` Creates and initializes the members of the `cursors` array.
`protected void`	`createEventSounds()` Creates the `eventSounds` member and initializes the sound system.
`protected FileSystem`	`createFileSystem()`
`void`	`displayUrl(String url, boolean inFrame)`
`void`	`displayUrl(URL url, boolean inFrame)`
`void`	`doAutoStart()`
`void`	`doLayout()`
`void`	`end()` Executes miscellaneous finalization routines.
`void`	`exit()`
`void`	`exit(String url)`
`protected void`	`finalize()`
`void`	`forceFinishActivity()`
`Action`	`getAction(int id)` The action corresponding to this index.
`protected Icon`	`getActionIcon(int actionId)`
`protected String`	`getActionName(int actionId)`
`ActiveMediaPlayer`	`getActiveMediaPlayer(MediaContent mediaContent)` Provides an appropiated `MediaPlayer` suitable for a specific media.
`JComponent`	`getComponent()`
`int`	`getCounterValue(int counterId)` Gets the current value of the specified counter.
`Cursor`	`getCustomCursor(int type)` Gets the custom cursor corresponding to the indicated type
`FressaFunctions`	`getFressa()` FressaFunctions offers special accessibility features like atomatic scanning and voice synthesis.
`PlayerHistory`	`getHistory()`
`Messages`	`getMessages()`
`String`	`getMsg(String key)`
`protected int`	`getNumActions()`
`Options`	`getOptions()`
`InputStream`	`getProgressInputStream(InputStream is, int expectedLength, String name)`
`Skin`	`getSkin()`
`Component`	`getTopComponent()`
`void`	`incCounterValue(int counterId)` Increments the value of the specified counter, or decrements it when in countDown mode.
`protected void`	`init()` Main initialization process, called once by constructors.
`void`	`initActivity()`
`protected void`	`initReporter()` Creates and initializes the `reporter` member.
`protected void`	`initSkin()` Creates and initializes the `defaultSkin` member.
`protected void`	`initTimers()` Creates and initializes the members `timer`, `delayedTimer` and `delayedAction`
`boolean`	`load(String fullPath, String sequence)`
`void`	`load(String sFullPath, String sSequence, String sActivity, ActivityBagElement sAbe)`
`boolean`	`newInstanceRequest(String param1, String param2)` A new instance of the `RunnableComponent` has been requested by the user.
`void`	`paintComponent(Graphics g)`
`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.
`protected boolean`	`processActionEvent(String ac)`
`void`	`removeActivity()`
`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`	`requestFocus()`
`protected void`	`runCmd(String cmd)`
`protected void`	`setActionsText()`
`protected void`	`setBackgroundSettings(Activity act)`
`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.
`protected Messages`	`setMessages()` Creates and initializes the `messages` member.
`void`	`setMsg(ActiveBoxContent abc)` Sets the content of the messages area of the player.
`protected void`	`setProject(JClicProject p)`
`void`	`setSkin(Skin newSkin)`
`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).
`void`	`setWindowTitle()`
`void`	`setWindowTitle(String docTitle)`
`protected void`	`showAbout(boolean selectReportPane)`
`boolean`	`showHelp(JComponent hlpComponent, String hlpMsg)` Instructs the Player to show a help dialog window displaying a content associated with the current activity.
`boolean`	`start(String fullPath, String sequence)` Starts the player, loading a specific project if specified.
`void`	`startActivity(Activity.Panel ap)` Turns on the specified `Activity.Panel`.
`void`	`startAutoPassTimer()`
`void`	`stop()` Instructs the RunnableComponent to stop working.
`void`	`stopMedia()`
`void`	`stopMedia(int level)` Stops all the media content currently playing that has a priority level equal or below the specified.
`boolean`	`windowCloseRequested()` Called by the main container when it receives a `windowClosing` event.

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SKIN
```
public static final String DEFAULT_SKIN
```
    Name of the resource corresponding to the default skin of JClic.
    
    See Also:
    Constant Field Values
  - DEFAULT_REPORTER
```
public static final String DEFAULT_REPORTER
```
    Name of the default reporter used by JClic.
    
    See Also:
    Constant Field Values
  - DEFAULT_EVENT_SOUNDS
```
public static final String[] DEFAULT_EVENT_SOUNDS
```
    List of the names of the internal resources corresponding to the default event sounds used by JClic.
  - ACTION_ICONS
```
public static final String[] ACTION_ICONS
```
    List of the names of the internal resources corresponding to the default icons associated to the basic actions defined in Constants.
  - DEFAULT_APP_NAME
```
public static final String DEFAULT_APP_NAME
```
    The default name of the application (JClic)
    
    See Also:
    Constant Field Values
  - actions
```
protected Action[] actions
```
    Array containing the Action objects used by the player.
  - messages
```
protected Messages messages
```
    The main Messages object.
  - project
```
protected JClicProject project
```
    The JClicProject currently hosted by the Player.
  - actPanel
```
protected Activity.Panel actPanel
```
    The UI element (Panel)of the Activity currently running in the Player.
  - history
```
protected PlayerHistory history
```
    This object manages a list with the names of all the activities currently played by the user in this Player.
  - skin
```
protected Skin skin
```
    Current Skin of the Player.
  - defaultSkin
```
protected Skin defaultSkin
```
    Default skin of this Player. Users can override the DEFAULT_SKIN setting and choose another Skin to be used by default in JClic.
  - activeMediaBag
```
protected ActiveMediaBag activeMediaBag
```
    Bag of realized media objects, ready to play.
  - reporter
```
protected Reporter reporter
```
    Current reporter used by this Player.
  - eventSounds
```
protected EventSounds eventSounds
```
    Current set of system sonds used in this Player.
  - timer
```
protected Timer timer
```
    Main Timer, used to feed the time conter. This timer generates an ActionPerformed event every second.
  - audioEnabled
```
protected boolean audioEnabled
```
    This flag indicates if the Player must play the sounds (including system sounds) and other media contents of the activities.
  - trace
```
protected boolean trace
```
    This flag indicates if the program must write verbose info to the system console.
  - navButtonsDisabled
```
protected boolean navButtonsDisabled
```
    This flag indicates if the navigation buttons (go to next activity and go back) are enabled o disabled.
  - navButtonsAlways
```
protected boolean navButtonsAlways
```
    When this flag is true, the navigation buttons are always enabled, despite of the indications made by the activities or the sequence control system. Used only for debugging projects with complicated sequence chaining.
  - appName
```
protected String appName
```
    The main name of the application in wich this Player is running.
- Constructor Detail
  - Player
```
public Player(Options options)
```
    Creates a new Player object.
    
    Parameters:
    options - Options object to be used in the initialization process
  - Player
```
public Player(Options options,
      JClicProject project)
```
    Creates a new Player object that will be initially loaded with a specific JClicProject.
    
    Parameters:
    options - Options object to be used in the initialization process
    project - JClic project to load (can be null)
- Method Detail
  - init
```
protected void init()
```
    Main initialization process, called once by constructors. Subclasses of Player should override this method to initialize additional members.
  - start
```
public boolean start(String fullPath,
            String sequence)
```
    Starts the player, loading a specific project if specified. This method is defined in the RunnableComponent interface.
    
    Specified by:
    
    start in interface RunnableComponent
    
    Parameters:
    fullPath - Full path to the JClic project file to be loaded. Can be null.
    sequence - Optional parameter, used only when fullPath is not null. It indicates the sequence where the to start. It's also possible to indicate a string representation of a number "N". In this case, the player will start with the activity indicated by the Nth element of the main sequence of the project.
    
    Returns:
    true if the player starts successfully. false otherwise.
  - activate
```
public void activate()
```
    This method is called when the container gains the focus for the first time or when losts it. Not used in Player.
    
    Specified by:
    
    activate in interface RunnableComponent
  - stop
```
public void stop()
```
    Instructs the RunnableComponent to stop working.
    
    Specified by:
    
    stop in interface RunnableComponent
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - end
```
public void end()
```
    Executes miscellaneous finalization routines.
    
    Specified by:
    
    end in interface RunnableComponent
  - createCursors
```
protected void createCursors()
```
    Creates and initializes the members of the cursors array.
  - createEventSounds
```
protected void createEventSounds()
```
    Creates the eventSounds member and initializes the sound system.
  - initReporter
```
protected void initReporter()
```
    Creates and initializes the reporter member.
  - initSkin
```
protected void initSkin()
```
    Creates and initializes the defaultSkin member.
  - initTimers
```
protected void initTimers()
```
    Creates and initializes the members timer, delayedTimer and delayedAction
  - closeHelpWindow
```
public void closeHelpWindow()
```
    If open, closes the help dialog window.
  - setMessages
```
protected Messages setMessages()
```
    Creates and initializes the messages member.
    
    Returns:
    The messages member.
  - getTopComponent
```
public Component getTopComponent()
```
  - getSkin
```
public Skin getSkin()
```
  - setSkin
```
public void setSkin(Skin newSkin)
```
    Parameters:
    newSkin -
  - addTo
```
public void addTo(RootPaneContainer cont,
         Object constraints)
```
    Description copied from interface: RunnableComponent
    
    Instructs this RunnableComponent to be self-placed into the specified RootPaneContainer.
    
    Specified by:
    
    addTo in interface RunnableComponent
    
    Parameters:
    cont - The container in wich the component should be placed.
    constraints - The constraints used in the call to the add method of the Container. This parameter can be null.
  - createFileSystem
```
protected FileSystem createFileSystem()
```
  - setProject
```
protected void setProject(JClicProject p)
```
  - load
```
public boolean load(String fullPath,
           String sequence)
```
  - load
```
public void load(String sFullPath,
        String sSequence,
        String sActivity,
        ActivityBagElement sAbe)
```
  - forceFinishActivity
```
public void forceFinishActivity()
```
  - removeActivity
```
public void removeActivity()
```
  - initActivity
```
public void initActivity()
```
  - startActivity
```
public void startActivity(Activity.Panel ap)
```
    Description copied from interface: PlayStation
    
    Turns on the specified Activity.Panel.
    
    Specified by:
    
    startActivity in interface PlayStation
    
    Parameters:
    ap - The activity panel that will be started.
  - doLayout
```
public void doLayout()
```
    Overrides:
    
    doLayout in class Container
  - paintComponent
```
public void paintComponent(Graphics g)
```
    Overrides:
    
    paintComponent in class JComponent
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface ActionListener
  - getNumActions
```
protected int getNumActions()
```
  - buildActions
```
protected void buildActions()
```
  - setActionsText
```
protected void setActionsText()
```
  - getActionName
```
protected String getActionName(int actionId)
```
  - getActionIcon
```
protected Icon getActionIcon(int actionId)
```
  - getAction
```
public Action getAction(int id)
```
    Description copied from interface: PlayStation
    
    The action corresponding to this index. The indexes of actions are defined as constants in edu.xtec.jclic.Constants.
    
    Specified by:
    
    getAction in interface PlayStation
    
    Parameters:
    id - The index for the requested action.
    
    Returns:
    The action coresponding to this index, or null if it does not exist.
  - processActionEvent
```
protected boolean processActionEvent(String ac)
```
  - showAbout
```
protected void showAbout(boolean selectReportPane)
```
  - playMedia
```
public void playMedia(MediaContent mediaContent,
             ActiveBox mediaPlacement)
```
    Description copied from interface: PlayStation
    
    Plays, performs or executes a MediaContent. If the media has graphical content, the specified ActiveBox will be used to display it.
    
    Specified by:
    
    playMedia in interface PlayStation
    
    Parameters:
    mediaContent - The MediaContent to be performed.
    mediaPlacement - The ActiveBox where the graphical content of the media (if any) will be displayed.
  - runCmd
```
protected void runCmd(String cmd)
```
  - stopMedia
```
public void stopMedia()
```
  - stopMedia
```
public void stopMedia(int level)
```
    Description copied from interface: PlayStation
    
    Stops all the media content currently playing that has a priority level equal or below the specified.
    
    Specified by:
    
    stopMedia in interface PlayStation
    
    Parameters:
    level - The priority level under wich all media contents will be halted, or -1 to stop all media.
  - activityFinished
```
public void activityFinished(boolean completedOk)
```
    Description copied from interface: PlayStation
    
    Activity panels use this method to notify Players that the user has finished the current activity.
    
    Specified by:
    
    activityFinished in interface PlayStation
    
    Parameters:
    completedOk - true if the activity was successfully finished.
  - startAutoPassTimer
```
public void startAutoPassTimer()
```
  - setBackgroundSettings
```
protected void setBackgroundSettings(Activity act)
```
  - setMsg
```
public void setMsg(ActiveBoxContent abc)
```
    Description copied from interface: PlayStation
    
    Sets the content of the messages area of the player.
    
    Specified by:
    
    setMsg in interface PlayStation
    
    Parameters:
    abc - The content to show in the message box.
  - playMsg
```
public void playMsg()
```
    Description copied from interface: PlayStation
    
    Performs or executes the media associated with the current content of the player's message box, if any.
    
    Specified by:
    
    playMsg in interface PlayStation
  - incCounterValue
```
public void incCounterValue(int counterId)
```
    Description copied from interface: PlayStation
    
    Increments the value of the specified counter, or decrements it when in countDown mode.
    
    Specified by:
    
    incCounterValue in interface PlayStation
    
    Parameters:
    counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.
  - setCountDown
```
public void setCountDown(int counterId,
                int maxValue)
```
    Description copied from interface: PlayStation
    
    Changes the mode of operation of the specified counter to count down, starting by the indicated value and stopping at zero.
    
    Specified by:
    
    setCountDown in interface PlayStation
    
    Parameters:
    counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.
    maxValue - The value to initially assign to the counter.
  - setCounterValue
```
public void setCounterValue(int counterId,
                   int newValue)
```
    Description copied from interface: PlayStation
    
    Sets the specified counter to a specific value.
    
    Specified by:
    
    setCounterValue in interface PlayStation
    
    Parameters:
    counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.
    newValue - The value to be assigned to the counter.
  - getCounterValue
```
public int getCounterValue(int counterId)
```
    Description copied from interface: PlayStation
    
    Gets the current value of the specified counter.
    
    Specified by:
    
    getCounterValue in interface PlayStation
    
    Parameters:
    counterId - The identifier of the counter, as specified in edu.xtec.jclic.Constants.
    
    Returns:
    The current value of the conuter.
  - setCounterEnabled
```
public void setCounterEnabled(int counterId,
                     boolean bEnabled)
```
    Description copied from interface: PlayStation
    
    Enables or disables the specified counter.
    
    Specified by:
    
    setCounterEnabled in interface PlayStation
    
    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.
  - getMessages
```
public Messages getMessages()
```
  - setWaitCursor
```
public void setWaitCursor(boolean state)
```
    Description copied from interface: PlayStation
    
    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.
    
    Specified by:
    
    setWaitCursor in interface PlayStation
    
    Parameters:
    state - To enable or disable the wait cursor.
  - setSystemMessage
```
public void setSystemMessage(String msg1,
                    String msg2)
```
    Description copied from interface: PlayStation
    
    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.
    
    Specified by:
    
    setSystemMessage in interface PlayStation
    
    Parameters:
    msg1 - Text of the main message.
    msg2 - Text of the secondary message.
  - getComponent
```
public JComponent getComponent()
```
    Specified by:
    
    getComponent in interface ResourceBridge
  - getActiveMediaPlayer
```
public ActiveMediaPlayer getActiveMediaPlayer(MediaContent mediaContent)
```
    Description copied from interface: PlayStation
    
    Provides an appropiated MediaPlayer suitable for a specific media.
    
    Specified by:
    
    getActiveMediaPlayer in interface PlayStation
    
    Parameters:
    mediaContent - The MediaContent to be used in this MediaPlayer.
    
    Returns:
    A MediaPlayer useful for this MediaContent.
  - getCustomCursor
```
public Cursor getCustomCursor(int type)
```
    Gets the custom cursor corresponding to the indicated type
    
    Specified by:
    
    getCustomCursor in interface PlayStation
    
    Parameters:
    type - Type of cursor.
    
    Returns:
    The requested cursor, or the default system cursor if not found.
  - reportNewActivity
```
public void reportNewActivity(Activity act,
                     int currentScore)
```
    Description copied from interface: PlayStation
    
    Notifies the player that the activity has been started.
    
    Specified by:
    
    reportNewActivity in interface PlayStation
    
    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
```
public void reportNewAction(Activity act,
                   String type,
                   String source,
                   String dest,
                   boolean ok,
                   int currentScore)
```
    Description copied from interface: PlayStation
    
    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.
    
    Specified by:
    
    reportNewAction in interface PlayStation
    
    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
```
public void reportEndActivity(Activity act,
                     boolean solved)
```
    Description copied from interface: PlayStation
    
    Notifies the Reporter (if any) that an action has been finished.
    
    Specified by:
    
    reportEndActivity in interface PlayStation
    
    Parameters:
    act - The Activity yhat has been finished.
    solved - true if the activity was solved, false otherwise.
  - showHelp
```
public boolean showHelp(JComponent hlpComponent,
               String hlpMsg)
```
    Description copied from interface: PlayStation
    
    Instructs the Player to show a help dialog window displaying a content associated with the current activity.
    
    Specified by:
    
    showHelp in interface PlayStation
    
    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.
  - getProgressInputStream
```
public InputStream getProgressInputStream(InputStream is,
                                 int expectedLength,
                                 String name)
```
    Specified by:
    
    getProgressInputStream in interface ResourceBridge
  - getOptions
```
public Options getOptions()
```
    Specified by:
    
    getOptions in interface ResourceBridge
  - getHistory
```
public PlayerHistory getHistory()
```
  - displayUrl
```
public void displayUrl(String url,
              boolean inFrame)
```
    Specified by:
    
    displayUrl in interface ResourceBridge
  - displayUrl
```
public void displayUrl(URL url,
              boolean inFrame)
```
  - exit
```
public void exit()
```
  - exit
```
public void exit(String url)
```
  - requestFocus
```
public void requestFocus()
```
    Overrides:
    
    requestFocus in class JComponent
  - getMsg
```
public String getMsg(String key)
```
    Specified by:
    
    getMsg in interface ResourceBridge
  - doAutoStart
```
public void doAutoStart()
```
  - newInstanceRequest
```
public boolean newInstanceRequest(String param1,
                         String param2)
```
    Description copied from interface: RunnableComponent
    
    A new instance of the RunnableComponent has been requested by the user.
    
    Specified by:
    
    newInstanceRequest in interface RunnableComponent
    
    Parameters:
    param1 - First parameter passed to the component. Can be null.
    param2 - Second parameter passed to the component. Can also be null.
    
    Returns:
    true if the request was successfull, false otherwise.
  - windowCloseRequested
```
public boolean windowCloseRequested()
```
    Description copied from interface: RunnableComponent
    
    Called by the main container when it receives a windowClosing event.
    
    Specified by:
    
    windowCloseRequested in interface RunnableComponent
    
    Returns:
    true if the component can be safely disposed, false otherwise.
  - setWindowTitle
```
public void setWindowTitle(String docTitle)
```
  - setWindowTitle
```
public void setWindowTitle()
```
  - getFressa
```
public FressaFunctions getFressa()
```
    FressaFunctions offers special accessibility features like atomatic scanning and voice synthesis.
    
    Specified by:
    
    getFressa in interface PlayStation
    
    Returns:
    The FressaFunctions object, or null if accessibility features are not enabled

Class Player

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface edu.xtec.jclic.Constants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SKIN

DEFAULT_REPORTER

DEFAULT_EVENT_SOUNDS

ACTION_ICONS

DEFAULT_APP_NAME

actions

messages

project

actPanel

history

skin

defaultSkin

activeMediaBag

reporter

eventSounds

timer

audioEnabled

trace

navButtonsDisabled

navButtonsAlways

appName

Constructor Detail

Player

Player

Method Detail

init

start

activate

stop

finalize

end

createCursors

createEventSounds

initReporter

initSkin

initTimers

closeHelpWindow

setMessages

getTopComponent

getSkin

setSkin

addTo

createFileSystem

setProject

load

load

forceFinishActivity

removeActivity

initActivity

startActivity

doLayout

paintComponent

actionPerformed

getNumActions

buildActions

setActionsText

getActionName

getActionIcon

getAction

processActionEvent

showAbout