|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.trinidadinternal.el.HelpProvider
org.apache.myfaces.trinidadinternal.el.SecondaryWindowHelpProvider
org.apache.myfaces.trinidadinternal.el.OracleHelpProvider
public class OracleHelpProvider
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.
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 |
---|
public OracleHelpProvider(java.lang.String ohwServletLocation)
Method Detail |
---|
public void registerLocaleSpecificServlet(java.util.Locale locale, java.lang.String localeSpecificServletLocation)
locale
- the Locale for which this OHW instance should be usedlocaleSpecificServletLocation
- the location of the ohw servletprotected java.lang.String getHelpTopicURL(java.lang.Object key)
getHelpTopicURL
in class SecondaryWindowHelpProvider
key
- criterion (topic-id)protected java.lang.String getHelpSystemURL(java.lang.Object key)
getHelpSystemURL
in class SecondaryWindowHelpProvider
key
- criterion (HelpProvider key constant)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |