Skip navigation links

oracle.adf.view.rich.help
Class HelpTopic

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

public abstract class HelpTopic

extends java.lang.Object

A HelpTopic instance provides help corresponding to one helpTopicId attribue on a component. HelpTopic instances are returned from HelpProvider implementations.

Constructor Summary

HelpTopic()

Method Summary

abstract java.lang.String	getDefinition() Gets the help that should be shown to a new user, or an infrequent user.
abstract java.lang.String	getExternalUrl() Gets the URL to an external help page.
abstract java.lang.String	getInstructions() Gets the help that should be shown to all users.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpTopic

public HelpTopic()

Method Detail

getDefinition

public abstract java.lang.String getDefinition()

Gets the help that should be shown to a new user, or an infrequent user. This is usually a definition of a term. This text cannot have any HTML formatting. Because UI agents may show this text inside a tooltip it is recommended that this String be under 80 characters.

getInstructions

public abstract java.lang.String getInstructions()

Gets the help that should be shown to all users. This is usually instructions for a particular form field. This text can have simple HTML formatting that is supported by the outputFormatted tag.

getExternalUrl

public abstract java.lang.String getExternalUrl()

Gets the URL to an external help page. This is used to give the user extensive details about the current help-topic. This is usually a link to an external help framework, like OHW.

Skip navigation links