oracle.dss.util.help
Interface HelpContext

All Known Subinterfaces:

StandardPanel

All Known Implementing Classes:

BIExceptionDialog, BIFontPane, CrosstabRulesPanel, DatePanel, DefaultStandardPanel, Explorer, FontPanel, FormatGeneralPanel, FormatsPanel, GraphLayout, GraphStylePanel, GraphType, GroupAxis, HeaderFormatGeneralPanel, Layout, Legend, NumberFormatPanel, OptionsPanel, PageSelectionPanel, PageSetupDialog, PageSetupHeaderFooterPanel, PersistenceObjectChooser, PlotArea, PreviewDialog, PrintDialog, StandardDialog, StylePanel, TableRulesPanel, Title, TitlePanel, ValueAxis

public interface HelpContext

Each object that wants to integrate with our Bali/Oracle Help for Java framework should provide a Help Context ID.

Method Summary

java.lang.String	getHelpContextID() Retrieves the Help context ID associated with the implementor of this interface.
void	setHelpContextID(java.lang.String strHelpContextID) Specifies the Help context ID associated with the implementor of this interface.

Method Detail

getHelpContextID

public java.lang.String getHelpContextID()

Retrieves the Help context ID associated with the implementor of this interface. This Help context ID is used to enable help systems to map a particular component to the proper help topic.

Returns:

String which represents the Help context ID.

setHelpContextID

public void setHelpContextID(java.lang.String strHelpContextID)

Specifies the Help context ID associated with the implementor of this interface. In most cases, the default Help context ID can be specified as the full class path for the implementor of this interface. This Help context ID is used to enable help systems to map a particular component to the proper help topic.

Parameters:

strHelpContextID - a String value that represents the Help context ID.