org.graffiti.help
Class HelpContext

java.lang.Object
  extended by org.graffiti.help.HelpContext

public class HelpContext
extends Object

Represents the help context of an algorithm or a gui element in the editor.

Version:
$Revision: 5767 $
Author:
flierl

Constructor Summary
HelpContext(Class<?> clazz)
          Constructs a new help context from the given class.
HelpContext(String helpID)
          Constructs a new help context from the given helpID.
HelpContext(URL helpURL)
          Constructs a new help context from the given URL.
 
Method Summary
 HelpContext findHelp(JComponent comp)
          Returns a help context for the given gui component.
 String getHelpID()
          Returns the java help id of this help context.
 URL getHelpURL()
          Returns the url of this help context.
 String toString()
          Returns a human readable string of this help context.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HelpContext

public HelpContext(URL helpURL)
Constructs a new help context from the given URL.

Parameters:
helpURL - the URL to create a help context from.

HelpContext

public HelpContext(String helpID)
Constructs a new help context from the given helpID.

Parameters:
helpID - the javahelp help id.

HelpContext

public HelpContext(Class<?> clazz)
Constructs a new help context from the given class.

Parameters:
clazz - the class to construct a help context from.
Method Detail

getHelpID

public String getHelpID()
Returns the java help id of this help context.

Returns:
the java help id of thie help context.

getHelpURL

public URL getHelpURL()
Returns the url of this help context.

Returns:
the url of this help context.

findHelp

public HelpContext findHelp(JComponent comp)
Returns a help context for the given gui component.

Parameters:
comp - the component to search the help context for.
Returns:
DOCUMENT ME!

toString

public String toString()
Returns a human readable string of this help context. This method is for debugging purposes only.

Overrides:
toString in class Object
Returns:
a human readable string of this help context.


Generated at 2012-05-30 11:00:14 PM CEST