agentland.help.display
Interface AFAIKNavigator

All Superinterfaces:

Agent, Good, Managed, Remote, Spy

All Known Implementing Classes:

AFAIKNavigatorAgent

public interface AFAIKNavigator

extends Managed

The interface for AFAIKNavigatorAgent. This agent uses a JavaHelp browser to display HelpFiles.

See Also:

Agent

Fields inherited from interface metaglue.Agent

ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING

Method Summary

void	display(HelpFile hFile) Displays the HTML of the helpfile.
boolean	display(String mID) Display the HelpFile with the name sID.
void	display(URL uFile) Display a simple URL in the content viewer.
void	hide() Brings the AFAIKNavigator to the back of the display.
void	refresh() Refreshes the browser and reloads the HelpSet.
void	show() Sets the frame of the AFAIKNavigator visible and brings the frame to the front of the display.

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

display

public boolean display(String mID)
                throws RemoteException

Display the HelpFile with the name sID. If the name is not found, then nothing is displayed.

Parameters:

sID - a String value

Returns:

a boolean value

Throws:

RemoteException - if an error occurs

display

public void display(HelpFile hFile)
             throws RemoteException

Displays the HTML of the helpfile. The viewer will jump to the current topic within the helpfile's HTML.

Parameters:

hFile - a HelpFile value

Throws:

RemoteException - if an error occurs

display

public void display(URL uFile)
             throws RemoteException

Display a simple URL in the content viewer.

Parameters:

uFile - an URL value

Throws:

RemoteException - if an error occurs

show

public void show()
          throws RemoteException

Sets the frame of the AFAIKNavigator visible and brings the frame to the front of the display.

Throws:

RemoteException - if an error occurs

hide

public void hide()
          throws RemoteException

Brings the AFAIKNavigator to the back of the display.

Throws:

RemoteException - if an error occurs

refresh

public void refresh()
             throws RemoteException

Refreshes the browser and reloads the HelpSet.

Throws:

RemoteException - if an error occurs