gui.help
Class JAPInternalHelpViewer

java.lang.Object
  extended by gui.dialog.JAPDialog
      extended by gui.help.JAPInternalHelpViewer
All Implemented Interfaces:
IDialogOptions, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class JAPInternalHelpViewer
extends JAPDialog

Help window for the JAP. This is a singleton meaning that there exists only one help window all the time. Each supported language is specified by the property languageCode[i], where [i] is the language index starting with '1'. To fully support a language, at least the file index_xx.html is needed, where xx is the two-letter language code given in the property. The number of supported languages is unlimited, as long as the indices are incremented by '1'. The help files are stored in one or more directories, specified by the message properties 'helpPath' and helpPath[i]. It is enough to specify the property 'helpPath', specific directories for each language are optional. (classes modified from Swing Example "Metalworks")

See Also:
LanguageMapper, JAPMessages

Nested Class Summary
private  class JAPInternalHelpViewer.HelpListener
           
private  class JAPInternalHelpViewer.HtmlPane
           
(package private)  class JAPInternalHelpViewer.JAPInternalHelpDelegator
          We need this delegator to allow JAPInternalHelpViwer to extend JAPDialog although it should inherit from JAPHelp.
 
Nested classes/interfaces inherited from class gui.dialog.JAPDialog
JAPDialog.AbstractLinkedURLAdapter, JAPDialog.ILinkedInformation, JAPDialog.LinkedCheckBox, JAPDialog.LinkedHelpContext, JAPDialog.LinkedInformation, JAPDialog.LinkedInformationAdapter, JAPDialog.LinkedURLCheckBox, JAPDialog.Options
 
Field Summary
private  javax.swing.JButton m_backButton
           
private  javax.swing.JButton m_closeButton
           
private  javax.swing.JComboBox m_comBoxLanguage
           
private  JAPInternalHelpViewer.JAPInternalHelpDelegator m_delegator
           
private  javax.swing.JButton m_forwardButton
           
private  java.lang.String m_helpPath
           
private  javax.swing.JButton m_homeButton
           
private  JAPInternalHelpViewer.HtmlPane m_htmlpaneTheHelpPane
           
private  boolean m_initializing
           
private  LanguageMapper m_language
           
 
Fields inherited from class gui.dialog.JAPDialog
FORMAT_DEFAULT_SCREEN, FORMAT_GOLDEN_RATIO_PHI, FORMAT_WIDE_SCREEN, MSG_BTN_PROCEED, MSG_BTN_RETRY, MSG_ERROR_UNDISPLAYABLE, MSG_ERROR_UNKNOWN, MSG_TITLE_CONFIRMATION, MSG_TITLE_ERROR, MSG_TITLE_INFO, MSG_TITLE_WARNING, XML_ATTR_OPTIMIZED_FORMAT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Fields inherited from interface gui.dialog.IDialogOptions
MESSAGE_TYPE_ERROR, MESSAGE_TYPE_INFORMATION, MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_QUESTION, MESSAGE_TYPE_WARNING, OPTION_TYPE_CANCEL, OPTION_TYPE_DEFAULT, OPTION_TYPE_EMPTY, OPTION_TYPE_OK_CANCEL, OPTION_TYPE_YES_NO, OPTION_TYPE_YES_NO_CANCEL, RETURN_VALUE_CANCEL, RETURN_VALUE_CLOSED, RETURN_VALUE_NO, RETURN_VALUE_OK, RETURN_VALUE_UNINITIALIZED, RETURN_VALUE_YES
 
Constructor Summary
JAPInternalHelpViewer(java.awt.Frame parent)
           
 
Method Summary
private  void backPressed()
           
private  void checkNavigationButtons()
          Checks whether to enable or disable the forward and back buttons
private  void closePressed()
           
private  void forwardPressed()
           
(package private)  JAPHelp getHelp()
           
private  void homePressed()
          Returns the context object
 void loadCurrentContext()
           
 void setVisible(boolean a_bVisible)
          Shows or hides the dialog.
 
Methods inherited from class gui.dialog.JAPDialog
addComponentListener, addWindowListener, dispose, doClosingOnContentPaneCancel, getAccessibleContext, getContentPane, getDefaultCloseOperation, getFont, getGlassPane, getInsets, getJMenuBar, getLayeredPane, getLocation, getName, getOptimizedFormat, getOptimizedFormatDelta, getOptimizedFormatDelta, getOptimizedFormatInternal, getOwner, getParentComponent, getPreferredSize, getRootPane, getScreenBounds, getSize, getTitle, imageUpdate, isClosingOnContentPaneCancel, isConsoleOnly, isDisposed, isEnabled, isModal, isResizable, isVisible, moveToUpRightCorner, pack, postEvent, remove, removeComponentListener, removeWindowListener, requestFocus, resetAutomaticLocation, restoreLocation, restoreSize, retrieveErrorMessage, setAlwaysOnTop, setConsoleOnly, setContentPane, setDefaultCloseOperation, setDockable, setEnabled, setGlassPane, setJMenuBar, setLayeredPane, setLocation, setLocation, setLocationCenteredOn, setLocationCenteredOnOwner, setLocationCenteredOnParent, setLocationCenteredOnScreen, setLocationRelativeToOwner, setModal, setName, setOptimizedFormat, setResizable, setSize, setSize, setTitle, setVisible, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showConfirmDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showErrorDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showMessageDialog, showWarningDialog, showWarningDialog, showWarningDialog, showWarningDialog, showWarningDialog, showWarningDialog, showWarningDialog, showWarningDialog, showYesNoDialog, showYesNoDialog, showYesNoDialog, showYesNoDialog, showYesNoDialog, showYesNoDialog, showYesNoDialog, showYesNoDialog, toBack, toFront, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_helpPath

private java.lang.String m_helpPath

m_language

private LanguageMapper m_language

m_comBoxLanguage

private javax.swing.JComboBox m_comBoxLanguage

m_htmlpaneTheHelpPane

private JAPInternalHelpViewer.HtmlPane m_htmlpaneTheHelpPane

m_closeButton

private javax.swing.JButton m_closeButton

m_backButton

private javax.swing.JButton m_backButton

m_forwardButton

private javax.swing.JButton m_forwardButton

m_homeButton

private javax.swing.JButton m_homeButton

m_initializing

private boolean m_initializing

m_delegator

private JAPInternalHelpViewer.JAPInternalHelpDelegator m_delegator
Constructor Detail

JAPInternalHelpViewer

JAPInternalHelpViewer(java.awt.Frame parent)
Method Detail

loadCurrentContext

public void loadCurrentContext()

setVisible

public void setVisible(boolean a_bVisible)
Description copied from class: JAPDialog
Shows or hides the dialog. If shown, the dialog is centered over the parent component. Subclasses may override this method to change this centering behaviour.

Overrides:
setVisible in class JAPDialog
Parameters:
a_bVisible - 'true' shows the dialog; 'false' hides it

homePressed

private void homePressed()
Returns the context object


closePressed

private void closePressed()

backPressed

private void backPressed()

forwardPressed

private void forwardPressed()

checkNavigationButtons

private void checkNavigationButtons()
Checks whether to enable or disable the forward and back buttons


getHelp

JAPHelp getHelp()