|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openstreetmap.josm.gui.help.HelpUtil
public class HelpUtil
Constructor Summary | |
---|---|
HelpUtil()
|
Method Summary | |
---|---|
static java.lang.String |
buildAbsoluteHelpTopic(java.lang.String topic)
Replies the absolute, localized help topic for the given topic and the current locale. |
static java.lang.String |
buildAbsoluteHelpTopic(java.lang.String topic,
java.util.Locale locale)
Replies the absolute, localized help topic for the given topic. |
static java.lang.String |
extractAbsoluteHelpTopic(java.lang.String url)
Extracts the absolute help topic from an URL. |
static java.lang.String |
extractRelativeHelpTopic(java.lang.String url)
Extracts the relative help topic from an URL. |
static java.lang.String |
getContextSpecificHelpTopic(java.lang.Object context)
Replies the context specific help topic configured for context . |
private static javax.swing.Action |
getHelpAction()
Replies the global help action, if available. |
static java.lang.String |
getHelpTopicEditUrl(java.lang.String absoluteHelpTopic)
Replies the URL to the edit page for the absolute help topic. |
static java.lang.String |
getHelpTopicPrefix()
Replies the help topic prefix for the current locale. |
static java.lang.String |
getHelpTopicPrefix(java.util.Locale locale)
Replies the help topic prefix for the given locale. |
static java.lang.String |
getHelpTopicUrl(java.lang.String absoluteHelpTopic)
Replies the URL on the wiki for an absolute help topic. |
static java.lang.String |
getWikiBaseHelpUrl()
Replies the base wiki URL for help pages |
static java.lang.String |
getWikiBaseUrl()
Replies the base wiki URL. |
static java.lang.String |
ht(java.lang.String helpTopic)
This is a simple marker method for help topic literals. |
static void |
setHelpContext(javax.swing.JComponent component,
java.lang.String relativeHelpTopic)
Makes a component aware of context sensitive help. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HelpUtil()
Method Detail |
---|
public static java.lang.String getWikiBaseUrl()
public static java.lang.String getWikiBaseHelpUrl()
public static java.lang.String getHelpTopicUrl(java.lang.String absoluteHelpTopic)
absoluteHelpTopic
- the absolute help topic
buildAbsoluteHelpTopic(String)
,
buildAbsoluteHelpTopic(String, Locale)
public static java.lang.String getHelpTopicEditUrl(java.lang.String absoluteHelpTopic)
absoluteHelpTopic
- the absolute help topic
public static java.lang.String extractRelativeHelpTopic(java.lang.String url)
url
- the url
public static java.lang.String extractAbsoluteHelpTopic(java.lang.String url)
url
- the url
public static java.lang.String getHelpTopicPrefix()
getHelpTopicPrefix(Locale)
public static java.lang.String getHelpTopicPrefix(java.util.Locale locale)
locale
- the locale. Locale.ENGLISH
assumed, if null.
getHelpTopicPrefix(Locale)
public static java.lang.String buildAbsoluteHelpTopic(java.lang.String topic, java.util.Locale locale)
topic
- the relative help topic. Home help topic assumed, if null.locale
- the locale. Locale.ENGLISH
assumed, if null.
public static java.lang.String buildAbsoluteHelpTopic(java.lang.String topic)
topic
- the relative help topic. Home help topic assumed, if null.
Locale.getDefault()
,
buildAbsoluteHelpTopic(String, Locale)
public static java.lang.String getContextSpecificHelpTopic(java.lang.Object context)
context
.
private static javax.swing.Action getHelpAction()
HelpAction
.
public static void setHelpContext(javax.swing.JComponent component, java.lang.String relativeHelpTopic)
component
- the component the componenttopic
- the help topic. Set to the default help topic if null.public static java.lang.String ht(java.lang.String helpTopic)
String helpTopic = ht("/Dialog/RelationEditor"); or putValue("help", ht("/Dialog/RelationEditor"));
helpTopic
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |