Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.flexstor.common.awt
Class Help  view Help download Help.java

java.lang.Object
  extended bycom.flexstor.common.awt.Help
All Implemented Interfaces:
HelpHandlerI

public class Help
extends java.lang.Object
implements HelpHandlerI

The class Help implements HelpHandlerI and provides one method named showHelp. showHelp creates a new browser window to display an HTML help file. Window identifiers are defined in FlexFrame.

Example call:


   static final int iWndId = WNDID_MAIN;  // constant defined in FlexFrame
   ...
   private HelpHandlerI helpHandler = new Help();
   ...
   void bHelp_Clicked(Event event)
   {
      // if applicable, check for focus here and set fieldId
      // correspondingly
      int iFldId = 0;   // field id zero for window level help
      helpHandler.showHelp(this.iWndId, iFldId);
   }
   

Version:
3.0

Field Summary
private static HelpFileMapper fileMapper
           
private static int HLP_DEFAULT_ID
           
static java.lang.String IDENTIFIER
           
 
Constructor Summary
Help()
           
 
Method Summary
 void showHelp(int iWndId, int iFldId)
          This method shows an HTML help file in a browser window.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER
See Also:
Constant Field Values

HLP_DEFAULT_ID

private static final int HLP_DEFAULT_ID
See Also:
Constant Field Values

fileMapper

private static HelpFileMapper fileMapper
Constructor Detail

Help

public Help()
Method Detail

showHelp

public void showHelp(int iWndId,
                     int iFldId)
This method shows an HTML help file in a browser window.

Specified by:
showHelp in interface HelpHandlerI