com.highqsoft.fwk.application.help

Class FwkHelpBroker

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusMember

com.highqsoft.fwk.FwkApplication

com.highqsoft.fwk.application.help.FwkHelpBroker

All Implemented Interfaces:

FwkApplicationInterface, FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkHelpBrokerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPrintableInterface, FwkPropertyChangeInterface, FwkThreadInterface, FwkTransferableInterface, FwkVetoableChangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.awt.event.KeyListener, java.awt.print.Pageable, java.awt.print.Printable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.lang.Runnable, java.util.EventListener, javax.help.HelpBroker, javax.infobus.DataItem, javax.infobus.InfoBusMember

public class FwkHelpBroker
extends FwkApplication
implements FwkHelpBrokerInterface, java.awt.event.KeyListener

An implmentation of the HelpBroker interface

The table of the used properties:

Property Keyword	Datatype	Default	Description
FwkHelpBroker.URL.HelpSet	String	com/highqsoft/help/ language /Help.hs	The name of the helpset URL.
Icon.FwkHelpBroker	String	com/highqsoft/fwk/images/FwkHelpBroker.gif	The icon of the help broker.

Since:

$Date: 2017/04/06 13:29:03 $

Version:

$Revision: 1.15 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static FwkDescriptionInterface	descriptor
protected java.awt.event.ActionListener	displayHelpFromFocus
protected java.awt.event.ActionListener	displayHelpFromSource
protected java.awt.Font	font the font.
protected FwkHelp	fwkHelp The help.
protected static javax.help.HelpSet	helpset The help set.
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkApplication

applicationThread, args, controller, eternal, executeStateListeners, pageFormat, panel, port, readingDOM, serviceControlManager, statusLabel, statusPanel

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, suspendChangeManager

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors

Constructor and Description
FwkHelpBroker() Constructor.
FwkHelpBroker(javax.help.HelpSet hs) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommand(FwkCommandInterface command) Add the command to the command array.
boolean	commandsAvailable() This method returns a boolean that indicates whether the command array is initialized.
void	createComponent() Create the component.
void	enableHelp(java.awt.Component comp, java.lang.String id, javax.help.HelpSet hs) Enables help for a Component.
void	enableHelp(java.awt.MenuItem comp, java.lang.String id, javax.help.HelpSet hs) Enables help for a MenuItem.
void	enableHelpKey(java.awt.Component comp, java.lang.String id, javax.help.HelpSet hs) Enables the Help key on a Component.
void	enableHelpOnButton(java.awt.Component comp, java.lang.String id, javax.help.HelpSet hs) Enables help for a Component.
void	enableHelpOnButton(java.awt.MenuItem comp, java.lang.String id, javax.help.HelpSet hs) Enables help for a MenuItem.
static javax.help.HelpSet	findHelpSet()
FwkCommandInterface	getCommand(java.lang.String commandName) Return the command that matches the given command name.
FwkCommandInterface[]	getCommands() Retrieve the command array of the component.
javax.help.Map.ID	getCurrentID() Determines which ID is displayed (if any).
java.net.URL	getCurrentURL() Determines which URL is displayed.
java.lang.String	getCurrentView() Determines the current navigator.
static FwkDescriptionInterface	getDescriptor()
protected java.awt.event.ActionListener	getDisplayHelpFromFocus() Returns the default DisplayHelpFromFocus listener.
protected java.awt.event.ActionListener	getDisplayHelpFromSource() Returns the default DisplayHelpFromSource listener.
java.awt.Font	getFont() Gets the font for this HelpBroker.
javax.help.HelpSet	getHelpSet() Returns the default HelpSet
java.util.Locale	getLocale() Gets the locale of this component.
java.awt.Point	getLocation()
FwkPanelInterface	getPanel() Get the panel of this application.
java.awt.Dimension	getSize() Get the size of the panel.
java.lang.String	getVersion() Return the version string of the FWK component.
void	initPresentation() Initializes the presentation.
boolean	isDisplayed() Determines if the presentation is displayed.
boolean	isViewDisplayed() Determines if the current view is visible.
void	keyPressed(java.awt.event.KeyEvent e) Invoked when a key is pressed.
void	keyReleased(java.awt.event.KeyEvent e) Invoked when a key is released.
void	keyTyped(java.awt.event.KeyEvent e) Invoked when a key is typed.
static void	main(java.lang.String[] args) The test program.
void	removeCommand(FwkCommandInterface command) Remove a sub-command.
void	run() Run the application.
void	setCommands(FwkCommandInterface[] commands) Set the sub-commands of the command.
void	setCurrentID(javax.help.Map.ID id) Displays this ID--HelpVisitListeners are notified.
void	setCurrentID(java.lang.String id) Shows this ID as content relative to the (top) HelpSet for the HelpBroker instance--HelpVisitListeners are notified.
void	setCurrentURL(java.net.URL url) Displays this URL.
void	setCurrentView(java.lang.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	setFont(java.awt.Font f) Sets the font for this this HelpBroker.
void	setHelpSet(javax.help.HelpSet hs) Changes the HelpSet for this broker.
void	setLocale(java.util.Locale l) Sets the locale of this HelpBroker.
void	setLocation(java.awt.Point p)
void	setSize(java.awt.Dimension size) Set the size of the panel.
void	setViewDisplayed(boolean displayed) Hides/Shows view.

Methods inherited from class com.highqsoft.fwk.FwkApplication

addExecuteStateListener, destroyController, exit, fireExecuteStateEvent, getController, getFwkPort, getNumberOfPages, getPageFormat, getPrintable, getPrintJobName, getPriority, getStatusPanel, hasFwkPort, init, isEternal, isInterrupted, isRegistered, print, readConstructor, readFromDOM, readingDOM, readingDOM, register, register, register, removeExecuteStateListener, setArguments, setController, setEternal, setPageFormat, setPanel, setPriority, setServiceControlManager, start, stop, unregister, writeConstructor, writeToDOM, writeToXML

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, finalize, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setInfoBusName, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, release, removeDataItemChangeListener, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, compareTo, deleteGroup, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkApplicationInterface

addExecuteStateListener, exit, fireExecuteStateEvent, getFwkPort, getStatusPanel, hasFwkPort, init, isEternal, isRegistered, register, register, register, removeExecuteStateListener, setArguments, setEternal, setPanel, setServiceControlManager, unregister

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusMemberInterface

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPrintableInterface

getPrintJobName, setPageFormat

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getCommands, getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addToGroup, addToGroup, clearCommands, deleteGroup, getGroup, groupExists, removeFromGroup

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface java.awt.print.Printable

print

Methods inherited from interface java.awt.print.Pageable

getNumberOfPages, getPageFormat, getPrintable

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkThreadInterface

getPriority, isInterrupted, setPriority, start, stop

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

descriptor

protected static final FwkDescriptionInterface descriptor

helpset

protected static javax.help.HelpSet helpset

The help set.

fwkHelp

protected FwkHelp fwkHelp

The help.

font

protected java.awt.Font font

the font.

displayHelpFromFocus

protected java.awt.event.ActionListener displayHelpFromFocus

displayHelpFromSource

protected java.awt.event.ActionListener displayHelpFromSource

Constructor Detail

FwkHelpBroker

public FwkHelpBroker()

Constructor. It searchs for the helpset specified in the property key URL.HelpSet. If the property wasn't found it load the language depend help set
com/highqsoft/help/[language]/Help.hs.

FwkHelpBroker

public FwkHelpBroker(javax.help.HelpSet hs)

Constructor

Parameters:

hs - The helpset.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkApplication

getDescriptor

public static FwkDescriptionInterface getDescriptor()

findHelpSet

public static javax.help.HelpSet findHelpSet()

run

public void run()

Run the application. This method is called by the Java Virtual Machine if a start() is requested. User components should never call this method.

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class FwkApplication

createComponent

public void createComponent()

Create the component.

Parameters:

hs - The help set belongs to that component.

getPanel

public FwkPanelInterface getPanel()

Get the panel of this application. Panels in the FWK environment are always JavaBeans.

Specified by:

getPanel in interface FwkApplicationInterface

Overrides:

getPanel in class FwkApplication

Returns:

The panel of the application.

getSize

public java.awt.Dimension getSize()

Get the size of the panel.

Specified by:

getSize in interface javax.help.HelpBroker

Returns:

The dimension of the panel.

setSize

public void setSize(java.awt.Dimension size)

Set the size of the panel.

Specified by:

setSize in interface javax.help.HelpBroker

Parameters:

The - dimension of the panel.

addCommand

public void addCommand(FwkCommandInterface command)

Add the command to the command array.

Specified by:

addCommand in interface FwkInstructionInterface

Overrides:

addCommand in class FwkPersistence

Parameters:

command - The command to be added.

getCommand

public FwkCommandInterface getCommand(java.lang.String commandName)

Return the command that matches the given command name.

Specified by:

getCommand in interface FwkInstructionInterface

Overrides:

getCommand in class FwkPersistence

Parameters:

commandName - The name of the requested command.

Returns:

The command or null if no matching command found.

commandsAvailable

public boolean commandsAvailable()

This method returns a boolean that indicates whether the command array is initialized.

Specified by:

commandsAvailable in interface FwkInstructionInterface

Overrides:

commandsAvailable in class FwkPersistence

Returns:

true if the command array is already initialized.

getCommands

public FwkCommandInterface[] getCommands()

Retrieve the command array of the component.

Specified by:

getCommands in interface FwkInstructionInterface

Overrides:

getCommands in class FwkPersistence

Returns:

The array containing the commands.

removeCommand

public void removeCommand(FwkCommandInterface command)

Remove a sub-command. This method fires a property change event on the property RemoveCommand. The new value object of the event is this the old value object is the removed sub-command.

Specified by:

removeCommand in interface FwkInstructionInterface

Overrides:

removeCommand in class FwkPersistence

Parameters:

command - The sub-command to be removed.

setCommands

public void setCommands(FwkCommandInterface[] commands)

Set the sub-commands of the command. All existing sub-commands will be removed.

Specified by:

setCommands in interface FwkInstructionInterface

Overrides:

setCommands in class FwkPersistence

Parameters:

commands - The array containing the sub-commands.

See Also:

FwkInstructionInterface.addCommand(FwkCommandInterface command)

getHelpSet

public javax.help.HelpSet getHelpSet()

Returns the default HelpSet

Specified by:

getHelpSet in interface javax.help.HelpBroker

setHelpSet

public void setHelpSet(javax.help.HelpSet hs)

Changes the HelpSet for this broker.

Specified by:

setHelpSet in interface javax.help.HelpBroker

Parameters:

hs - The HelpSet to set for this broker. A null hs is valid parameter.

getLocale

public java.util.Locale getLocale()

Gets the locale of this component.

Specified by:

getLocale in interface javax.help.HelpBroker

Returns:

This component's locale. If this component does not have a locale, the defaultLocale is returned.

See Also:

setLocale(java.util.Locale)

setLocale

public void setLocale(java.util.Locale l)

Sets the locale of this HelpBroker. The locale is propagated to the presentation.

Specified by:

setLocale in interface javax.help.HelpBroker

Parameters:

l - The locale to become this component's locale. A null locale is the same as the defaultLocale.

See Also:

getLocale()

getFont

public java.awt.Font getFont()

Gets the font for this HelpBroker.

Specified by:

getFont in interface javax.help.HelpBroker

Returns:

the current font.

setFont

public void setFont(java.awt.Font f)

Sets the font for this this HelpBroker.

Specified by:

setFont in interface javax.help.HelpBroker

Parameters:

f - The font.

setCurrentView

public void setCurrentView(java.lang.String name)

Set the currentView to the navigator with the same name as the name parameter.

Specified by:

setCurrentView in interface javax.help.HelpBroker

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:

java.lang.IllegalArgumentException - if nav is null or not a valid Navigator.

getCurrentView

public java.lang.String getCurrentView()

Determines the current navigator.

Specified by:

getCurrentView in interface javax.help.HelpBroker

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 interface javax.help.HelpBroker

setDisplayed

public void setDisplayed(boolean b)

Displays the presentation to the user.

Specified by:

setDisplayed in interface javax.help.HelpBroker

isDisplayed

public boolean isDisplayed()

Determines if the presentation is displayed.

Specified by:

isDisplayed in interface javax.help.HelpBroker

setViewDisplayed

public void setViewDisplayed(boolean displayed)

Hides/Shows view.

Specified by:

setViewDisplayed in interface javax.help.HelpBroker

isViewDisplayed

public boolean isViewDisplayed()

Determines if the current view is visible.

Specified by:

isViewDisplayed in interface javax.help.HelpBroker

setCurrentID

public void setCurrentID(java.lang.String id)
                  throws javax.help.BadIDException

Shows this ID as content relative to the (top) HelpSet for the HelpBroker instance--HelpVisitListeners are notified.

Specified by:

setCurrentID in interface javax.help.HelpBroker

Parameters:

id - A string that identifies the topic to show for the loaded (top) HelpSet

Throws:

javax.help.BadIDException - The ID is not valid for the HelpSet

setCurrentID

public void setCurrentID(javax.help.Map.ID id)
                  throws javax.help.InvalidHelpSetContextException

Displays this ID--HelpVisitListeners are notified.

Specified by:

setCurrentID in interface javax.help.HelpBroker

Parameters:

id - a Map.ID indicating the URL to display

Throws:

javax.help.InvalidHelpSetContextException - if the current helpset does not contain id.helpset

getCurrentID

public javax.help.Map.ID getCurrentID()

Determines which ID is displayed (if any).

Specified by:

getCurrentID in interface javax.help.HelpBroker

setCurrentURL

public void setCurrentURL(java.net.URL url)

Displays this URL. HelpVisitListeners are notified. The currentID changes if there is a mathing ID for this URL

Specified by:

setCurrentURL in interface javax.help.HelpBroker

Parameters:

url - The url to display. A null URL is a valid url.

getCurrentURL

public java.net.URL getCurrentURL()

Determines which URL is displayed.

Specified by:

getCurrentURL in interface javax.help.HelpBroker

enableHelpKey

public void enableHelpKey(java.awt.Component comp,
                 java.lang.String id,
                 javax.help.HelpSet hs)

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 interface javax.help.HelpBroker

Parameters:

comp - the Component to enable the keyboard actions on.

id - the default HelpID to be displayed

hs - the default HelpSet to be displayed. If hs is null the default HelpSet will be assumed.

See Also:

getHelpKeyActionListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

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 interface java.awt.event.KeyListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Invoked when a key is pressed. Not intended to be overridden or extended.

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Invoked when a key is released. Not intended to be overridden or extended.

Specified by:

keyReleased in interface java.awt.event.KeyListener

enableHelp

public void enableHelp(java.awt.Component comp,
              java.lang.String id,
              javax.help.HelpSet hs)

Enables help for a Component. This method sets a component's helpID and HelpSet.

Specified by:

enableHelp in interface javax.help.HelpBroker

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:

CSH.setHelpID, CSH.setHelpSet

enableHelp

public void enableHelp(java.awt.MenuItem comp,
              java.lang.String id,
              javax.help.HelpSet hs)

Enables help for a MenuItem. This method sets a component's helpID and HelpSet.

Specified by:

enableHelp in interface javax.help.HelpBroker

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:

CSH.setHelpID, CSH.setHelpSet

enableHelpOnButton

public void enableHelpOnButton(java.awt.Component comp,
                      java.lang.String id,
                      javax.help.HelpSet hs)

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 interface javax.help.HelpBroker

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:

java.lang.IllegalArgumentException - if comp is null.

See Also:

CSH.setHelpID, CSH.setHelpSet, AbstractButton, Button

enableHelpOnButton

public void enableHelpOnButton(java.awt.MenuItem comp,
                      java.lang.String id,
                      javax.help.HelpSet hs)

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 interface javax.help.HelpBroker

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:

java.lang.IllegalArgumentException - if comp is null.

See Also:

CSH.setHelpID, CSH.setHelpSet, MenuItem

getDisplayHelpFromFocus

protected java.awt.event.ActionListener getDisplayHelpFromFocus()

Returns the default DisplayHelpFromFocus listener.

See Also:

enableHelpKey

getDisplayHelpFromSource

protected java.awt.event.ActionListener getDisplayHelpFromSource()

Returns the default DisplayHelpFromSource listener.

See Also:

enableHelp

getLocation

public java.awt.Point getLocation()
                           throws java.lang.UnsupportedOperationException

Specified by:

getLocation in interface javax.help.HelpBroker

Throws:

java.lang.UnsupportedOperationException

setLocation

public void setLocation(java.awt.Point p)
                 throws java.lang.UnsupportedOperationException

Specified by:

setLocation in interface javax.help.HelpBroker

Throws:

java.lang.UnsupportedOperationException

main

public static void main(java.lang.String[] args)

The test program.