public class HelpFacade
extends java.lang.Object
Provides the facility to open the documentation at press of F1. The opened page is determined context-sensitive by the current focused component and parent components. Specify the URL via .
Modifier and Type | Field and Description |
---|---|
static KeyAction |
ACTION_OPEN_HELP |
static java.lang.String |
HELP_BASE_URL
The base url of the help system.
|
static java.lang.String |
KEY_HELP_URL
System property key for setting the base url of the help system.
|
Constructor and Description |
---|
HelpFacade() |
Modifier and Type | Method and Description |
---|---|
static KeyAction |
createHelpAction(java.lang.String path) |
static bibliothek.gui.dock.common.action.CAction |
createHelpButton(java.lang.String s)
Creates a
CButton , that can be add to dockables and opens the given
help pages at HELP_BASE_URL |
static void |
openHelp()
Opens the key documentation website in the default system browser.
|
static void |
openHelp(java.awt.Component path)
Tries to find the documentation of the given component and opens it.
|
static void |
openHelp(java.lang.String path)
Opens the specified sub page of the key
documentation website in the default system browser.
|
static boolean |
openHelpOfClass(java.lang.Class<?> clazz)
Opens documentation given for the given class.
|
public static final java.lang.String KEY_HELP_URL
public static final KeyAction ACTION_OPEN_HELP
OpenHelpAction
public static java.lang.String HELP_BASE_URL
KEY_HELP_URL
public static void openHelp()
public static void openHelp(java.lang.String path)
path
- a valid suffix to the current URIpublic static void openHelp(java.awt.Component path)
The documentation is determined by following the parents to the root and checking
for HelpInfo
on the classes.
path
- public static boolean openHelpOfClass(java.lang.Class<?> clazz)
The class needs to be annotated with HelpInfo
.
clazz
- non-null class instance.public static bibliothek.gui.dock.common.action.CAction createHelpButton(java.lang.String s)
CButton
, that can be add to dockables and opens the given
help pages at HELP_BASE_URL
s
- path to help pagepublic static KeyAction createHelpAction(java.lang.String path)
Copyright © 2003-2019 The KeY-Project.