org.speakright.sro
Class SROListNavigator

java.lang.Object
  org.speakright.core.FlowBase
      org.speakright.core.flows.QuestionFlow
          org.speakright.sro.BaseSROQuestion
              org.speakright.sro.gen.genSROListNavigator
                  org.speakright.sro.SROListNavigator

All Implemented Interfaces:

java.io.Serializable, IFlow

Direct Known Subclasses:

App.VotingResultsList

public class SROListNavigator
extends genSROListNavigator

See Also:

Serialized Form

Nested Class Summary

static class

SROListNavigator.Command

Nested classes/interfaces inherited from class org.speakright.sro.BaseSROQuestion

BaseSROQuestion.MyConfirmationWrapper

Field Summary

protected int	m_currentIndex
protected java.util.ArrayList<IModelItem>	m_L
protected int	m_numItems
protected boolean	m_wentPastBeginning
protected boolean	m_wentPastEnd

Fields inherited from class org.speakright.sro.gen.genSROListNavigator

m_cantGoNextPrompt, m_cantGoPreviousPrompt, m_emptyListPrompt, m_navigateGrammar, m_numberOfItemsInListSingularSubPrompt, m_numberOfItemsInListSubPrompt, m_outOfRangePrompt, m_sayCurrentItemPrompt

Fields inherited from class org.speakright.sro.BaseSROQuestion

m_cmds, m_main1Prompt, m_maxReExecutions, m_modelVar, m_noreco1Prompt, m_noreco2Prompt, m_noreco3Prompt, m_noreco4Prompt, m_prefixPrompt, m_silence1Prompt, m_silence2Prompt, m_silence3Prompt, m_silence4Prompt, m_slotName, m_subject, m_subjectWord

Fields inherited from class org.speakright.core.flows.QuestionFlow

m_quest

Constructor Summary

SROListNavigator(java.lang.String subject)

SROListNavigator(java.lang.String subject, java.util.ArrayList<IModelItem> L, int junk)

SROListNavigator(java.lang.String subject, java.util.ArrayList<java.lang.String> L)

Method Summary

void	execute(IExecutionContext context) The default implementation of execute is to render this object.
IFlow	getNext(IFlow current, SRResults results) The default implementation of getNext is to return null.
protected void	initList(java.util.ArrayList<java.lang.String> L)
void	initPrompts(IExecutionContext context)
void	setItemFormatter(IItemReusableFormatter formatter) Set a formatter that will be used for format the items in the list.

Methods inherited from class org.speakright.sro.gen.genSROListNavigator

initSubPrompts, set_cantGoNextPrompt, set_cantGoPreviousPrompt, set_emptyListPrompt, set_navigateGrammar, set_numberOfItemsInListPrompt, set_numberOfItemsInListSingularPrompt, set_outOfRangePrompt, set_sayCurrentItemPrompt

Methods inherited from class org.speakright.sro.BaseSROQuestion

addCancelCommand, addCommand, initMainPrompt, initPrompt, initPrompts, onValidateFailed, set_main1Prompt, set_noreco1Prompt, set_noreco2Prompt, set_noreco3Prompt, set_noreco4Prompt, set_prefixPrompt, set_silence1Prompt, set_silence2Prompt, set_silence3Prompt, set_silence4Prompt, setConfirmer, setModelVar, setPromptCondition, setSubjectPlurality

Methods inherited from class org.speakright.core.flows.QuestionFlow

add, addBinding, addGrammar, addGrammar, addPrompt, createRenderer, InitPrompts

Methods inherited from class org.speakright.core.FlowBase

executionCount, fixupGrammar, fixupPrompt, getFirst, getSubFlowAfter, log, logError, name, onBegin, onCatch, onComplete, onDisconnect, onEnd, onNoInput, onPlatformError, onTransferFailed, promptGroup, setExecutionCount, setName, setPromptGroup, shouldExecute, validateInput

Methods inherited from class java.lang.Object

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

Field Detail

m_L

protected java.util.ArrayList<IModelItem> m_L

m_numItems

protected int m_numItems

m_currentIndex

protected int m_currentIndex

m_wentPastEnd

protected transient boolean m_wentPastEnd

m_wentPastBeginning

protected transient boolean m_wentPastBeginning

Constructor Detail

SROListNavigator

public SROListNavigator(java.lang.String subject)

SROListNavigator

public SROListNavigator(java.lang.String subject,
                        java.util.ArrayList<java.lang.String> L)

SROListNavigator

public SROListNavigator(java.lang.String subject,
                        java.util.ArrayList<IModelItem> L,
                        int junk)

Method Detail

initList

protected void initList(java.util.ArrayList<java.lang.String> L)

setItemFormatter

public void setItemFormatter(IItemReusableFormatter formatter)

Set a formatter that will be used for format the items in the list.

Parameters:

formatter - a reusable formatter. This single formatter object will be used on all the items in the list.

initPrompts

public void initPrompts(IExecutionContext context)

Overrides:

initPrompts in class BaseSROQuestion

getNext

public IFlow getNext(IFlow current,
                     SRResults results)

Description copied from class: FlowBase

The default implementation of getNext is to return null.

Specified by:

getNext in interface IFlow

Overrides:

getNext in class BaseSROQuestion

Parameters:

current - the currently executing flow object. More precisely, current is the flow object that this object most recently returned from getFirst or getNext.

results - the results of current's execution by the speech platform. Results contains user input and/or events such as disconnect or platform-error.

Returns:

the next flow to run, or null which means this flow object is finished.

execute

public void execute(IExecutionContext context)

Description copied from class: FlowBase

The default implementation of execute is to render this object. However the default rendering is a 'silent' voicexml page.

Specified by:

execute in interface IFlow

Overrides:

execute in class genSROListNavigator

Parameters:

context - Contains the page renderer.