|
Oracle JEWT API Reference Release 4.2.24.0.0 B12199-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.bali.ewt.help.HelpUtils
The HelpUtils class provides ways for clients to set properties on an object to allow the HelpProvider.showHelp() call to work, and for certain help-knowledgeable objects to call help on their own.
Exactly what data should be set for each property depends on the particular help system in use; however, in general, the HelpID property will be a string identifying an individual topic, and the HelpSet property will be an object containing many topics (a JavaHelp HelpSet or an OHJ Book.) The HelpProvider property must be an object implementing the oracle.bali.ewt.help.HelpProvider interface.
Method Summary | |
static java.lang.String |
getDefaultHelpID()
Gets the current default Help ID. |
static HelpProvider |
getDefaultHelpProvider()
Gets the default HelpProvider. |
static java.lang.Object |
getDefaultHelpSet()
Gets the current default HelpSet. |
static java.lang.String |
getHelpID(java.awt.Component component)
Gets the current help ID for a given component. |
static HelpProvider |
getHelpProvider(java.awt.Component component)
Gets the current HelpProvider for a given component. |
static java.lang.Object |
getHelpSet(java.awt.Component component)
Gets the current HelpSet for a given component. |
static void |
setDefaultHelpID(java.lang.String id)
Sets the default HelpID. |
static void |
setDefaultHelpProvider(HelpProvider provider)
Sets the default HelpProvider for the application. |
static void |
setDefaultHelpSet(java.lang.Object helpset)
Sets the default HelpSet object. |
static void |
setHelpID(javax.swing.JComponent component,
java.lang.String id)
Sets a HelpID property on a component. |
static void |
setHelpProvider(javax.swing.JComponent component,
HelpProvider provider)
Sets a HelpProvider property on a component. |
static void |
setHelpSet(javax.swing.JComponent component,
java.lang.Object helpset)
Sets a HelpSet property on a component. |
static void |
showHelp(java.awt.Component component)
Shows help for the component. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static void showHelp(java.awt.Component component) throws HelpUnavailableException
component
- The component to find a HelpProvider forpublic static void setDefaultHelpProvider(HelpProvider provider)
provider
- The new default HelpProviderpublic static HelpProvider getDefaultHelpProvider()
public static void setDefaultHelpSet(java.lang.Object helpset)
The exact type of this object will depend on the help system in use.
helpset
- The new default HelpSetpublic static java.lang.Object getDefaultHelpSet()
public static void setDefaultHelpID(java.lang.String id)
id
- The new default Help ID.public static java.lang.String getDefaultHelpID()
public static void setHelpProvider(javax.swing.JComponent component, HelpProvider provider)
component
- The component to set the property on.provider
- The provider to set on the given component.public static void setHelpSet(javax.swing.JComponent component, java.lang.Object helpset)
component
- The component to set the property on.helpset
- The helpset to associate with the given component.public static void setHelpID(javax.swing.JComponent component, java.lang.String id)
component
- The component to set the property on.id
- The ID to associate with the given component.public static HelpProvider getHelpProvider(java.awt.Component component)
component
- The component to find a HelpProvider forpublic static java.lang.Object getHelpSet(java.awt.Component component)
component
- The component to find a HelpSet forpublic static java.lang.String getHelpID(java.awt.Component component)
component
- The component to find a help ID for
|
Oracle JEWT 4.2.24 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |