JavaHelp Integration
Official
Overview of JavaHelp Integration module
What is New (see all changes)?
-
Aug 19 '13 Added class
HelpUtilsProvide a method for merging of a custom HelpSet object to the master helpset.
-
Nov 8 '10 Added
@HelpSetRegistrationThere is a new annotation to make it easier to register help sets.
-
May 5 '04 object tag was added to invoke default IDE HTML Browser to correctly display external
links
Object tag can be used in HTML content to show external link in default IDE HTML browser.
Use Cases
Exported Interfaces
This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...Group of java interfaces
| Interface Name | In/Out | Stability | Specified in What Document? |
|---|---|---|---|
| JavaHelpIntegrationAPI | Exported | Official | index.html |
Group of property interfaces
| Interface Name | In/Out | Stability | Specified in What Document? |
|---|---|---|---|
| OpenIDE-mergeIntoMaster | Exported | Official |
The context and key OpenIDE/mergeIntoMaster can be set as an attribute on a help set
provided programmatically rather than with an XML file to
customize one attribute. Such programmatic provision is rare
but supported.
|
| javahelp.ignore.modality | Exported | Friend | The help window through JDK 1.5.0 handles modal dialogs by reparenting the help component into a child dialog of any new modal dialog whenever it is shown, and reparenting it back into a frame whenever it is hidden. Under certain circumstances (showing two dialogs sequentially before the frame can be re-shown), it can produce a race condition in the underlying java.awt.Toolkit implementation. As a workaround, callers of DialogDisplayer.getDefault().notify(DialogDescriptor) may set the system property "javahelp.ignore.modality" to the String "true". This system property will be reset by notify(), and applied as a client property of the root pane of the dialog to be shown. JavaHelp will, in turn, ignore the appearance of any dialog whose root pane posesses the client property "javahelp.ignore.modality" with the String value "true". |
Group of dtd interfaces
| Interface Name | In/Out | Stability | Specified in What Document? |
|---|---|---|---|
| ObjectTag | Exported | Friend | overview-summary.html |
Implementation Details
Read more about the implementation in the answers to architecture questions.
JavaHelp Integration