|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is the interface used for supporting Dynamic Help for a component. In Director, it is typical for a specific help panel to be associated with a component using a help context. However, there are some scenarios where the help for a component will vary at run-time. A good example of this is the help button on a properties page, where the help that is loaded should depend on which page is currently the top-most page of the properties panel.
TWGDynamicHelp provides the interface that components must implement in order to support dynamic help (i.e. help that changes based on conditions.) Director's help subsystem will load a help panel using two pieces of information, the help topics mapping file and the help topic id. If dynamic help is specified for a component and help is requested, that component will retrieve the help panel by first calling getHelpTopicsMapping(). It will then get the ID to use in that mapping file by calling getHelpTopicID().
com.tivoli.twg.guilibs.TWGHelpContext
Method Summary | |
---|---|
java.lang.String |
getHelpTopicID()
Components implement this interface to provide the name of the topic id to use when help is requested. |
java.lang.String |
getHelpTopicsMapping()
Components implement this interface to provide the name of a different mapping file to use to get the topic id from. |
Method Detail |
public java.lang.String getHelpTopicsMapping()
public java.lang.String getHelpTopicID()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |