Interface HelpDescriptor

All Known Subinterfaces:

ComponentBasedDockingAction, DockingActionIf, ToggleDockingActionIf

All Known Implementing Classes:

AbstractFindReferencesDataTypeAction, AbstractFindReferencesToAddressAction, AbstractHelpAction, AbstractSelectionNavigationAction, AddAllFieldAction, AddFieldAction, AddSpacerFieldAction, BSimOverviewProvider, BSimSearchResultsProvider, ClearCutAction, ComponentProvider, ComponentProviderAdapter, ComponentThemeInspectorAction, ContextSpecificAction, DbViewerProvider, DeleteTableRowAction, DialogProjectDataCollapseAction, DialogProjectDataExpandAction, DialogProjectDataNewFolderAction, DisableFieldAction, DockingAction, DockingActionProxy, DockingDialog, DomainEventComponentProvider, DomainFileProviderContextAction, DomainFolderChangesDisplayComponentProvider, EnableFieldAction, EventDisplayComponentProvider, FindCheckoutsAction, FrontEndProjectDataCollapseAction, FrontEndProjectDataExpandAction, FrontEndProjectDataNewFolderAction, FrontendProjectTreeAction, FSBComponentProvider, GlobalFocusTraversalAction, HelpAction, HelpInfoAction, HorizontalRuleAction, InsertRowAction, ListingContextAction, ListingMergePanelProvider, MakeProgramSelectionAction, MemorySearchProvider, MultiActionDockingAction, MultiStateDockingAction, NavigatableComponentProviderAdapter, NavigatableContextAction, NextPreviousWindowAction, NextRangeAction, NonToolbarMultiStateAction, PreviousRangeAction, ProgramContextAction, ProgramLocationContextAction, ProgramSymbolContextAction, ProjectDataCollapseAction, ProjectDataContextToggleAction, ProjectDataCopyAction, ProjectDataCopyCutBaseAction, ProjectDataCutAction, ProjectDataDeleteAction, ProjectDataExpandAction, ProjectDataFollowLinkAction, ProjectDataNewFolderAction, ProjectDataOpenDefaultToolAction, ProjectDataOpenToolAction, ProjectDataPasteAction, ProjectDataPasteLinkAction, ProjectDataReadOnlyAction, ProjectDataRefreshAction, ProjectDataRenameAction, ProjectDataSelectAction, ProjectDataSelectRealFileOrFolderAction, ProjectRepoConnectAction, ProjectTreeAction, PropertyManagerProvider, QuickFixTableProvider, RemoveAllFieldsAction, RemoveFieldAction, RemoveRowAction, ResetAllFormatsAction, ResetFormatAction, ResetTranslationAction, SaveImageAction, SearchAndReplaceProvider, SelectionNavigationAction, SetKeyBindingAction, SetSpacerTextAction, SharedStubKeyBindingAction, ShowActionChooserDialogAction, ShowAllComponentsAction, ShowContextMenuAction, ShowFocusCycleAction, ShowFocusInfoAction, TextEditorComponentProvider, ToggleDockingAction, VersionControlAction, VersionControlAddAction, VersionControlCheckInAction, VersionControlCheckOutAction, VersionControlDataTypeArchiveUndoCheckoutAction, VersionControlShowHistoryAction, VersionControlUndoCheckOutAction, VersionControlUndoHijackAction, VersionControlUpdateAction, VersionControlViewCheckOutAction, ViewInstructionDetailsAction, VisualGraphComponentProvider, ZoomInAction, ZoomOutAction, ZoomResetAction

public interface HelpDescriptor

Method Summary

Modifier and Type	Method	Description
String	getHelpInfo()	Returns a descriptive String about the help object that this descriptor represents.
Object	getHelpObject()	Returns the object for which help locations are defined.

Method Details

getHelpObject

Object getHelpObject()

Returns the object for which help locations are defined. This may be the implementor of this interface or some other delegate object.

Returns:

the help object

getHelpInfo

String getHelpInfo()

Returns a descriptive String about the help object that this descriptor represents.

Returns:

the help info