| Home >> All >> org >> eclipse >> help >> [ internal Javadoc ] |
Page 1 2
• org.eclipse.help.internal: Javadoc index of package org.eclipse.help.internal.
Package Samples:
• org.eclipse.help.internal.appserver
• 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
• org.eclipse.help.internal.util
• org.eclipse.help.internal.toc
• org.eclipse.help.internal.protocols
• org.eclipse.help.internal.context
• org.eclipse.help.internal.model
Classes:
• 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().
• 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
• 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.
• 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.
• 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.
• 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.
• InfocenterWorkingSetManager: The Infocenter working set manager stores help working sets. Working sets are persisted in client cookies whenever one is added or removed.
• IErrorUtil: Utility interface for displaying an error message. Implementation may output messages in different ways (log, console, pop up window).
• ToolbarButton: This class calls eclipse API's directly, so it should only be instantiated in the workbench scenario, not in the infocenter.
• Topic: Topic. Visible navigation element. Labeled, contains linik to a document. Can also act as a container for other documents.
• QueryWordsPhrase: Represents a phrase (not quoted) token in user search query words It consists of several words created by an analyzer
• EclipseConnection: This program is used to start or stop Eclipse Infocenter application. It should be launched from command line.
• EclipseController: This program is used to start or stop Eclipse Infocenter application. It should be launched from command line.
• WorkingSetManager: The working set manager stores help working sets. Working sets are persisted whenever one is added or removed.
• IHelpWorkingSetManager: The working set manager stores help working sets. Working sets are persisted whenever one is added or removed.
| Home | Contact Us | Privacy Policy | Terms of Service |