agentland.help.display
Class AFAIKNavigatorAgent

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--metaglue.AgentAgent
                          |
                          +--agentland.util.GoodAgent
                                |
                                +--agentland.resource.ManagedAgent
                                      |
                                      +--agentland.help.display.AFAIKNavigatorAgent

All Implemented Interfaces:

AFAIKNavigator, Agent, EventListener, Good, HyperlinkListener, Managed, MetagluePrimitives, Remote, Serializable, Spy

public class AFAIKNavigatorAgent

extends ManagedAgent

implements AFAIKNavigator, HyperlinkListener

This agent uses a JavaHelp browser to display HelpFiles.

See Also:

ManagedAgent, AFAIKNavigator, HyperlinkListener, Serialized Form

Inner classes inherited from class metaglue.AgentAgent

AgentAgent.Attribute

Fields inherited from class agentland.resource.ManagedAgent

rm, society

Fields inherited from class agentland.util.GoodAgent

alert, notifier

Fields inherited from class java.rmi.server.RemoteObject

ref

Fields inherited from interface metaglue.Agent

ALIVE, DIED, NO_METAGLUE, NOT_RUNNING, STARTING

Constructor Summary

AFAIKNavigatorAgent()
Creates a new AFAIKNavigatorAgent instance.

Method Summary

void	display(HelpFile hFile) Displays the HTML of the helpfile.
boolean	display(String sID) 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	hyperlinkUpdate(HyperlinkEvent hLinkEvent) Handles the event when a user clicks on a link.
boolean	isValidID(String sID) Describe isValidID method here.
void	refresh() Refreshed 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 class agentland.resource.ManagedAgent

connect, getAlert, getNeed, isAvailable, isAvailable, reliesOn, reliesOn, replace, replace, request, request, request, requestAgent, requestAgent, resources, resourcesByAgentID, setNeed, tiedTo, yank, yank, yank

Methods inherited from class agentland.util.GoodAgent

addSpy, addSpy, alert, alertString, beep, error, getHistory, getHistoryElement, getPersistentMap, log, notify, removeSpy, removeSpy, resetHistory, safeRely, safeRely, safeRely, setNiceLogName, tell

Methods inherited from class metaglue.AgentAgent

addMonitor, alive, defrost, defrostAll, defrostBoolean, defrostInt, defrostString, fixAttribute, fixAttribute, freeze, freeze, freeze, freezeAll, freezeVar, getAgentID, getAttribute, getCatalog, getCatalogID, getDesignation, getFrozenVariables, getLogLevel, getMetaglueAgent, getMetaglueAgentID, getOccupation, getProperties, getSociety, log, log, lookupClass, obtainMetaglueAgent, obtainMetaglueAgent, obtainMetaglueAgentByName, reliesOn, reliesOnSynch, removeFrozen, replaceExceptionHandler, setFreezeName, setLogLevel, setLogName, shutdown, startAgent, startAgentOn, startAgentOn, startup, status, tiedTo, tiedTo, tiedTo, tiedTo, tieToDesignation, whereAreYou

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

AFAIKNavigatorAgent

public AFAIKNavigatorAgent()
                    throws RemoteException

Creates a new AFAIKNavigatorAgent instance.

Throws:

RemoteException - if an error occurs

Method Detail

refresh

public void refresh()

Refreshed the browser and reloads the HelpSet.

Specified by:

refresh in interface AFAIKNavigator

Following copied from interface: agentland.help.display.AFAIKNavigator

Throws:

RemoteException - if an error occurs

isValidID

public boolean isValidID(String sID)

Describe isValidID method here.

Parameters:

sID - a String value

Returns:

a boolean value

Throws:

RemoteException - if an error occurs

display

public void display(HelpFile hFile)

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

Specified by:

display in interface AFAIKNavigator

Parameters:

hFile - a HelpFile value

Throws:

RemoteException - if an error occurs

display

public boolean display(String sID)

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

Specified by:

display in interface AFAIKNavigator

Parameters:

sID - a String value

Returns:

a boolean value

Throws:

RemoteException - if an error occurs

display

public void display(URL uFile)

Display a simple URL in the content viewer.

Specified by:

display in interface AFAIKNavigator

Parameters:

uFile - an URL value

Throws:

RemoteException - if an error occurs

hyperlinkUpdate

public void hyperlinkUpdate(HyperlinkEvent hLinkEvent)

Handles the event when a user clicks on a link. If the link is a special command, such as say://, then the HelpActionAgent will handle the event. Otherwise, the link is a simple hyperlink, and we go to the hyperlink.

Specified by:

hyperlinkUpdate in interface HyperlinkListener

Parameters:

hLinkEvent - a HyperlinkEvent value

show

public void show()

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

Specified by:

show in interface AFAIKNavigator

Throws:

RemoteException - if an error occurs

hide

public void hide()

Brings the AFAIKNavigator to the back of the display.

Specified by:

hide in interface AFAIKNavigator

Throws:

RemoteException - if an error occurs