de.guibuilder.framework
Interface HelpManagerIF

All Known Implementing Classes:
GuiSession, JavaHelpManager

public interface HelpManagerIF

Kapselt das HilfeSystem.

Eine Implementierung dieses Interfaces ist der GuiSession zu übergeben. GuiSession selbst implementiert dieses Interface und delegiert alle Aufrufe entsprechend weiter.

In GuiBuilderConfig.xml kann unter "HelpManager" der Name eine Klasse angegeben werden, die dieses Interface implementiert.
Diese Klasse wird dann von der GuiSession instanziiert.

Z.Z. gibt es nur eine Implementierung mit JavaHelp

Author:
peter
See Also:
GuiSession

Method Summary
 void enableContextHelp(GuiAction action)
          Die angegebene Action (Button oder MenuItem) soll die Feld-bezogene Context-Hilfe auslösen können.
 java.lang.String getHelpId(MemberAble member)
          Liefert das Help-Label der angegebenen Gui-Komponente
 void setHelpId(MemberAble member, java.lang.String helpId)
          Setzt das Help-Label zu der angegebenen Gui-Komponente
 void showHelp(MemberAble member)
          Zeigt die Hilfe zu der angegebenen Gui-Komponente an.
 void showHelp(java.lang.String helpId)
          Zeigt die Hilfe zu dem angegebenen Help-Label
 

Method Detail

setHelpId

void setHelpId(MemberAble member,
               java.lang.String helpId)
Setzt das Help-Label zu der angegebenen Gui-Komponente

Parameters:
member -
helpId -

getHelpId

java.lang.String getHelpId(MemberAble member)
Liefert das Help-Label der angegebenen Gui-Komponente

Parameters:
member -
Returns:

showHelp

void showHelp(MemberAble member)
Zeigt die Hilfe zu der angegebenen Gui-Komponente an.

Parameters:
member -

showHelp

void showHelp(java.lang.String helpId)
Zeigt die Hilfe zu dem angegebenen Help-Label

Parameters:
helpId -

enableContextHelp

void enableContextHelp(GuiAction action)
Die angegebene Action (Button oder MenuItem) soll die Feld-bezogene Context-Hilfe auslösen können.

Parameters:
action -