standup.clouds
Class OptionsCloudFrontend

java.lang.Object
  standup.profiling.Options
      standup.clouds.OptionsCloudFrontend

All Implemented Interfaces:

XMLizable

public class OptionsCloudFrontend
extends Options

Field Summary

private boolean	chooseSpecificLexemes 13.
private boolean	displayMessageBarBelowBubbleBrowser
private boolean	displayProgressMap
private boolean	enableLogging
private boolean	getJokeByTopicMode
private boolean	getJokeByTypeMode
private boolean	getJokeByWordMode
private boolean	getJokeMode
private boolean	getWordByAlphabetMode
private boolean	getWordBySpellingMode
private boolean	getWordByTopicMode
private LexemePictureFilter	lexemePictureFilter 9.
private int	lubbleAnimationStaggerOffset This parameter controls whether the display of buttons is staggered
private boolean	messageFirstThenLubbles
private PointingMethod	pointingMethod Fields and accessor methods determining the modes of interaction available.
private int	scannerDelay The delay for the scanner in seconds.
private int	scannerInitialDelay The INITIAL delay for the scanner in seconds.
private boolean	showDefiniteWordsOnPeripheryAlready
private boolean	speakJokesOnDisplay 12.
private boolean	speakJokesOnRequest
private boolean	speakMessages 11.
private boolean	speakOptionsWhenFocussed 10.
private boolean	speakOptionsWhenSelected
private boolean	spellWordClustered
private SymbolType[]	symbolSet 8.
private SymbolSupport	symbolSupport 7.
private boolean	textInput
static String	XMLTAG

Constructor Summary

OptionsCloudFrontend()

OptionsCloudFrontend(boolean getJokeMode, boolean getJokeByTopicMode, boolean getJokeByWordMode, boolean getJokeByTypeMode, boolean getWordByTopicMode, boolean getWordByAlphabetMode, boolean getWordBySpellingMode, boolean textInput, PointingMethod pointingMethod, SymbolSupport symbolSupport, SymbolType[] symbolSet, LexemePictureFilter lexemePictureFilter, boolean speakOptionsWhenFocussed, boolean speakOptionsWhenSelected, boolean speakMessages, boolean speakJokesOnDisplay, boolean speakJokesOnRequest, boolean chooseSpecificLexemes, int menuAnimationStaggerOffset, boolean messageFirstThenMenu, boolean spellWordClustered, boolean showDefiniteWordsOnPeripheryAlready, boolean displayProgressMap, boolean displayMessageBarBelowMenu, int scannerInitialDelay, int scannerDelay, boolean enableLogging)
Constructor method where options are supplied directly

OptionsCloudFrontend(Element rootElement)
Constructor method where options are supplied from an appropriate XML element.

Method Summary

String	getDiffString(Options options) Returns a String that reports the difference between this instance and the given Options.
OptionsGUI	getGUI(Dimension size) Returns an instance of an appropriate OptionsGUI.
LexemePictureFilter	getLexemePictureFilter()
int	getLubbleAnimationStaggerOffset()
PointingMethod	getPointingMethod()
int	getScannerDelayInSeconds()
int	getScannerInitialDelayInSeconds()
SymbolType[]	getSymbolSet()
SymbolSupport	getSymbolSupport()
String	getXMLTag() Returns the XML tag associated with this implementation of Options.
boolean	isChooseSpecificLexemes()
boolean	isDisplayMessageBarBelowBubbleBrowser()
boolean	isDisplayProgressMap()
boolean	isEnableLogging()
boolean	isGetJokeByTopicMode()
boolean	isGetJokeByTypeMode()
boolean	isGetJokeByWordMode()
boolean	isGetJokeMode()
boolean	isGetWordByAlphabetMode()
boolean	isGetWordBySpellingMode()
boolean	isGetWordByTopicMode()
boolean	isMessageFirstThenMenu()
boolean	isShowDefiniteWordsOnPeripheryAlready()
boolean	isSpeakJokesOnDisplay()
boolean	isSpeakJokesOnRequest()
boolean	isSpeakMessages()
boolean	isSpeakOptionsWhenFocussed()
boolean	isSpeakOptionsWhenSelected()
boolean	isSpellWordClustered()
boolean	isTextInput()
private static LexemePictureFilter	parseLexemePictureFilter(String lexemePictureFilterTextValue)
private static PointingMethod	parsePointingMethod(String pointingMethodTextValue)
private static SymbolType[]	parseSymbolSet(Element ssEl)
private static SymbolSupport	parseSymbolSupport(String symbolSupportTextValue)
void	setChooseSpecificLexemes(boolean chooseSpecificLexemes)
void	setDisplayMessageBarBelowBubbleBrowser(boolean displayMessageBarBelowBubbleBrowser)
void	setDisplayProgressMap(boolean displayProgressMap)
void	setEnableLogging(boolean enableLogging)
void	setGetJokeByTopicMode(boolean getJokeByTopicMode)
void	setGetJokeByTypeMode(boolean getJokeByTypeMode)
void	setGetJokeByWordMode(boolean getJokeByWordMode)
void	setGetJokeMode(boolean getJokeMode)
void	setGetWordByAlphabetMode(boolean getJokeByAlphabetMode)
void	setGetWordBySpellingMode(boolean getJokeBySpellingMode)
void	setGetWordByTopicMode(boolean getJokeByTopicMode)
void	setLexemePictureFilter(LexemePictureFilter lexemePictureFilter)
void	setLubbleAnimationStaggerOffset(int lubbleAnimationStaggerOffset)
void	setMessageFirstThenLubbles(boolean messageFirstThenLubbles)
void	setPointingMethod(PointingMethod p)
void	setScannerDelayInSeconds(int scannerDelay)
void	setScannerInitialDelayInSeconds(int scannerInitialDelay)
void	setShowDefiniteWordsOnPeripheryAlready(boolean showDefiniteWordsOnPeripheryAlready)
void	setSpeakJokesOnDisplay(boolean speakJokesOnDisplay)
void	setSpeakJokesOnRequest(boolean speakJokesOnRequest)
void	setSpeakMessages(boolean speakMessages)
void	setSpeakOptionsWhenFocussed(boolean speakOptionsWhenFocussed)
void	setSpeakOptionsWhenSelected(boolean speakOptionsWhenSelected)
void	setSpellWordClustered(boolean spellWordClustered)
void	setSymbolSet(SymbolType[] s)
void	setSymbolSupport(SymbolSupport s)
void	setTextInput(boolean textInput)
void	writeXML(Writer out, String indent) This method writes the necessary information contained within an instance to an XML file.

Methods inherited from class standup.profiling.Options

isModified, setModified

Methods inherited from class java.lang.Object

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

Field Detail

XMLTAG

public static final String XMLTAG

See Also:

Constant Field Values

getJokeMode

private boolean getJokeMode

getJokeByTopicMode

private boolean getJokeByTopicMode

getJokeByWordMode

private boolean getJokeByWordMode

getJokeByTypeMode

private boolean getJokeByTypeMode

getWordByTopicMode

private boolean getWordByTopicMode

getWordByAlphabetMode

private boolean getWordByAlphabetMode

getWordBySpellingMode

private boolean getWordBySpellingMode

textInput

private boolean textInput

pointingMethod

private PointingMethod pointingMethod

Fields and accessor methods determining the modes of interaction available. Mouse mode: hover over = highlight (color white, and possibly speak label) mouseclick = select Touchscreen mode: first click = highlight (dehighlight others, color white, and possibly speak label) second click = select Scan mode: cycle through each element highlighting (color white, and possibly speak label) key press = select

symbolSupport

private SymbolSupport symbolSupport

7. Symbol support Fields and accessor methods determining the behaviour of symbol support

symbolSet

private SymbolType[] symbolSet

8. Symbol set

lexemePictureFilter

private LexemePictureFilter lexemePictureFilter

9. Lexeme picture filtering

speakOptionsWhenFocussed

private boolean speakOptionsWhenFocussed

10. Speech options

speakOptionsWhenSelected

private boolean speakOptionsWhenSelected

speakMessages

private boolean speakMessages

11. Speak messages

speakJokesOnDisplay

private boolean speakJokesOnDisplay

12. Speak jokes

speakJokesOnRequest

private boolean speakJokesOnRequest

scannerDelay

private int scannerDelay

The delay for the scanner in seconds. Defaults to 1 second.

scannerInitialDelay

private int scannerInitialDelay

The INITIAL delay for the scanner in seconds. Defaults to 1 second.

chooseSpecificLexemes

private boolean chooseSpecificLexemes

13. ADDITIONAL PARAMETERS

lubbleAnimationStaggerOffset

private int lubbleAnimationStaggerOffset

This parameter controls whether the display of buttons is staggered

messageFirstThenLubbles

private boolean messageFirstThenLubbles

spellWordClustered

private boolean spellWordClustered

showDefiniteWordsOnPeripheryAlready

private boolean showDefiniteWordsOnPeripheryAlready

displayProgressMap

private boolean displayProgressMap

displayMessageBarBelowBubbleBrowser

private boolean displayMessageBarBelowBubbleBrowser

enableLogging

private boolean enableLogging

Constructor Detail

OptionsCloudFrontend

public OptionsCloudFrontend(boolean getJokeMode,
                            boolean getJokeByTopicMode,
                            boolean getJokeByWordMode,
                            boolean getJokeByTypeMode,
                            boolean getWordByTopicMode,
                            boolean getWordByAlphabetMode,
                            boolean getWordBySpellingMode,
                            boolean textInput,
                            PointingMethod pointingMethod,
                            SymbolSupport symbolSupport,
                            SymbolType[] symbolSet,
                            LexemePictureFilter lexemePictureFilter,
                            boolean speakOptionsWhenFocussed,
                            boolean speakOptionsWhenSelected,
                            boolean speakMessages,
                            boolean speakJokesOnDisplay,
                            boolean speakJokesOnRequest,
                            boolean chooseSpecificLexemes,
                            int menuAnimationStaggerOffset,
                            boolean messageFirstThenMenu,
                            boolean spellWordClustered,
                            boolean showDefiniteWordsOnPeripheryAlready,
                            boolean displayProgressMap,
                            boolean displayMessageBarBelowMenu,
                            int scannerInitialDelay,
                            int scannerDelay,
                            boolean enableLogging)

Constructor method where options are supplied directly

OptionsCloudFrontend

public OptionsCloudFrontend()
                     throws ProfileException

Throws:

ProfileException

OptionsCloudFrontend

public OptionsCloudFrontend(Element rootElement)

Constructor method where options are supplied from an appropriate XML element. Note that the given element should not be the element, but its root, i.e. a element or an element.

Method Detail

getGUI

public OptionsGUI getGUI(Dimension size)

Description copied from class: Options

Returns an instance of an appropriate OptionsGUI. The given Dimension indicates the preferred size. If given null, it will attempt to calculate a suitable size.

Specified by:

getGUI in class Options

Returns:

getXMLTag

public String getXMLTag()

Description copied from class: Options

Returns the XML tag associated with this implementation of Options.

Specified by:

getXMLTag in class Options

Returns:

writeXML

public void writeXML(Writer out,
                     String indent)
              throws IOException,
                     XMLException

Description copied from interface: XMLizable

This method writes the necessary information contained within an instance to an XML file.

Parameters:

out - The output stream for the XML file, which is assumed to be already opened and writable.

indent - A string to be prepended before every line written by this method. If passed appropriate white space, e.g. XMLUtils.xmlIndent, it can be used to control indentation.

Throws:

IOException

XMLException

isGetJokeMode

public boolean isGetJokeMode()

setGetJokeMode

public void setGetJokeMode(boolean getJokeMode)

isGetJokeByTopicMode

public boolean isGetJokeByTopicMode()

setGetJokeByTopicMode

public void setGetJokeByTopicMode(boolean getJokeByTopicMode)

isGetJokeByWordMode

public boolean isGetJokeByWordMode()

setGetJokeByWordMode

public void setGetJokeByWordMode(boolean getJokeByWordMode)

isGetJokeByTypeMode

public boolean isGetJokeByTypeMode()

setGetJokeByTypeMode

public void setGetJokeByTypeMode(boolean getJokeByTypeMode)

isGetWordByTopicMode

public boolean isGetWordByTopicMode()

setGetWordByTopicMode

public void setGetWordByTopicMode(boolean getJokeByTopicMode)

isGetWordByAlphabetMode

public boolean isGetWordByAlphabetMode()

setGetWordByAlphabetMode

public void setGetWordByAlphabetMode(boolean getJokeByAlphabetMode)

isGetWordBySpellingMode

public boolean isGetWordBySpellingMode()

setGetWordBySpellingMode

public void setGetWordBySpellingMode(boolean getJokeBySpellingMode)

isTextInput

public boolean isTextInput()

setTextInput

public void setTextInput(boolean textInput)

setPointingMethod

public void setPointingMethod(PointingMethod p)

getPointingMethod

public PointingMethod getPointingMethod()

setSymbolSupport

public void setSymbolSupport(SymbolSupport s)

getSymbolSupport

public SymbolSupport getSymbolSupport()

setSymbolSet

public void setSymbolSet(SymbolType[] s)

getSymbolSet

public SymbolType[] getSymbolSet()

getLexemePictureFilter

public LexemePictureFilter getLexemePictureFilter()

setLexemePictureFilter

public void setLexemePictureFilter(LexemePictureFilter lexemePictureFilter)

isSpeakOptionsWhenFocussed

public boolean isSpeakOptionsWhenFocussed()

setSpeakOptionsWhenFocussed

public void setSpeakOptionsWhenFocussed(boolean speakOptionsWhenFocussed)

isSpeakOptionsWhenSelected

public boolean isSpeakOptionsWhenSelected()

setSpeakOptionsWhenSelected

public void setSpeakOptionsWhenSelected(boolean speakOptionsWhenSelected)

isSpeakMessages

public boolean isSpeakMessages()

setSpeakMessages

public void setSpeakMessages(boolean speakMessages)

isSpeakJokesOnDisplay

public boolean isSpeakJokesOnDisplay()

setSpeakJokesOnDisplay

public void setSpeakJokesOnDisplay(boolean speakJokesOnDisplay)

isSpeakJokesOnRequest

public boolean isSpeakJokesOnRequest()

setSpeakJokesOnRequest

public void setSpeakJokesOnRequest(boolean speakJokesOnRequest)

getScannerDelayInSeconds

public int getScannerDelayInSeconds()

setScannerDelayInSeconds

public void setScannerDelayInSeconds(int scannerDelay)

getScannerInitialDelayInSeconds

public int getScannerInitialDelayInSeconds()

setScannerInitialDelayInSeconds

public void setScannerInitialDelayInSeconds(int scannerInitialDelay)

isChooseSpecificLexemes

public boolean isChooseSpecificLexemes()

setChooseSpecificLexemes

public void setChooseSpecificLexemes(boolean chooseSpecificLexemes)

getLubbleAnimationStaggerOffset

public int getLubbleAnimationStaggerOffset()

setLubbleAnimationStaggerOffset

public void setLubbleAnimationStaggerOffset(int lubbleAnimationStaggerOffset)

isMessageFirstThenMenu

public boolean isMessageFirstThenMenu()

setMessageFirstThenLubbles

public void setMessageFirstThenLubbles(boolean messageFirstThenLubbles)

isSpellWordClustered

public boolean isSpellWordClustered()

setSpellWordClustered

public void setSpellWordClustered(boolean spellWordClustered)

isShowDefiniteWordsOnPeripheryAlready

public boolean isShowDefiniteWordsOnPeripheryAlready()

setShowDefiniteWordsOnPeripheryAlready

public void setShowDefiniteWordsOnPeripheryAlready(boolean showDefiniteWordsOnPeripheryAlready)

isDisplayProgressMap

public boolean isDisplayProgressMap()

setDisplayProgressMap

public void setDisplayProgressMap(boolean displayProgressMap)

isDisplayMessageBarBelowBubbleBrowser

public boolean isDisplayMessageBarBelowBubbleBrowser()

setDisplayMessageBarBelowBubbleBrowser

public void setDisplayMessageBarBelowBubbleBrowser(boolean displayMessageBarBelowBubbleBrowser)

isEnableLogging

public boolean isEnableLogging()

setEnableLogging

public void setEnableLogging(boolean enableLogging)

parsePointingMethod

private static PointingMethod parsePointingMethod(String pointingMethodTextValue)

parseSymbolSupport

private static SymbolSupport parseSymbolSupport(String symbolSupportTextValue)

parseLexemePictureFilter

private static LexemePictureFilter parseLexemePictureFilter(String lexemePictureFilterTextValue)

parseSymbolSet

private static SymbolType[] parseSymbolSet(Element ssEl)

getDiffString

public String getDiffString(Options options)

Description copied from class: Options

Returns a String that reports the difference between this instance and the given Options. Currently used by the Playback tool to report changes applied when the Control Panel is accessed, since actual keystrokes and mouse movement/clicks are not saved.

Specified by:

getDiffString in class Options

Parameters:

options - The Options to be compared against this instance.

Returns:

A String detailing the difference between the two instances.