org.apache.myfaces.trinidadinternal.el
Class OracleHelpProvider

java.lang.Object
  extended by org.apache.myfaces.trinidadinternal.el.HelpProvider
      extended by org.apache.myfaces.trinidadinternal.el.SecondaryWindowHelpProvider
          extended by org.apache.myfaces.trinidadinternal.el.OracleHelpProvider

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.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/el/OracleHelpProvider.java#0 $) $Date: 10-nov-2005.19:06:18 $
Author:
The Oracle ADF Faces Team

Field Summary
 
Fields inherited from class org.apache.myfaces.trinidadinternal.el.SecondaryWindowHelpProvider
DEFAULT_WINDOW_HEIGHT, DEFAULT_WINDOW_WIDTH
 
Fields inherited from class org.apache.myfaces.trinidadinternal.el.HelpProvider
FRONT_PAGE_KEY
 
Constructor Summary
OracleHelpProvider(java.lang.String ohwServletLocation)
           
 
Method Summary
protected  java.lang.String getHelpSystemURL(java.lang.Object key)
          The getHelpSystemURL() method should return a string URL for the given key string (HelpProvider key constant)
protected  java.lang.String getHelpTopicURL(java.lang.Object key)
          The getHelpTopicURL() method should return a string URL for the given key 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 org.apache.myfaces.trinidadinternal.el.SecondaryWindowHelpProvider
getHelpSystemValue, getHelpTopicValue, getWindowHeight, getWindowWidth, isJavascriptSupported, setWindowHeight, setWindowWidth
 
Methods inherited from class org.apache.myfaces.trinidadinternal.el.HelpProvider
getHelpSystemMap, getHelpTopicMap
 
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

protected java.lang.String getHelpTopicURL(java.lang.Object key)
The getHelpTopicURL() method should return a string URL for the given key string (topic-id)

Specified by:
getHelpTopicURL in class SecondaryWindowHelpProvider
Parameters:
key - criterion (topic-id)

getHelpSystemURL

protected java.lang.String getHelpSystemURL(java.lang.Object key)
The getHelpSystemURL() method should return a string URL for the given key string (HelpProvider key constant)

Specified by:
getHelpSystemURL in class SecondaryWindowHelpProvider
Parameters:
key - criterion (HelpProvider key constant)


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.