com.jgoodies.uifextras.help
Class HelpBroker

java.lang.Object
  extended by com.jgoodies.uifextras.help.HelpBroker

public final class HelpBroker
extends Object

This singleton class provides access to a HelpViewer, which in turn uses a HelpSet.

Version:
$Revision: 1.8 $
Author:
Karsten Lentzsch

Method Summary
static HelpBroker getInstance()
          Returns the single HelpBroker instance; lazily creates an instance.
static boolean hasInstance()
          Returns whether this broker has already created an instance.
static void openDefault()
          Shows the default help page in the HelpViewer.
static void openURL(URL url)
          Shows the help page at the given URL in the HelpViewer.
static void setClassLoader(ClassLoader loader)
           
static void setHelpSetPath(URL path)
          Sets the path to the HelpSet, which will be used during the lazy initialization process, see #createInstance(URL).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setHelpSetPath

public static void setHelpSetPath(URL path)
Sets the path to the HelpSet, which will be used during the lazy initialization process, see #createInstance(URL).

Parameters:
path - the path to the HelpSet
Throws:
IllegalArgumentException - if the path is null

setClassLoader

public static void setClassLoader(ClassLoader loader)

openURL

public static void openURL(URL url)
Shows the help page at the given URL in the HelpViewer.

Parameters:
url - the URL of the help page to open

openDefault

public static void openDefault()
Shows the default help page in the HelpViewer.


hasInstance

public static boolean hasInstance()
Returns whether this broker has already created an instance.

Returns:
true if an instance has been created, false otherwise

getInstance

public static HelpBroker getInstance()
Returns the single HelpBroker instance; lazily creates an instance.

Returns:
the single HelpBroker instance


Copyright © 2000-2008 JGoodies Karsten Lentzsch. All Rights Reserved.