Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.editor
Class SQLHelpHandler

java.lang.Object
  extended by com.ibm.etools.systems.editor.SystemTextEditorHelpHandler
      extended by com.ibm.etools.iseries.editor.SQLHelpHandler

public class SQLHelpHandler
extends SystemTextEditorHelpHandler

This class extends SystemTextEditorHelpHandler to add support for pressing help on SQL error messages.

Since:
7.1

Field Summary
 
Fields inherited from class com.ibm.etools.systems.editor.SystemTextEditorHelpHandler
_helpMessageTokenResourceBundle, _helpTokenResourceBundle, _parser, _strEmpty, _strHelpDocPluginID, _strHelpMessageDocPluginID, _strHelpMessageTokenTableFileName, _strHelpMessageTokenTablePluginID, _strHelpTokenTableFileName, _strHelpTokenTablePluginID, Copyright
 
Constructor Summary
SQLHelpHandler(String strHelpTokenTablePluginID, String strHelpTokenTableFileName, String strHelpDocPluginID, String strHelpMessageTokenTablePluginID, String strHelpMessageTokenTableFileName, String strHelpMessageDocPluginID, LpexCommonParser parser)
          The constructor for this class.
 
Method Summary
 String getHelpPage(LpexView view)
          Returns the help page identifier at the current cursor position.
 String getHelpPageFromMessageToken(String strToken)
          Called from Source Prompt view, or getHelpPage.
 
Methods inherited from class com.ibm.etools.systems.editor.SystemTextEditorHelpHandler
getHelpPageFromToken, getHelpPageIDFromToken, loadPluginPropertiesFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SQLHelpHandler

public SQLHelpHandler(String strHelpTokenTablePluginID,
                      String strHelpTokenTableFileName,
                      String strHelpDocPluginID,
                      String strHelpMessageTokenTablePluginID,
                      String strHelpMessageTokenTableFileName,
                      String strHelpMessageDocPluginID,
                      LpexCommonParser parser)
The constructor for this class.

See Also:
SystemTextEditorHelpHandler
Method Detail

getHelpPage

public String getHelpPage(LpexView view)
Description copied from class: SystemTextEditorHelpHandler
Returns the help page identifier at the current cursor position. The parser is called to obtain the current token.

Overrides:
getHelpPage in class SystemTextEditorHelpHandler

getHelpPageFromMessageToken

public String getHelpPageFromMessageToken(String strToken)
Description copied from class: SystemTextEditorHelpHandler
Called from Source Prompt view, or getHelpPage. The message help table is to have keys that are numbers only. Returns the help page identifier given a token or help resource identifier.

Overrides:
getHelpPageFromMessageToken in class SystemTextEditorHelpHandler

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.