org.omegahat.Environment.Interpreter
Class GUIHelpEvaluator

java.lang.Object
  |
  +--org.omegahat.Environment.Interpreter.BasicEvaluator
        |
        +--org.omegahat.Environment.Interpreter.UtilityEvaluator
              |
              +--org.omegahat.Environment.Interpreter.UserClassEvaluator
                    |
                    +--org.omegahat.Environment.Interpreter.InteractiveEvaluator
                          |
                          +--org.omegahat.Environment.Interpreter.GUIHelpEvaluator

All Implemented Interfaces:

DatabaseCustomer, Evaluator, InputConsumer, ManagedEvaluatorInt, PromptSource, java.lang.Runnable, java.io.Serializable

public class GUIHelpEvaluator

extends InteractiveEvaluator

This evaluator adds an interactive GUI-based help system using the JavaHelp tools.

See Also:

Serialized Form

Field Summary

protected javax.help.JHelp

helpWindow

Fields inherited from class org.omegahat.Environment.Interpreter.InteractiveEvaluator

continuation, continuationPrompt, interrupt, notify_listeners, pendingInput, promptExpression

Fields inherited from class org.omegahat.Environment.Interpreter.UserClassEvaluator

classManager

Fields inherited from class org.omegahat.Environment.Interpreter.BasicEvaluator

allowUnrestrictedAccess, class_lists, currentExpression, data, databases, debugger, DefaultAttachIndex, defaultDatabase, dynamicClassLoader, errorHandler, evaluationEvent, evaluationListeners, initialized, internalFunctionTables, internalPrimitiveClassNames, internalPrimitiveClassTable, lexer, localClasses, manager, options, output, parser, primitive_classes, primitiveClasses, PrimitiveClassNames, primitiveTypeNames, primitiveTypes, reversePrimitiveTypes, ShowMultipleClasses, sourceStack, stderr, stdout, SubEvaluationListeners, taskHistory, toplevelExpression, warningMessages

Fields inherited from interface org.omegahat.Environment.Interpreter.Evaluator

ThisVariableName

Constructor Summary

GUIHelpEvaluator()

GUIHelpEvaluator(Evaluator src)

GUIHelpEvaluator(EvaluatorManager mgr)

GUIHelpEvaluator(Options opts)

Method Summary

java.lang.Object	help() Brings up a window containing the default help page, table of contents and index.
java.lang.Object	help(javax.help.HelpSet helpSet, java.lang.String id) Load the specified Help Set into the default help window and jump to the node.
java.lang.Object	help(java.lang.String id) Jumps to the specified node in the help system as indexed by JavaHelp map, creating the help window if necessary.
java.lang.Object	help(java.lang.String helpSetName, java.lang.String id) Load the specified help set and jump to the specified node.
java.lang.Object	help(java.net.URL url, java.lang.String id) Load the help set from the specified URL into the help system window and jump to the specified node in the map.

Methods inherited from class org.omegahat.Environment.Interpreter.InteractiveEvaluator

currentExpression, deserialize, deserialize, deserialize, deserialize, deserialize, deserialize, evaluate, inputReady, inputReady, interrupt, notify_listeners, notify_listeners, notifyListeners, parserError, prompt, promptExpression, promptExpression, promptExpression, serialize, serialize, serialize, serialize

Methods inherited from class org.omegahat.Environment.Interpreter.UserClassEvaluator

addMethod, classManager, classManager, createInstance, createInstance, createInstance, defineClass, defineClass, defineClass, defineClass, defineClass, defineClass, DefineUserClass, DefineUserClass, DefineUserClass, findUserClass, findUserClass, parseClass, parser

Methods inherited from class org.omegahat.Environment.Interpreter.UtilityEvaluator

evaluator, exec, exec, findFile, getEvaluator, setProperty, setProperty

Methods inherited from class org.omegahat.Environment.Interpreter.BasicEvaluator

addEvaluationListener, addFunctionTable, addFunctionTable, addSourceInput, addToHistory, allowUnrestrictedAccess, allowUnrestrictedAccess, asObject, asObject, asObject, asObjectName, asPrimitiveClass, assign, assign, assign, asWriter, attach, attach, attach, attach, attach, attach, attach, classInit, classLists, classLists, classPath, classPath, commandLine, convertPrimitive, copy, copy, copyByConstructor, copyBySerialization, createClassLists, currentExpression, data, data, database, database, database, Debug, Debug, Debug, Debug, Debug, debugger, debugger, defaultDatabase, defaultDatabase, defaultDatabase, defaultErrorHandler, detach, detach, displayTask, displayTask, displayWarnings, displayWarnings, dynamicClassLoader, dynamicClassLoader, endSource, endSource, endSource, endTaskEvaluation, error, error, errorHandler, errorHandler, evaluate, evaluate, evaluate, evaluationError, evaluationListeners, evaluationListeners, evaluationListeners, exists, exit, exit, expandClassName, expandedClassPathElement, find, findAsField, findClass, findClass, findClass, findClass, findFunction, findFunctionOrMethod, functionTableList, get, get, get, get, get, get, get, get, get, getBaseURL, getEvaluationEvent, getEvaluationListeners, getField, getSubEvaluationListeners, Import, Import, Import, init, initialize, initTaskEvaluation, internalFunctionTables, isPrimitive, isPrimitive, javaVersion, lexer, lexer, lexer, localClasses, localClasses, manager, manager, newDatabase, newDatabase, notifyListeners, objects, objects, objects, options, options, output, output, output, parse, parse, parse, parse, primitiveClass, q, q, remove, remove, remove, removeFunctionTable, run, same, searchForClass, searchPath, searchPath, searchPath, searchPath, setEvaluationEvent, setEvaluationListeners, setSubEvaluationListeners, show, show, show, source, source, source, source, source, source, source, source, source, sourceStack, stderr, stderr, stdout, stdout, taskHistory, taskHistory, toplevelExpression, toplevelExpression, useLazyEvaluation, warning, warning, warning, warnings, warnings, where, which, which

Methods inherited from class java.lang.Object

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

Field Detail

helpWindow

protected javax.help.JHelp helpWindow

Constructor Detail

GUIHelpEvaluator

public GUIHelpEvaluator()

GUIHelpEvaluator

public GUIHelpEvaluator(Evaluator src)

GUIHelpEvaluator

public GUIHelpEvaluator(EvaluatorManager mgr)

GUIHelpEvaluator

public GUIHelpEvaluator(Options opts)

Method Detail

help

public java.lang.Object help()

Brings up a window containing the default help page, table of contents and index. This is based on the JavaHelp system and requires the jhall.jar file to be installed.

Overrides:

help in class BasicEvaluator

help

public java.lang.Object help(java.lang.String id)

Jumps to the specified node in the help system as indexed by JavaHelp map, creating the help window if necessary.

help

public java.lang.Object help(java.lang.String helpSetName,
                             java.lang.String id)

Load the specified help set and jump to the specified node. The node can be null, in which case we will show the default page for that help set.

help

public java.lang.Object help(java.net.URL url,
                             java.lang.String id)

Load the help set from the specified URL into the help system window and jump to the specified node in the map.

help

public java.lang.Object help(javax.help.HelpSet helpSet,
                             java.lang.String id)

Load the specified Help Set into the default help window and jump to the node.