com.ontimize.help

Class HelpUtilities

java.lang.Object

com.ontimize.help.HelpUtilities

public class HelpUtilities
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HelpUtilities.ExtDefaultHelpBroker
static class	HelpUtilities.ModifiedHelpContentViewerUI
static class	HelpUtilities.ModifiedHelpUI
static class	HelpUtilities.ModifiedTOCNavigatorUI

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADVANCED_SEARCH_HELP
static String	ADVANCED_SEARCH_HELP_FILE
static boolean	DEBUG
static String	default_Ontimize_help_hs Complete path to .hs file.
protected static JDialog	dialog
protected static JEditorPane	editorPane
protected static Object	hb
protected static Object	hbAp
static String	HELP_FILE_ERROR_MESSAGE
protected static Object	hs
protected static Object	hsAp
protected static Locale	lastLocale
protected static JScrollPane	scroll
static boolean	show_Ontimize_Help It indicates whether default ontimize help files are included in help dialog.

Method Summary

Methods

Modifier and Type	Method and Description
static javax.help.HelpSet	getDefaultHelpSet()
static Window	getLoadingWindow(Window parent)
protected static URL	getURL(String fileName, Locale l)
static boolean	isHelpEnabled()
static void	recheck()
static void	setHelpIdString(Component c, String helpId)
static void	setMainHelpSet(String helpset)
static void	showDefaultAdvancedHelpDialog(Window parent, String title, Locale l)
protected static void	showDefaultHelp_(Window parent)
static void	showDefaultHelp(Window parent)
static void	showDefaultHelp(Window parent, String target)
static void	showDefaultHelpFromFocus(ActionEvent e)
static void	showDefaultHelpOnItem(ActionEvent e)
protected static void	showHelp_(Window parent)
static void	showHelp(Window parent)
static void	showHelp(Window parent, String target)
static void	showHelpDialog(Window parent, URL urlPage, String title) Shows a modal dialog with the specified help file (html)
static void	showHelpOnItem(ActionEvent e)
static void	showHelpOnItem(Window parentWindow, ActionEvent e)

Methods inherited from class java.lang.Object

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

Field Detail

default_Ontimize_help_hs

public static String default_Ontimize_help_hs

Complete path to .hs file. By default, "com/ontimize/help/OntimizeHelp.hs".

DEBUG

public static boolean DEBUG

show_Ontimize_Help

public static boolean show_Ontimize_Help

It indicates whether default ontimize help files are included in help dialog. By default, it is true.

HELP_FILE_ERROR_MESSAGE

public static String HELP_FILE_ERROR_MESSAGE

ADVANCED_SEARCH_HELP

public static String ADVANCED_SEARCH_HELP

ADVANCED_SEARCH_HELP_FILE

public static String ADVANCED_SEARCH_HELP_FILE

editorPane

protected static JEditorPane editorPane

dialog

protected static JDialog dialog

scroll

protected static JScrollPane scroll

hs

protected static Object hs

hsAp

protected static Object hsAp

hb

protected static Object hb

hbAp

protected static Object hbAp

lastLocale

protected static Locale lastLocale

Method Detail

recheck

public static void recheck()

showDefaultHelp

public static void showDefaultHelp(Window parent)

showDefaultHelp_

protected static void showDefaultHelp_(Window parent)

showDefaultHelp

public static void showDefaultHelp(Window parent,
                   String target)

showHelpDialog

public static void showHelpDialog(Window parent,
                  URL urlPage,
                  String title)
                           throws Exception

Shows a modal dialog with the specified help file (html)

Parameters:

parent -

urlPage -

title -

Throws:

Exception

showDefaultHelpFromFocus

public static void showDefaultHelpFromFocus(ActionEvent e)

showDefaultHelpOnItem

public static void showDefaultHelpOnItem(ActionEvent e)

showDefaultAdvancedHelpDialog

public static void showDefaultAdvancedHelpDialog(Window parent,
                                 String title,
                                 Locale l)
                                          throws Exception

Throws:

Exception

getURL

protected static URL getURL(String fileName,
         Locale l)

setHelpIdString

public static void setHelpIdString(Component c,
                   String helpId)

getLoadingWindow

public static Window getLoadingWindow(Window parent)

getDefaultHelpSet

public static javax.help.HelpSet getDefaultHelpSet()

isHelpEnabled

public static boolean isHelpEnabled()

setMainHelpSet

public static void setMainHelpSet(String helpset)

showHelp

public static void showHelp(Window parent,
            String target)

showHelp

public static void showHelp(Window parent)

showHelp_

protected static void showHelp_(Window parent)

showHelpOnItem

public static void showHelpOnItem(Window parentWindow,
                  ActionEvent e)

showHelpOnItem

public static void showHelpOnItem(ActionEvent e)