oracle.cabo.ui.data.help
Class OracleHelpProvider

java.lang.Object
  |
  +--oracle.cabo.ui.data.help.HelpProvider
        |
        +--oracle.cabo.ui.data.help.SecondaryWindowHelpProvider
              |
              +--oracle.cabo.ui.data.help.OracleHelpProvider

All Implemented Interfaces:

DataProvider

public class OracleHelpProvider

extends SecondaryWindowHelpProvider

OracleHelpProvider is a HelpProvider implementation for Oracle Help for the Web. Oracle Help for the Web (OHW) is a full-featured, context-sensitive help system for web applications implemented as a Java servlet using the UIX Framework. Users of this class provide the location of their OHW Servlet instance (populated with the help for their application). The OracleHelpProvider implementation of getHelpTopicURL() returns a URL to the OHW instance with parameters requesting the appropriate topic-id. Similarly, the OracleHelpProvider implementation of getHelpSystemURL() returns a URL to the OHW instance with a parameter requesting that OHW return the appropriate help system page for the given HelpProvider key constant. Users may optionally register additional OHW Servlet instances for specific locales. See the registerLocaleSpecificServlet method for details. For more information on using a HelpProvider see the HelpProvider abstract class.

See Also:

Fields inherited from class oracle.cabo.ui.data.help.SecondaryWindowHelpProvider

DEFAULT_WINDOW_HEIGHT, DEFAULT_WINDOW_WIDTH

Fields inherited from class oracle.cabo.ui.data.help.HelpProvider

FRONT_PAGE_KEY, HELP_SYSTEM_NAME, HELP_TOPICS_NAME

Constructor Summary

OracleHelpProvider(java.lang.String ohwServletLocation)

Method Summary

java.lang.String	getHelpSystemURL(RenderingContext context, java.lang.Object select) The getHelpSystemURL() method should return a string URL for the given select string (HelpProvider key constant)
java.lang.String	getHelpTopicURL(RenderingContext context, java.lang.Object select) The getHelpTopicURL() method should return a string URL for the given select string (topic-id)
void	registerLocaleSpecificServlet(java.util.Locale locale, java.lang.String localeSpecificServletLocation) Register a different OHW servlet instance for a given locale.

Methods inherited from class oracle.cabo.ui.data.help.SecondaryWindowHelpProvider

getWindowHeight, getWindowWidth, selectHelpSystemValue, selectHelpTopicsValue, setWindowHeight, setWindowWidth

Methods inherited from class oracle.cabo.ui.data.help.HelpProvider

cleanup, getDataObject, init

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleHelpProvider

public OracleHelpProvider(java.lang.String ohwServletLocation)

Method Detail

registerLocaleSpecificServlet

public void registerLocaleSpecificServlet(java.util.Locale locale,
                                          java.lang.String localeSpecificServletLocation)

Register a different OHW servlet instance for a given locale. When a request comes in from the end user's browser with a specific locale, the OracleHelpProvider will attempt to find a HelpProvider registered for that Locale. If a match for language, country, and variant cannot be found, it checks if a Locale has been registered with matching language and country. If a language and country match cannot be found,it checks if a Locale has been registred for just the language. If no match can be found, it uses the default OHW servlet instance registered upon creation to handle the request.

Parameters:

locale - the Locale for which this OHW instance should be used

localeSpecificServletLocation - the location of the ohw servlet

getHelpTopicURL

public java.lang.String getHelpTopicURL(RenderingContext context,
                                        java.lang.Object select)

The getHelpTopicURL() method should return a string URL for the given select string (topic-id)

Overrides:

getHelpTopicURL in class SecondaryWindowHelpProvider

Parameters:

context - the current rendering context

select - criterion (topic-id)

getHelpSystemURL

public java.lang.String getHelpSystemURL(RenderingContext context,
                                         java.lang.Object select)

The getHelpSystemURL() method should return a string URL for the given select string (HelpProvider key constant)

Overrides:

getHelpSystemURL in class SecondaryWindowHelpProvider

Parameters:

context - the current rendering context

select - criterion (HelpProvider key constant)