Package ipsk.apps.speechrecorder.prompting

Class PromptViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ipsk.apps.speechrecorder.prompting.PromptViewer

All Implemented Interfaces:

DialogTargetProvider, PromptPresenterListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class PromptViewer
extends javax.swing.JPanel
implements java.beans.PropertyChangeListener, PromptPresenterListener, DialogTargetProvider

PromptViewer displays the recording script prompt on the experimenter and the speaker display. The display changes according to the prompt item's type of media:

• prompt texts are displayed as is
• image items are scaled to fit the display size
• audio items are shown with a clickable audio button
• video items are displayed with a controller to start, stop and pause the display

PromptViewer also displays descriptive text associated with a prompt item. Some display attributes change according to the recording status: the instruction text is printed in black only during the recording phase, otherwise it is gray.

Author:

draxler

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromptViewer.Status

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

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

java.awt.Container.AccessibleAWTContainer

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

javax.swing.JComponent.AccessibleJComponent

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

javax.swing.JPanel.AccessibleJPanel

Field Summary

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Constructors

Constructor	Description
PromptViewer(java.util.List<PromptPresenterServiceDescriptor> promptPresenterServiceDescriptors, StartPromptPlaybackAction startPromptPlaybackAction, StopPromptPlaybackAction stopPromptPlaybackAction)	Displays the individual prompt items according to their MIME type.

Method Summary

Modifier and Type	Method	Description
void	addPromptViewerListener(PromptViewerListener listener)
void	close()
void	closeMediaPresenter()
void	displayComments(Reccomment comments)	displayComments() checks whether comments should be displayed at all.
void	displayInstructions(Recinstructions instructions)	checks whether instructions text from the current prompt item is the empty string or null.
java.net.URL	getContext()	Get the context URL for prompt sources.
java.awt.Font	getDescriptionFont()
java.awt.Component	getDialogTarget()
java.awt.Font	getInstructionsFont()
PromptItem	getPromptItem()
int	getRecIndex()
boolean	getShowComments()	Returns true if the comments text is to be displayed, false otherwise
boolean	getSilent()	Returns the audio mute switch for the current display
PromptViewer.Status	getStatus()
java.util.Set<java.util.List<java.lang.String>>	getSupportedMIMETypes()	Returns combinations of supported MIME types
void	init()
boolean	isClosed()
boolean	isInstructionNumbering()
boolean	isShowPrompt()
void	open()
void	prepare()
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	removePromptViewerListener(PromptViewerListener listener)
void	setContext(java.net.URL url)	Set the context URL for prompt sources.
void	setDescriptionFont(java.awt.Font font)
void	setDialogTargetProvider(DialogTargetProvider dialogTargetProvider)
void	setInstructionNumbering(boolean instructionNumbering)
void	setInstructionsEmphased(boolean b)
void	setInstructionsFont(java.awt.Font font)
void	setPromptAudioChannelOffset(int audioChannelOffset)
void	setPromptEmphased(boolean b)
void	setPromptFont(java.awt.Font font)
void	setPromptItem(PromptItem promptItem)
void	setPromptMixer(javax.sound.sampled.Mixer mixer)
void	setPromptPresenterEnabled(boolean b)
void	setRecIndex(java.lang.Integer recIndex)
void	setShowComments(boolean comments)	Sets the switch for displaying comments text to true or false
void	setShowPrompt(boolean showPrompt)
void	setSilent(boolean silence)	Sets the switch for audio output.
void	start()
void	stop()
void	update(PromptPresenterEvent promptPresenterEvent)
protected void	updateListeners(PromptViewerEvent event)

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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, 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 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, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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 javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PromptViewer

public PromptViewer(java.util.List<PromptPresenterServiceDescriptor> promptPresenterServiceDescriptors,
                    StartPromptPlaybackAction startPromptPlaybackAction,
                    StopPromptPlaybackAction stopPromptPlaybackAction)

Displays the individual prompt items according to their MIME type. PromptViewer is notified of status changes from the prompt presenter.

Parameters:

promptPresenterServiceDescriptors - list of available prompt presenter descriptors

startPromptPlaybackAction - action to start prompt playback

stopPromptPlaybackAction - action to stop prompt playback

Method Detail

getSupportedMIMETypes

public java.util.Set<java.util.List<java.lang.String>> getSupportedMIMETypes()

Returns combinations of supported MIME types

Returns:

combinations of supported MIME types

setPromptMixer

public void setPromptMixer(javax.sound.sampled.Mixer mixer)
                    throws PromptPresenterPluginException

Throws:

PromptPresenterPluginException

setPromptAudioChannelOffset

public void setPromptAudioChannelOffset(int audioChannelOffset)
                                 throws PromptPresenterPluginException

Throws:

PromptPresenterPluginException

setSilent

public void setSilent(boolean silence)

Sets the switch for audio output. If true, then audio sound is muted. This switch is necessary to have only one source of audio output, e.g. the speaker display, but not the experimenter display.

Parameters:

silence - true to mute audio output

getSilent

public boolean getSilent()

Returns the audio mute switch for the current display

Returns:

true if the audio is muted

getShowComments

public boolean getShowComments()

Returns true if the comments text is to be displayed, false otherwise

Returns:

true to show comments text

setShowComments

public void setShowComments(boolean comments)

Sets the switch for displaying comments text to true or false

Parameters:

comments -

displayInstructions

public void displayInstructions(Recinstructions instructions)

checks whether instructions text from the current prompt item is the empty string or null. If yes, then the instructions are not displayed, otherwise the text is displayed.

Parameters:

instructions - text of the instructions field of the current prompt item

displayComments

public void displayComments(Reccomment comments)

displayComments() checks whether comments should be displayed at all. If yes, then it checks whether the comments text from the current prompt item is the empty string or null. If yes, then the comments are not displayed, otherwise the comments text is displayed.

Parameters:

comments - text of the comment field of the current prompt item

init

public void init()

prepare

public void prepare()
             throws PromptPresenterException

Throws:

PromptPresenterException

isShowPrompt

public boolean isShowPrompt()

setShowPrompt

public void setShowPrompt(boolean showPrompt)

open

public void open()
          throws PromptViewerException

Throws:

PromptViewerException

start

public void start()

stop

public void stop()

close

public void close()

setInstructionsEmphased

public void setInstructionsEmphased(boolean b)

setPromptEmphased

public void setPromptEmphased(boolean b)

setPromptPresenterEnabled

public void setPromptPresenterEnabled(boolean b)

setPromptFont

public void setPromptFont(java.awt.Font font)

Parameters:

font -

getDescriptionFont

public java.awt.Font getDescriptionFont()

getInstructionsFont

public java.awt.Font getInstructionsFont()

setDescriptionFont

public void setDescriptionFont(java.awt.Font font)

setInstructionsFont

public void setInstructionsFont(java.awt.Font font)

isInstructionNumbering

public boolean isInstructionNumbering()

setInstructionNumbering

public void setInstructionNumbering(boolean instructionNumbering)

getContext

public java.net.URL getContext()

Get the context URL for prompt sources.

Returns:

context URL

setContext

public void setContext(java.net.URL url)

Set the context URL for prompt sources. This is usually the workspace project directory.

Parameters:

url - context

updateListeners

protected void updateListeners(PromptViewerEvent event)

addPromptViewerListener

public void addPromptViewerListener(PromptViewerListener listener)

removePromptViewerListener

public void removePromptViewerListener(PromptViewerListener listener)

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

getPromptItem

public PromptItem getPromptItem()

setPromptItem

public void setPromptItem(PromptItem promptItem)

getRecIndex

public int getRecIndex()

setRecIndex

public void setRecIndex(java.lang.Integer recIndex)

update

public void update(PromptPresenterEvent promptPresenterEvent)

Specified by:

update in interface PromptPresenterListener

closeMediaPresenter

public void closeMediaPresenter()

isClosed

public boolean isClosed()

getStatus

public PromptViewer.Status getStatus()

setDialogTargetProvider

public void setDialogTargetProvider(DialogTargetProvider dialogTargetProvider)

Parameters:

dialogTargetProvider -

getDialogTarget

public java.awt.Component getDialogTarget()

Specified by:

getDialogTarget in interface DialogTargetProvider