guk.editIM
Class HelpEditIM

java.lang.Object
  |
  +--guk.editIM.HelpEditIM

public class HelpEditIM

extends java.lang.Object

Help and about window functions for the Input Method Editor.

Field Summary

(package private) javax.swing.JFrame	aboutDialog
(package private) javax.swing.JFrame	helpDialog The help window (accessed both for opening and closing it) ...
(package private) MenuHelpers	menu A MenuHelpers object, containing listener and centering settings.

Constructor Summary

HelpEditIM(MenuHelpers menuHelper)
You have to hand over a MenuHelpers instance to the constructor.

Method Summary

void	aboutWindow(boolean openAbout) Just shows the about window and some generic system properties.
void	helpWindow(boolean openHelp) Just shows the help window.

Methods inherited from class java.lang.Object

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

Field Detail

helpDialog

javax.swing.JFrame helpDialog

The help window (accessed both for opening and closing it) ... and the about window (same idea).

aboutDialog

javax.swing.JFrame aboutDialog

menu

MenuHelpers menu

A MenuHelpers object, containing listener and centering settings.

Constructor Detail

HelpEditIM

public HelpEditIM(MenuHelpers menuHelper)

You have to hand over a MenuHelpers instance to the constructor.

Parameters:

menuHelper - A MenuHelpers instance, used to create buttons and center windows. Should have the listener set up correctly.

Method Detail

aboutWindow

public void aboutWindow(boolean openAbout)

Just shows the about window and some generic system properties. Shows a typical about window and some system properties like Java version of JRE and compiler, operating system and working directory. The user can leave the window open while continuing to work with other parts of the Input Method Editor. The window is an HTML windows and following hyperlinks is possible.

Parameters:

openAbout - Opens the window when true, otherwise closes it.

helpWindow

public void helpWindow(boolean openHelp)

Just shows the help window. The help window contains an HTML file and allows to browse it (for example follow hyperlinks). The file is the resource data/InputMethodEditorHelp.html. There is no BACK function so be careful which hyperlinks you follow. You can always return to the standard help file by closing and re-opening the window. The user can leave the window open while continuing to work with other parts of the Input Method Editor.

Parameters:

openHelp - Opens the window when true, otherwise closes it.