Skip navigation links

oracle.adf.view.rich.help
Class HelpProvider

java.lang.Object
oracle.adf.view.rich.help.HelpProvider

Direct Known Subclasses:

ELHelpProvider, ResourceBundleHelpProvider

public abstract class HelpProvider

extends java.lang.Object

A HelpProvider instance provides the help for an application. It is configured in META-INF/adf-settings.xml.

There can be many HelpProviders per application; each one is registered against a unique prefix. A particular HelpProvider will only be called to produce help for help-topicIds that start with the prefix under which the HelpProvider was registered.

If the prefix attribute is missing, or is empty, then the HelpProvider will be registered as a special default HelpProvider. It will be used to produce help for help-topicIds that cannot be matched with any other HelpProvider. Only one default HelpProvider is permitted.

All prefixes under which HelpProviders are registered must be unique. At this time, it is also not permissible for one prefix to begin with the same characters of another prefix. For example, if HelpProviders have already been registered for the two prefixes - "AAB" and "AC", then the following prefixes are all illegal and will cause an exception to be thrown at registration time: "AABC", "A", "AA", "AC", "ACB". However, the following are legal: "AAD", "AB", etc ...

Any number of parameters may be passed into the HelpProvider instance at registration time. This is done similar to the way parameters are passed into managed-beans. Here is an example where a HelpProvider (with one parameter) is registered in adf-config.xml :

 <adf-settings xmlns="http://xmlns.oracle.com/adf/settings">
  <adf-faces-config xmlns="http://xmlns.oracle.com/adf/faces/settings">
   <help-provider prefix="MYAPP">
     <help-provider-class> oracle.adfdemo.view.webapp.MyHelpProvider </help-provider-class>
     <property>
       <property-name>myCustomProperty</property-name>
       <value>someValue</value>
     </property>
   </help-provider>
  </adf-faces-config> 
 </adf-settings>
 

In the above example, MyHelpProvider must extend this class and have a public constructor with no parameters. It must also have the following method:

 public void setMyCustomProperty(String arg)
 

In the above example, this method will be called with "someValue" as the arg.

Also note that MyHelpProvider will be called for all help-topicIds that start with "MYAPP".

Constructor Summary

HelpProvider()

Method Summary

abstract HelpTopic

getHelpTopic(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String topicId) Gets the HelpTopic for the given topicId.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpProvider

public HelpProvider()

Method Detail

getHelpTopic

public abstract HelpTopic getHelpTopic(javax.faces.context.FacesContext context,
                                       javax.faces.component.UIComponent component,
                                       java.lang.String topicId)

Gets the HelpTopic for the given topicId.

Parameters:

component - the component that this HelpTopic is for. This may be null. Help implementors may provide different help depending on the component state, eg: when the component is disabled.

Skip navigation links