jrworkspace by
jTEM

de.jtem.jrworkspace.plugin.flavor
Interface HelpFlavor

All Known Implementing Classes:
ShrinkPanelPlugin

public interface HelpFlavor


Nested Class Summary
static interface HelpFlavor.HelpListener
          The HelpListener implements a method to show a help page
 
Method Summary
 String getHelpDocument()
          Returns the name of the HTML root help document
 Class<?> getHelpHandle()
          Returns the class which is the root of the help page file system.
 Icon getHelpIcon()
          Returns an help icon
 String getHelpPath()
          Returns a path to the help HTML file.
 String getHelpStyleSheet()
          Returns the name of the style sheet file to use for this help pages
 String getHelpTitle()
          Returns the title for these help pages
 void setHelpListener(HelpFlavor.HelpListener l)
          Sets the help listener which implements help functionality of the controller
 

Method Detail

getHelpDocument

String getHelpDocument()
Returns the name of the HTML root help document

Returns:
the name of the root document
See Also:
HelpFlavor#getHelpHandle()}

getHelpHandle

Class<?> getHelpHandle()
Returns the class which is the root of the help page file system. A help page name is then resolved like this:
String location = getHelpPath() + getHelpDocument()
InputStream in = getHelpHandle().getResourceAsStream(location)

Returns:
a class which is the root handle for these help pages

getHelpIcon

Icon getHelpIcon()
Returns an help icon

Returns:

getHelpPath

String getHelpPath()
Returns a path to the help HTML file.

Note: relative backward paths (..) don't seem to work with the Web Start ClassLoader!

Returns:
See Also:
HelpFlavor#getHelpHandle()}

getHelpStyleSheet

String getHelpStyleSheet()
Returns the name of the style sheet file to use for this help pages

Returns:
a file name or null

getHelpTitle

String getHelpTitle()
Returns the title for these help pages

Returns:

setHelpListener

void setHelpListener(HelpFlavor.HelpListener l)
Sets the help listener which implements help functionality of the controller

Parameters:
l - the listener

jrworkspace by
jTEM

jTEM