Package javax.help
Class CSH
java.lang.Object
javax.help.CSH
A convenience class that provides simple
access to context-senstive help functionality. It creates a default JavaHelp
viewer as well as ActionListeners for "Help" keys, on-item help, and
help buttons.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
An ActionListener that displays help on a selected object after tracking context-sensitive events.static class
An ActionListener that displays the help of the object that currently has focus.static class
An ActionListener that gets the helpID for the action source and displays the helpID in the help viewer.static interface
CSH Manager Interface to support dynamicHelpSet
andID
for object. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addManager
(int i, CSH.Manager m) Registers the specified manager to maintain dynamic CSH at the specified position in list of managers.static void
Registers the specified manager to maintain dynamic CSH.static String
getHelpIDString
(Component comp) Returns the static helpID for a component.static String
getHelpIDString
(MenuItem comp) Returns the static helpID for a MenuItem.static String
getHelpIDString
(Object comp, AWTEvent evt) Returns the dynamic HelpID for a object.static HelpSet
getHelpSet
(Component comp) Returns the static HelpSet for a Component.static HelpSet
getHelpSet
(MenuItem comp) Returns the static HelpSet for a MenuItem.static HelpSet
getHelpSet
(Object comp, AWTEvent evt) Returns the dynamic HelpSet for an object.static CSH.Manager
getManager
(int i) Returns the manager at the specified position in manager list.static int
Returns the number of managers registered to maintain dynamic CSH.static CSH.Manager[]
Returns array of managers registered to maintain dynamic CSH.static void
Removes all managers from manager list.static void
removeManager
(int i) Removes the manager at the specified position in manager list.static boolean
Removes the first occurrence of the specified manager in manager list.static void
setHelpIDString
(Component comp, String helpID) Sets the helpID for a Component.static void
setHelpIDString
(MenuItem comp, String helpID) Sets the helpID for a MenuItem.static void
setHelpSet
(Component comp, HelpSet hs) Sets the static HelpSet for a Component.static void
setHelpSet
(MenuItem comp, HelpSet hs) Sets the static HelpSet for a MenuItem.static Object
Context Sensitive Event Tracking Creates a new EventDispatchThread from which to dispatch events.
-
Constructor Details
-
CSH
public CSH()
-
-
Method Details
-
addManager
Registers the specified manager to maintain dynamic CSH.- Parameters:
m
- the CSH manager- Since:
- 2.0
-
addManager
Registers the specified manager to maintain dynamic CSH at the specified position in list of managers.- Parameters:
i
- index at which specified manager is to be inserted.m
- the CSH manager- Throws:
ArrayIndexOutOfBoundsException
- index out of range (i < 0 || i >= CSH.getManagerCount()).- Since:
- 2.0
-
removeManager
Removes the first occurrence of the specified manager in manager list.- Parameters:
m
- manager to be removed from the list, if present.- Returns:
true
if the list contained the specified manager.- Since:
- 2.0
-
removeManager
public static void removeManager(int i) Removes the manager at the specified position in manager list.- Parameters:
i
- the index of the manager to removed.- Throws:
ArrayIndexOutOfBoundsException
- index out of range (i < 0 || i >= CHS.getManagerCount()).- Since:
- 2.0
-
removeAllManagers
public static void removeAllManagers()Removes all managers from manager list.- Since:
- 2.0
-
getManager
Returns the manager at the specified position in manager list.- Parameters:
i
- index of manager to return.- Throws:
ArrayIndexOutOfBoundsException
- index is out of range (i < 0 || i >= CSH.getManagerCount()).- Since:
- 2.0
-
getManagers
Returns array of managers registered to maintain dynamic CSH.- Returns:
- an array containing the managers.
- Throws:
ArrayStoreException
- the runtime type of a manager is not aCSH.Manager
- Since:
- 2.0
-
getManagerCount
public static int getManagerCount()Returns the number of managers registered to maintain dynamic CSH.- Returns:
- the number of managers.
- Since:
- 2.0
-
setHelpIDString
Sets the helpID for a Component. If helpID is null this method removes the helpID from the component.- Throws:
IllegalArgumentException
- comp is neitherComponent
nor
-
setHelpIDString
Sets the helpID for a MenuItem. If helpID is null, this method removes the helpID from the component.- Throws:
IllegalArgumentException
- comp is neitherComponent
nor
-
getHelpIDString
Returns the dynamic HelpID for a object. The method passes the arguments into all registered CSH manageres to obtain dynamic HelpID. If no manager provides HelpID for the object, the static HelpID is returned or traverse to the component's ancestors for help.- Throws:
IllegalArgumentException
- comp is neitherComponent
norMenuItem
.- Since:
- 2.0
-
getHelpIDString
Returns the static helpID for a component. If the component doesn't have associated help, traverse the component's ancestors for help.This method calls
CSH.getHelpIDString(comp, null)
.- See Also:
-
getHelpIDString
Returns the static helpID for a MenuItem. If the component doesn't have associated help, traverse the component's ancestors for help.This method calls
CSH.getHelpIDString(comp, null)
.- See Also:
-
setHelpSet
Sets the static HelpSet for a Component. If HelpSet is null, this method removes the HelpSet from the component. -
setHelpSet
Sets the static HelpSet for a MenuItem. If HelpSet is null, this method removes the HelpSet from the component. -
getHelpSet
Returns the dynamic HelpSet for an object. HelpSets are stored in conjunction with helpIDs. It is possible for a object to have a helpID without a HelpSet, but a object cannot have a HelpSet without a helpID. If the component doesn't have an associated helpID, traverse the component's ancestors for a helpID. If the componet has a helpID but doesn't have a HelpSet, return null.- Throws:
IllegalArgumentException
- comp is neitherComponent
norMenuItem
.- See Also:
-
getHelpID
-
getHelpSet
Returns the static HelpSet for a Component. HelpSets are stored in conjunction with helpIDs. It is possible for a Component to have a helpID without a HelpSet, but a Component cannot have a HelpSet without a helpID. If the component doesn't have an associated helpID, traverse the component's ancestors for a helpID. If the componet has a helpID but doesn't have a HelpSet, return null.This method calls
CSH.getHelpSet(comp, null)
.- Throws:
IllegalArgumentException
- comp is notComponent</code
- See Also:
-
getHelpID
-
getHelpSet
Returns the static HelpSet for a MenuItem. HelpSets are stored in conjunction with helpIDs. It is possible for a MenuItem to have a helpID without a HelpSet, but a MenuItem cannot have a HelpSet without a helpID. If the component doesn't have an associated helpID, traverse the component's ancestors for a helpID. If the componet has a helpID, but doesn't have a HelpSet return null. This method callsCSH.getHelpIDString(comp, null)
.- Throws:
IllegalArgumentException
- comp is notMenuItem
- See Also:
-
getHelpID
-
trackCSEvents
Context Sensitive Event Tracking Creates a new EventDispatchThread from which to dispatch events. This method returns when stopModal is invoked.- Returns:
- Object The object on which the event occurred. Null if cancelled on an undetermined object.
-