agentland.help
Interface AFAIKAction

All Superinterfaces:

Agent, Good, Managed, Remote, Spy

All Known Implementing Classes:

AFAIKActionAgent

public interface AFAIKAction

extends Managed

AFAIKActionAgent takes information from AFAIK and AFAIKSpeech, and presents it via AFAIKNavigator or SpeechTextOutput. This class is also used as an interpreter for hypertext-like commands from AFAIKNavigator, such as "say://Hello World"

See Also:

Managed

Fields inherited from interface metaglue.Agent

ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING

Method Summary

boolean	interpretHyperlink(String sHyperlink) interpretHyperlink interprets hyperlink-like commands, such as "say://" or "helpfile://" in HTML files, and calls the requested action.
void	present(HelpFile hFile) Present the HelpFile using the AFAIKNavigator.
void	present(HelpFile hFile, String sText) Present the HelpFile using the AFAIKNavigator and speak the associated text using the speech synthesizer.
void	present(String sText) Speak the text using a speech synthesizer.

Methods inherited from interface agentland.resource.Managed

getNeed, replace, replace, resources, yank, yank

Methods inherited from interface agentland.util.Good

getHistory, getHistoryElement, resetHistory

Methods inherited from interface metaglue.Agent

addMonitor, alive, getAgentID, getMetaglueAgentID, shutdown, startup, whereAreYou

Methods inherited from interface agentland.util.Spy

tell

Method Detail

interpretHyperlink

public boolean interpretHyperlink(String sHyperlink)
                           throws RemoteException

interpretHyperlink interprets hyperlink-like commands, such as "say://" or "helpfile://" in HTML files, and calls the requested action. You can add to this method to implement your own actions.

Parameters:

sHyperlink - a String value

Returns:

a boolean value

Throws:

RemoteException - if an error occurs

present

public void present(HelpFile hFile,
                    String sText)
             throws RemoteException

Present the HelpFile using the AFAIKNavigator and speak the associated text using the speech synthesizer.

Parameters:

hFile - a HelpFile value

sText - a String value

present

public void present(HelpFile hFile)
             throws RemoteException

Present the HelpFile using the AFAIKNavigator.

Parameters:

hFile - a HelpFile value

present

public void present(String sText)
             throws RemoteException

Speak the text using a speech synthesizer.

Parameters:

sText - a String value