Package org.esa.snap.ui.help

Class HelpDisplayer

java.lang.Object

org.esa.snap.ui.help.HelpDisplayer

public class HelpDisplayer
extends Object

Helper class to invoke the help system.

Constructor Summary

Constructors

Constructor	Description
HelpDisplayer()

Method Summary

Modifier and Type	Method	Description
static void	show(String helpId)	Invoke the help system with the provided help ID.
static void	show(org.openide.util.HelpCtx helpCtx)	Invoke the help system with the provided help context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HelpDisplayer

public HelpDisplayer()

Method Details

show

public static void show(String helpId)

Invoke the help system with the provided help ID.

Parameters:

helpId - the help ID to be shown, if null the default help will be shown

show

public static void show(org.openide.util.HelpCtx helpCtx)

Invoke the help system with the provided help context.

Parameters:

helpCtx - the context to be shown, if null the default help will be shown