de.must.wuic

Interface ContextHelp

All Known Implementing Classes:

AbstractDataListFrame, AbstractDataListInlay, ActionFrame, ActionInlay, ArraySelectDialog, AttributeList, BackupDialog, BackupOnlyDialog, BatchThreadControllerFrame, CharsetChooser, ClosableTabbedPane, ColumnDataListDialog, ColumnDataListFrame, ColumnDataListFrameForInlay, ColumnDataListInlay, ContainerTabbedPane, CSVColumnChooser, DataCheckBox, DataClassificationAdministration, DataComboBox, DataDateField, DataDecimalField, DataFileStreamField, DataFloatField, DataImageViewerForDB, DataImageViewerForFile, DataIntField, DataListSelectionFrame, DataLongField, DataMultChoice, DataPasswordField, DataPresentation, DataPresentationForInlay, DataPresentationInlay, DataPropertyAdministration, DataPropertyAdministrationInlay, DataSelectDialog, DataStructureOutlineFrame, DataTableAdministration, DataTextArea, DataTextField, DataVariableChoice, DataVariableChoiceNumKey, DataYearField, DBWaitDialog, DiDltD, DiPrTxD, DiSaveCancelReturnD, DlDbExtensionAfterBackupStd, ExportStartDialog, ExportStartDialogWithColumnChoosing, FileStreamField, FileStreamTextField, FilterTextField, FloatingPointField, FontNameChooser, FrDtaAcc, FrDtaProp, FrSbBackupFromAnonymousMdbFile, FrSbBackupFromAnyDB, FrSqlExc, FunctionSelectDialog, HalfDataComboBox, ImageViewer, ImportStartDialog, InfoDialog, InfoLinkTextField, InfoLinkTextField2, InfoTextArea, InterruptableThread, ISeriesSignon, ListSelectionFrame, LocalParameterDialog, LoginPanel, LookAndFeelChooser, MenuFrame, MustCheckBox, MustComboBox, MustComboBox2, MustContainer, MustDateField, MustDecimalField, MustDialog, MustFrame, MustFrameWithStatusLabel, MustIntField, MustLongField, MustMultChoice, MustPasswordField, MustTabbedPane, MustTextArea, MustTextField, MustTimeField, PageViewer, ParamCharsetChooser, ParamCheckBox, ParamChoice, ParamDecimalField, ParameterDialog, ParameterDialogWithStorage, ParameterDialogWithTable, ParameterEditDialog, ParameterForPrintingDialog, ParameterFrame, ParamFloatingPointField, ParamFontChoice, ParamFontNameChooser, ParamHalfDataComboBox, ParamIntField, ParamLookAndFeelChooser, ParamPasswordField, ParamPrinterChooser, ParamTextArea, ParamTextField, ParamTrayChooser, PartialRemoveDialog, PasswordChangeDialog, PointNumberField, Presentation, PresentationInlay, PreviewFrame, PrinterChooser, PropertyAdministration, PropertyAdministrationInlay, PublishableContainer, RemAttributeList, RemCheckBox, RemClosableTabbedPane, RemComboBox, RemDateField, RemDecimalField, RemFileStreamField, RemImageViewer, RemIntField, RemListSelectionFrame, RemPasswordField, RemPresentationInlayByDrawing, RemPrinterChooser, RemSelectDialog, RemServerProcessControllerFrame, RemStructureOutlineFrame, RemTextArea, RemTextField, ReplaceInColumnFrame, ReportParameterDialog, ReportParameterDialogNew, RestoreDialog, SearchListDetailInlay, SegmentedDataDateField, SelectDialog, SimpleDataListFrame, SimpleDataListFrameForInlay, SimpleDataListInlay, SimpleDataSelectDialog, SimpleDataSelectDialogFew, StructureOutlineFrame, TableAdministration, TrayChooser, TreeFrame, UserPasswordDialog, VariableChoice, VariableChoiceNumKey, WaitForFrame

public interface ContextHelp

Interface to control components' context help. May be used for calling a specific help by pressing F1. Actually the topic corresponds to a HTML page, the target corresponds to a target inside the page.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHelpTarget()
java.lang.String	getHelpTopic()
void	setHelpContext(java.lang.String helpTopic, java.lang.String helpTarget) Sets the component's context help.

Method Detail

setHelpContext

void setHelpContext(java.lang.String helpTopic,
                    java.lang.String helpTarget)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

getHelpTopic

java.lang.String getHelpTopic()

Returns:

the topic of the component's help context

getHelpTarget

java.lang.String getHelpTarget()

Returns:

the target of the component's help context