Package javax.help
Interface CSH.Manager
-
- Enclosing class:
- CSH
public static interface CSH.Manager
CSH Manager Interface to support dynamicHelpSet
andID
for object. CSH is allowed only forComponent
andMenuItem
.- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getHelpIDString(java.lang.Object comp, java.awt.AWTEvent e)
Returns String represent Map.ID of the object depending on the event.HelpSet
getHelpSet(java.lang.Object comp, java.awt.AWTEvent e)
Returns HelpSet of the object depending on the event.
-
-
-
Method Detail
-
getHelpSet
HelpSet getHelpSet(java.lang.Object comp, java.awt.AWTEvent e)
Returns HelpSet of the object depending on the event.- Parameters:
comp
- The object to getHelpSet
for it. OnlyComponent
andMenuItem
is allowed.e
- The event by which dynamic CSH was invoked. It can beMouseEvent
in case of window level CSH,ActionEvent
in case of field level CSH ornull
otherwise.- Returns:
- A HelpSet for given object or null if no HelpSet is assigned to object
- See Also:
CSH.DisplayHelpAfterTracking
,CSH.DisplayHelpFromFocus
,CSH.DisplayHelpFromSource
-
getHelpIDString
java.lang.String getHelpIDString(java.lang.Object comp, java.awt.AWTEvent e)
Returns String represent Map.ID of the object depending on the event.- Parameters:
comp
- The object to getMap.ID
for it. OnlyComponent
andMenuItem
is allowed.e
- The event by which dynamic CSH was invoked. It can beMouseEvent
in case of window level CSH,ActionEvent
in case of field level CSH ornull
otherwise.- Returns:
- A Map.ID string for given object or null if no Map.ID is assigned to object
- See Also:
CSH.DisplayHelpAfterTracking
,CSH.DisplayHelpFromFocus
,CSH.DisplayHelpFromSource
-
-