Home >> All >> org >> eclipse >> [ help Javadoc ]

•	org.eclipse.help.browser.* (2)	•	org.eclipse.help.internal.* (142)	•	org.eclipse.help.standalone.* (2)
•	org.eclipse.help.ui.* (41)

• org.eclipse.help: Javadoc index of package org.eclipse.help.


Package Samples:

• org.eclipse.help.ui.internal.workingset
• org.eclipse.help.ui.internal.search
• org.eclipse.help.ui.internal.ide
• org.eclipse.help.internal.webapp
• org.eclipse.help.internal.webapp.servlet
• org.eclipse.help.internal.webapp.data
• org.eclipse.help.internal.appserver
• org.eclipse.help.ui.internal.util
• org.eclipse.help.ui.internal.browser.embedded
• org.eclipse.help.ui.internal.browser
• org.eclipse.help.ui.internal
• org.eclipse.help.ui.browser
• org.eclipse.help.standalone
• org.eclipse.help.internal.workingset
• org.eclipse.help.internal.search
• org.eclipse.help.internal.browser.macosx
• org.eclipse.help.internal.browser
• org.eclipse.help.internal.base.util
• org.eclipse.help.internal.base
• org.eclipse.help.internal.standalone

Classes:

• IContext: A context registered for context-sensitive help. This interface models the context-sensitive help that can be associated with SWT menus, menu items, and controls, and with JFace actions. A help context provides the text description of the object with which it is associated with, as well as topic links that contain more related information. This information would be displayed to the user when context sensitive help (F1) is requested. In the current implementation of the Help system, valid contexts can be contributed through the contexts element of the "org.eclipse.help.contexts" extension point. ...
• StandaloneHelp: This is a standalone help system. It takes care of launching the eclipse with its help system implementation, and controling it. This class can be used instantiated and used in a Java program, or can be launched from command line to execute single help action. Usage as a Java component: create an instantance of this class and then hold onto this instance for the duration of your application call start() call displayHelp(...) or displayContext(..) any number of times at the end, call shutdown().
• Help: This is a standalone help system. It takes care of launching the Eclipse with its help system implementation, and controling it. This class can be instantiated and used in a Java program, or can be launched from command line to execute single help action. Usage as a Java component: create an instantance of this class and then hold onto this instance for the duration of your application call start() call displayHelp(...) or displayContext(..) any number of times at the end, call shutdown().
• IHelpContentProducer: Producer capable of generating or otherwise obtaining contents for help resources. A plug-in can contribute instance of IHelpContentProducer to "org.eclipse.help.contentProducer" extension point. When content for a resource is needed from a plug-in is needed, help tries to obtain content from instance of this class contributed by the plugin. If IHelpContentProvider does not return the content, help system searches doc.zip and plug-in install location for the file and reads its content.
• LaunchURL: Action that launches a URL in a browser. This class is intended to be specified as a value of a class attribute of an action element in plugin.xml for extensions of org.eclipse.ui.actionSets extension point. The action element must have an attribute named url, in addition to markup required by org.eclipse.ui.actionSets extension point specification. The value of the url attribute should specify a URL to be opened in a browser.
• Infocenter: This is a standalone infocenter. It takes care of launching the Eclipse with its help system implementation. This class can be instantiated and used in a Java program, or can be launched from command line. Usage as a Java component: create an instantance of this class call start(), infocenter will run when no longer needed call shutdown().
• ControlServlet: Servlet to control Eclipse helpApplication from standalone application. Accepts the following parameters: command=displayHelp | shutdown | install | update | enable | disable | uninstall | search | listFeatures | addSite | removeSite | apply. href - may be provided if comand==displayHelp. featureId, version, from, to, verifyOnly may be provided for update commands
• DefaultHelpUI: This class is an implementation of the Help UI. In is registered into the helpSupport extension point, and is responsible for handling requests to display help. The methods on this class interact with the actual UI component handling the display. Most methods delegate most work to HelpDisplay class; only the UI specific ones implemented in place.
• IWebappServer: Interface to be implemented by the app servers that are contributed to the org.eclipse.webapp.server extension point. The implementors of this class should ensure that webapps are running in an environment in which they can see their classes, the J2SE/J2EE classes, as well as classes loaded by the custom class loader.
• HelpApplication: Help application. Starts webserver and help web application for use by infocenter and stand-alone help. Application takes a parameter "mode", that can take values: "infocenter" - when help system should run as infocenter, "standalone" - when help system should run as standalone.
• HelpSystem: This class provides general access to help content contributed to the "org.eclipse.help.toc" and "org.eclipse.help.contexts" extension points. This class provides static methods only; it is not intended to be instantiated or subclassed.
• IStyledContext: An enhanced version of org.eclipse.help.IContext interface allowing obtaining a styled text. Used by Intro plug-ing and org.eclipse.help.ui.internal.ContextHelpDialog TODO Create interface that will return description as XML and make it public
• TocServlet: URL-like description of help table of contents. toc/pluginid/tocfile.xml: the toc defined by the specified toc xml toc/: all the toc's toc/?topic=/pluginid/topic.html: a list of toc that contain the specified topic
• PluginClassLoaderWrapper: Wrapper for a plugin class loader. This class is only needed because the current PluginClassLoader is not clearly exposed as a URLClassLoader and its getURLs() method does not properly return the list of url's (it misses required jars, etc.)
• PluginVersionInfo: Table of plugins. Records all plugins, their version, corresponding fragments versions The values are String in format: pluginID\npluginVersion\nfragment1ID\nfragment1Version\nfragment2ID\nfragment2Version
• IndexingOperation: Indexing Operation represents a long operation, which performs indexing of the group (Collection) of documents. It is used Internally by SlowIndex and returned by its getIndexUpdateOperation() method.
• ILiveHelpAction: Live Help Extension. Classes that implement this interface can be used as live help extensions. When user clicks a live help link in a help document, the class will be loaded and run.
• IHelpResource: A help resource, usually a help topic. This interface models a help resource. In general, help resources are either html help files, or table of contents XML files.
• INavigationElement: Part of help navigation model corresponding to any of: TOC, TOPIC, ANCHOR, or LINK element. After navigation is built, this may contain TOC, TOPIC, LINK, or ANCHOR elements.
• RuntimeErrorDialog: This is the Dialog box that displays all the errors the occur during the initial load of the Help System. It's data (model) is taken from the RuntimeHelpStatus object.
• LazyProgressMonitor: Progress Monitor, that accumulates work without communicating it immidiately to the underlying monitor. The work is sent in larger chunks for performance reasons.
• FastStack: Fast Stack is similar to java.uiti.Stack, but simplified for speed. It uses ArrayList as an underlying collection. The methods in this class are not thread safe.
• HTMLDocParser: Parser HTML documents. Extracts document encoding from header, and delegates to lucene HTML parser for extraction of title, summary, and content.

Home | Contact Us | Privacy Policy | Terms of Service