Package javax.help
Class DefaultHelpBroker
java.lang.Object
javax.help.DefaultHelpBroker
- All Implemented Interfaces:
KeyListener
,EventListener
,HelpBroker
An implmentation of the HelpBroker interface
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionZero-argument constructor.Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
enableHelp
(Component comp, String id, HelpSet hs) Enables help for a Component.void
enableHelp
(MenuItem comp, String id, HelpSet hs) Enables help for a MenuItem.void
enableHelpKey
(Component comp, String id, HelpSet hs) Enables the Help key on a Component.void
Enables the Help key on a Component.void
enableHelpOnButton
(Component comp, String id, HelpSet hs) Enables help for a Component.void
enableHelpOnButton
(MenuItem comp, String id, HelpSet hs) Enables help for a MenuItem.void
Enables help for a Component.Determines which ID is displayed (if any).Determines which URL is displayed.Determines the current navigator.protected ActionListener
Returns the default DisplayHelpFromFocus listener.protected ActionListener
Returns the default DisplayHelpFromSource listener.getFont()
Gets the font for this HelpBroker.Returns the default HelpSetGets the locale of this component.Requests the location of the presentation.int
Requests the screen of the presentation.getSize()
Requests the size of the presentation.Get the WindowPresentation for this HelpBrokervoid
Initializes the presentation.boolean
Determines if the presentation is displayed.boolean
Determines if the current view is visible.void
Invoked when a key is pressed.void
Invoked when a key is released.void
Invoked when a key is typed.void
setActivationObject
(Object comp) Set the activation window from given Component or MenuItem.void
setActivationWindow
(Window window) Set the activation window.void
setCurrentID
(String id) Shows this ID as content relative to the (top) HelpSet for the HelpBroker instance--HelpVisitListeners are notified.void
setCurrentID
(Map.ID id) Displays this ID--HelpVisitListeners are notified.void
setCurrentURL
(URL url) Displays this URL.void
setCurrentView
(String name) Set the currentView to the navigator with the same name as the name parameter.void
setDisplayed
(boolean b) Displays the presentation to the user.void
Sets the font for this this HelpBroker.void
setHelpSet
(HelpSet hs) Changes the HelpSet for this broker.void
Set the presentation attributes from a HelpSet.Presentation.void
Sets the locale of this HelpBroker.void
setLocation
(Point p) Requests the presentation be located at a given position.void
setScreen
(int screen) Requests the presentation be set to a given screen.void
Requests the presentation be set to a given size.void
setViewDisplayed
(boolean displayed) Hides/Shows view.void
Shows this ID.void
Show this ID.
-
Field Details
-
displayHelpFromFocus
-
displayHelpFromSource
-
-
Constructor Details
-
DefaultHelpBroker
Constructor -
DefaultHelpBroker
public DefaultHelpBroker()Zero-argument constructor. It should be followed by a setHelpSet() invocation.
-
-
Method Details
-
getWindowPresentation
Get the WindowPresentation for this HelpBroker -
getHelpSet
Returns the default HelpSet- Specified by:
getHelpSet
in interfaceHelpBroker
- Returns:
- The HelpSet this JavaHelp is presenting.
-
setHelpSet
Changes the HelpSet for this broker.- Specified by:
setHelpSet
in interfaceHelpBroker
- Parameters:
hs
- The HelpSet to set for this broker. A null hs is valid parameter.
-
setHelpSetPresentation
Set the presentation attributes from a HelpSet.Presentation. The HelpSet.Presentation must be in the current HelpSet.- Specified by:
setHelpSetPresentation
in interfaceHelpBroker
- Parameters:
hsPres
- The HelpSet.Presentation- Since:
- 2.0
-
getLocale
Gets the locale of this component.- Specified by:
getLocale
in interfaceHelpBroker
- Returns:
- This component's locale. If this component does not have a locale, the defaultLocale is returned.
- See Also:
-
setLocale
Sets the locale of this HelpBroker. The locale is propagated to the presentation.- Specified by:
setLocale
in interfaceHelpBroker
- Parameters:
l
- The locale to become this component's locale. A null locale is the same as the defaultLocale.- See Also:
-
getFont
Gets the font for this HelpBroker.- Specified by:
getFont
in interfaceHelpBroker
-
setFont
Sets the font for this this HelpBroker.- Specified by:
setFont
in interfaceHelpBroker
- Parameters:
f
- The font.
-
setCurrentView
Set the currentView to the navigator with the same name as the name parameter.- Specified by:
setCurrentView
in interfaceHelpBroker
- Parameters:
name
- The name of the navigator to set as the current view. If nav is null or not a valid Navigator in this HelpBroker then an IllegalArgumentException is thrown.- Throws:
IllegalArgumentException
- if nav is null or not a valid Navigator.
-
getCurrentView
Determines the current navigator.- Specified by:
getCurrentView
in interfaceHelpBroker
- Returns:
- The name of the current navigational view.
-
initPresentation
public void initPresentation()Initializes the presentation. This method allows the presentation to be initialized but not displayed. Typically this would be done in a separate thread to reduce the intialization time.- Specified by:
initPresentation
in interfaceHelpBroker
-
setDisplayed
public void setDisplayed(boolean b) Displays the presentation to the user.- Specified by:
setDisplayed
in interfaceHelpBroker
- Parameters:
b
- Makes the presentation visible or not.
-
isDisplayed
public boolean isDisplayed()Determines if the presentation is displayed.- Specified by:
isDisplayed
in interfaceHelpBroker
- Returns:
- Whether the presentation is currently visible.
-
setLocation
Requests the presentation be located at a given position.- Specified by:
setLocation
in interfaceHelpBroker
-
getLocation
Requests the location of the presentation.- Specified by:
getLocation
in interfaceHelpBroker
-
setSize
Requests the presentation be set to a given size.- Specified by:
setSize
in interfaceHelpBroker
-
getSize
Requests the size of the presentation.- Specified by:
getSize
in interfaceHelpBroker
- Throws:
UnsupportedOperationException
-
setScreen
public void setScreen(int screen) Requests the presentation be set to a given screen.- Specified by:
setScreen
in interfaceHelpBroker
-
getScreen
Requests the screen of the presentation.- Specified by:
getScreen
in interfaceHelpBroker
- Throws:
UnsupportedOperationException
-
setViewDisplayed
public void setViewDisplayed(boolean displayed) Hides/Shows view.- Specified by:
setViewDisplayed
in interfaceHelpBroker
- Parameters:
displayed
- Make the navigational views visible or not.
-
isViewDisplayed
public boolean isViewDisplayed()Determines if the current view is visible.- Specified by:
isViewDisplayed
in interfaceHelpBroker
- Returns:
- Whether the navigational views are visible.
-
showID
Shows this ID.- Specified by:
showID
in interfaceHelpBroker
- Parameters:
id
- A string that identifies the topic to show for the loaded (top) HelpSetpresentation
- The Presentation class to display the Help in.presentationName
- The name of a Presentation section from a HelpSet to use. For some Presentations this will also be the name to apply to the Presentation.- Throws:
BadIDException
- The ID is not valid for the HelpSetIllegalArgumentException
- if presentation is not valid- See Also:
-
showID
public void showID(Map.ID id, String presentation, String presentationName) throws InvalidHelpSetContextException Show this ID.- Specified by:
showID
in interfaceHelpBroker
- Parameters:
id
- a Map.ID indicating the URL to displaypresentation
- The Presentation class to display the Help in.presentationName
- The name of a Presentation section from a HelpSet to use. For some Presentations this will also be the name to apply to the Presentation.- Throws:
InvalidHelpSetContextException
- if the current helpset does not contain id.helpset- See Also:
-
setCurrentID
Shows this ID as content relative to the (top) HelpSet for the HelpBroker instance--HelpVisitListeners are notified.- Specified by:
setCurrentID
in interfaceHelpBroker
- Parameters:
id
- A string that identifies the topic to show for the loaded (top) HelpSet- Throws:
BadIDException
- The ID is not valid for the HelpSet
-
setCurrentID
Displays this ID--HelpVisitListeners are notified.- Specified by:
setCurrentID
in interfaceHelpBroker
- Parameters:
id
- a Map.ID indicating the URL to display- Throws:
InvalidHelpSetContextException
- if the current helpset does not contain id.helpset- See Also:
-
getCurrentID
Determines which ID is displayed (if any).- Specified by:
getCurrentID
in interfaceHelpBroker
- Returns:
- The ID being shown.
-
setCurrentURL
Displays this URL. HelpVisitListeners are notified. The currentID changes if there is a mathing ID for this URL- Specified by:
setCurrentURL
in interfaceHelpBroker
- Parameters:
url
- The url to display. A null URL is a valid url.
-
getCurrentURL
Determines which URL is displayed.- Specified by:
getCurrentURL
in interfaceHelpBroker
- Returns:
- The URL being shown.
-
enableHelpKey
Enables the Help key on a Component. This method works best when the component is the rootPane of a JFrame in Swing implementations, or a java.awt.Window (or subclass thereof) in AWT implementations. This method sets the default helpID and HelpSet for the Component and registers keyboard actions to trap the "Help" keypress. When the "Help" key is pressed, if the object with the current focus has a helpID, the helpID is displayed. otherwise the default helpID is displayed.- Specified by:
enableHelpKey
in interfaceHelpBroker
- Parameters:
comp
- the Component to enable the keyboard actions on.id
- the default HelpID to be displayedhs
- the default HelpSet to be displayed. If hs is null the default HelpSet will be assumed.- See Also:
-
enableHelpKey
public void enableHelpKey(Component comp, String id, HelpSet hs, String presentation, String presentationName) Enables the Help key on a Component. This method works best when the component is the rootPane of a JFrame in Swing implementations, or a java.awt.Window (or subclass thereof) in AWT implementations. This method sets the default helpID and HelpSet for the Component and registers keyboard actions to trap the "Help" keypress. When the "Help" key is pressed, if the object with the current focus has a helpID, the helpID is displayed. otherwise the default helpID is displayed.- Specified by:
enableHelpKey
in interfaceHelpBroker
- Parameters:
comp
- the Component to enable the keyboard actions on.id
- the default HelpID to be displayedhs
- the default HelpSet to be displayed. If hs is null the default HelpSet from the HelpBroker is assummed. null is not valid if presenation is not null.presentation
- The Presentation class to display the content in. If presentation is null the HelpBroker is used to display the content.presentationName
- The name of a Presentation section to control the display of the content. Also for some Presenations this will be used to "name" the Presentation.- Throws:
IllegalArgumentException
- if presentation != null and hs == null- See Also:
-
keyTyped
Invoked when a key is typed. This event occurs when a key press is followed by a key release. Not intended to be overridden or extended.- Specified by:
keyTyped
in interfaceKeyListener
-
keyPressed
Invoked when a key is pressed. Not intended to be overridden or extended.- Specified by:
keyPressed
in interfaceKeyListener
-
keyReleased
Invoked when a key is released. Not intended to be overridden or extended.- Specified by:
keyReleased
in interfaceKeyListener
-
enableHelp
Enables help for a Component. This method sets a component's helpID and HelpSet.- Specified by:
enableHelp
in interfaceHelpBroker
- Parameters:
comp
- the Component to set the id and hs on.id
- the String value of an Map.ID.hs
- the HelpSet the id is in. If hs is null the default HelpSet will be assumed.- See Also:
-
enableHelp
Enables help for a MenuItem. This method sets a component's helpID and HelpSet.- Specified by:
enableHelp
in interfaceHelpBroker
- Parameters:
comp
- the MenuItem to set the id and hs on.id
- the String value of an Map.ID.hs
- the HelpSet the id is in. If hs is null the default HelpSet will be assumed.- See Also:
-
enableHelpOnButton
Enables help for a Component. This method sets a Component's helpID and HelpSet and adds an ActionListener. When an action is performed it displays the Component's helpID and HelpSet in the default viewer.- Specified by:
enableHelpOnButton
in interfaceHelpBroker
- Parameters:
comp
- the Component to set the id and hs on. If the Component is not a javax.swing.AbstractButton or a java.awt.Button an IllegalArgumentException is thrown.id
- the String value of an Map.ID.hs
- the HelpSet the id is in. If hs is null the default HelpSet will be assumed.- Throws:
IllegalArgumentException
- if comp is null.- See Also:
-
enableHelpOnButton
Enables help for a MenuItem. This method sets a Component's helpID and HelpSet and adds an ActionListener. When an action is performed it displays the Component's helpID and HelpSet in the default viewer.- Specified by:
enableHelpOnButton
in interfaceHelpBroker
- Parameters:
comp
- the MenuItem to set the id and hs on. If comp is null an IllegalAgrumentException is thrown.id
- the String value of an Map.ID.hs
- the HelpSet the id is in. If hs is null the default HelpSet will be assumed.- Throws:
IllegalArgumentException
- if comp is null.- See Also:
-
enableHelpOnButton
public void enableHelpOnButton(Object obj, String id, HelpSet hs, String presentation, String presentationName) Enables help for a Component. This method sets a Component's helpID and HelpSet and adds an ActionListener. When an action is performed it displays the Component's helpID and HelpSet in the default viewer.- Specified by:
enableHelpOnButton
in interfaceHelpBroker
- Parameters:
id
- the String value of an Map.ID.hs
- the HelpSet the id is in. If hs is null the default HelpSet will be assumed.presentation
- The Presentation class to display the Help in.presentationName
- The name of a Presentation section from a HelpSet to use. For some Presentations this will also be the name to apply to the Presentation.comp
- the Component to set the id and hs on. If the Component is not a javax.swing.AbstractButton or a java.awt.Button an IllegalArgumentException is thrown.- Throws:
IllegalArgumentException
- if comp is null.- See Also:
-
getDisplayHelpFromFocus
Returns the default DisplayHelpFromFocus listener.- See Also:
-
getDisplayHelpFromSource
Returns the default DisplayHelpFromSource listener.- See Also:
-
setActivationObject
Set the activation window from given Component or MenuItem. It find Window component in the component tree from given Component or MenuItem end callsetActivationWindow
.- Since:
- 1.1
- See Also:
-
setActivationWindow
Set the activation window. If the window is an instance of a Dialog and the is modal, modallyActivated help is set to true and ownerDialog is set to the window. In all other instances modallyActivated is set to false and ownerDialog is set to null.- Parameters:
window
- the activating window- Since:
- 1.1
-