All Packages  Class Hierarchy

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Index of all Fields and Methods

A

actionListener. Variable in class jHelp.htmlHelpPanel
actionPerformed(ActionEvent). Method in class jHelp.htmlHelpFrame
actionPerformed(ActionEvent). Method in class jHelp.htmlHelpIndexPanel
actionPerformed(ActionEvent). Method in class jHelp.htmlHelpPanel
actionPerformed(ActionEvent). Method in class jHelp.htmlHelpQueryPanel
actionPerformed(ActionEvent). Method in class jHelp.htmlHelpSearchPanel
actionPerformed(ActionEvent). Method in class jHelp.tabs.TabPanel
add(String, Panel). Method in class jHelp.tabs.TabPanel
Adds a panel and tab to the tab-folder, with the provided caption.
addActionListener(ActionListener). Method in class jHelp.htmlHelpPanel
addFile(Object, String). Method in class jHelp.htmlHelpFrame
The addFile method permits loading additional help source files subsequent to construction.
addFile(Object, String). Method in class jHelp.htmlHelpPanel
The addFile method permits loading additional help source files subsequent to construction.
addHTMLString(Object, String, String). Method in class jHelp.htmlHelpFrame
The addHTMLString method permits loading dynamically generated HTML content.
addHTMLString(Object, String, String). Method in class jHelp.htmlHelpPanel
The addHTMLString method permits loading dynamically generated HTML content.
adjustmentValueChanged(AdjustmentEvent). Method in class jHelp.htmlHelpPanel

B

BACK. Static variable in class jHelp.htmlResources
BLDR_DLG_CANCEL. Static variable in class jHelp.htmlResources
BLDR_DLG_OK. Static variable in class jHelp.htmlResources
BLDR_DLG_TITLE. Static variable in class jHelp.htmlResources
BLDR_DONE. Static variable in class jHelp.htmlResources
BLDR_FIND_ERR. Static variable in class jHelp.htmlResources
BLDR_FOLLOWS. Static variable in class jHelp.htmlResources
BLDR_GEN_IDX. Static variable in class jHelp.htmlResources
BLDR_GEN_WORDS. Static variable in class jHelp.htmlResources
BLDR_NEST. Static variable in class jHelp.htmlResources
BLDR_PARSING. Static variable in class jHelp.htmlResources
BLDR_PRS_WRDS. Static variable in class jHelp.htmlResources
BLDR_READ_WORDS. Static variable in class jHelp.htmlResources
BLDR_READING. Static variable in class jHelp.htmlResources
BLDR_SORT_WORDS. Static variable in class jHelp.htmlResources
BLDR_SORTING. Static variable in class jHelp.htmlResources

C

CANCEL. Static variable in class jHelp.htmlResources
CLOSE. Static variable in class jHelp.htmlResources

D

DFLT_TITLE. Static variable in class jHelp.htmlResources
doWords(). Method in class jHelp.index.htmlHelpIndexBuilderProject
DYN_NAME. Static variable in class jHelp.htmlHelpPanel
DYN_PREFIX. Static variable in class jHelp.htmlHelpPanel
DYNAMIC. Static variable in class jHelp.htmlHelpPanel

E

enableStacks(Object, Object). Method in class jHelp.htmlHelpPanel
Normally, if forward/back navigation buttons are provided, they are specified in the constructor.
EXCLUDE. Static variable in class jHelp.htmlExcludeWords

F

FIND. Static variable in class jHelp.htmlResources
FIND_NEXT. Static variable in class jHelp.htmlResources
finish(). Method in class jHelp.index.Wizard
FORWARD. Static variable in class jHelp.htmlResources

G

getCachedFont(String, int, int). Method in class jHelp.htmlFontCache
getContents(). Method in class jHelp.htmlExcludeWords
getContents(). Method in class jHelp.htmlResources
getContents(). Method in class jHelp.index.IndexResources
getCurrentFileName(). Method in class jHelp.htmlHelpFrame
Returns the name of the current document.
getCurrentFileName(). Method in class jHelp.htmlHelpPanel
Returns the name of the current document.
getDocDir(). Method in class jHelp.index.htmlHelpIndexBuilderProject
getInsets(). Method in class jHelp.htmlHelpPanel
getLinkCommand(). Method in class jHelp.htmlLinkEvent
Gets the href attribute that was clicked to generate this event.
getMaxCache(). Method in class jHelp.htmlHelpFrame
This method returns the current number of documents that will be retained in memory.
getMaxCache(). Method in class jHelp.htmlHelpPanel
This method returns the current number of documents that will be retained in memory.
getPath(Class, String). Static method in class jHelp.htmlLocator
Return the path of the specified resource within the jar or zip, or if not in a jar, the absolute path to the resource in the user's file system.
getSources(). Method in class jHelp.index.htmlHelpIndexBuilderProject
getTarget(). Method in class jHelp.index.htmlHelpIndexBuilderProject
GETTING_TEXT. Static variable in class jHelp.htmlResources
getZip(Class, String). Static method in class jHelp.htmlLocator
Return the absolute file spec of the jar or zip associated with the classObject parameter and the name of any resource known to be contained within the jar.
goBack(). Method in class jHelp.htmlHelpPanel
This method causes the help panel to retrieve the previous document or location (after a hypertext jump) if any.
goForward(). Method in class jHelp.htmlHelpPanel
This method causes the help panel to retrieve the next document or location (after a hypertext jump) if any.
GOTO. Static variable in class jHelp.htmlResources
goTo(String). Method in class jHelp.htmlHelpPanel
This method permits setting the panel explicitly to a helpfile and optionally, a location within the help file.
goTo(String, int). Method in class jHelp.htmlHelpPanel
This method permits setting the panel explicitly to a helpfile and optionally, a location within the help file with an element index.

H

handleDefaultLink(htmlLinkEvent). Method in class jHelp.htmlHelpPanel
The default internal link handler

handleJhelpHideFrame(htmlHelpFrame). Method in interface jHelp.htmlJhelpListener
handleJhelpImageException(Exception). Method in interface jHelp.htmlJhelpListener
handleLink(htmlLinkEvent). Method in class jHelp.htmlHelpPanel
The internal link handler that may be overridden to provide customized link handling.
help(). Method in class jHelp.index.Wizard
htmlExcludeWords(). Constructor for class jHelp.htmlExcludeWords
htmlExcludeWords_en(). Constructor for class jHelp.htmlExcludeWords_en
htmlExcludeWords_en_US(). Constructor for class jHelp.htmlExcludeWords_en_US
htmlFontCache(). Constructor for class jHelp.htmlFontCache
htmlHelpFrame(Object, String). Constructor for class jHelp.htmlHelpFrame
This class provides a basic pop-up browser frame that contains Back, Forward and Search buttons, in addition to an htmlHelpPanel component.
htmlHelpFrame(Object, String, int). Constructor for class jHelp.htmlHelpFrame
This constructor permits specifying the width of the scrollbar component.
htmlHelpFrame(Object, String, int, int). Constructor for class jHelp.htmlHelpFrame
This constructor permits specifying an intial help frame size.
htmlHelpFrame(Object, String, int, int, int). Constructor for class jHelp.htmlHelpFrame
This constructor permits specifying a scrollbar width as well as the initial size of the pop-up frame.
htmlHelpFrame(Object, String, int, int, int, Locale). Constructor for class jHelp.htmlHelpFrame
This constructor permits specifying a scrollbar width as well as the initial size of the pop-up frame.
htmlHelpFrame(Object, String, int, int, Locale). Constructor for class jHelp.htmlHelpFrame
This constructor permits specifying an intial help frame size.
htmlHelpFrame(Object, String, int, Locale). Constructor for class jHelp.htmlHelpFrame
This constructor permits specifying the width of the scrollbar component.
htmlHelpFrame(Object, String, Locale). Constructor for class jHelp.htmlHelpFrame
This class provides a basic pop-up browser frame that contains Back, Forward and Search buttons, in addition to an htmlHelpPanel component.
htmlHelpIndexBuilder(). Constructor for class jHelp.htmlHelpIndexBuilder
htmlHelpIndexBuilder(htmlHelpIndexBuilderProject, TextArea). Constructor for class jHelp.htmlHelpIndexBuilder
This constructor is used by the Index Builder Wizard app.
htmlHelpIndexBuilderProject(). Constructor for class jHelp.index.htmlHelpIndexBuilderProject
htmlHelpIndexBuilderProject(String, String, String[], boolean, boolean, boolean). Constructor for class jHelp.index.htmlHelpIndexBuilderProject
htmlHelpIndexFrame(String, String, Object, Object). Constructor for class jHelp.htmlHelpIndexFrame
The most basic index frame constructor, does not provide a word list and uses the default Locale of the machine.
htmlHelpIndexFrame(String, String, Object, Object, Locale). Constructor for class jHelp.htmlHelpIndexFrame
This constructor does not provide a word list and uses the specified Locale.
htmlHelpIndexFrame(String, String, Object, Object, String). Constructor for class jHelp.htmlHelpIndexFrame
This constructor does not provide a word list, uses the default Locale, and specifies a zip or jar containing the index file.
htmlHelpIndexFrame(String, String, String, Object, Object). Constructor for class jHelp.htmlHelpIndexFrame
This constructor, provides both an index and a word list and uses the default Locale of the machine.
htmlHelpIndexFrame(String, String, String, Object, Object, Locale). Constructor for class jHelp.htmlHelpIndexFrame
This constructor, provides both an index and a word list and uses the specified Locale.
htmlHelpIndexFrame(String, String, String, Object, Object, String). Constructor for class jHelp.htmlHelpIndexFrame
This constructor provides both an index file and a word list, uses the default Locale, and specifies a zip or jar containing the index and word files.
htmlHelpIndexFrame(String, String, String, Object, Object, String, Locale). Constructor for class jHelp.htmlHelpIndexFrame
This constructor provides both an index file and a word list, uses the specified Locale, and specifies a zip or jar containing the index and word files.
htmlHelpIndexPanel(String, Object, Object). Constructor for class jHelp.htmlHelpIndexPanel
This constructor takes a filespec for the compiled index file, the applet or frame instance of the program deploying jHelp, and either an htmlHelpFrame or htmlHelpPanel object.
htmlHelpIndexPanel(String, Object, Object, Locale). Constructor for class jHelp.htmlHelpIndexPanel
This constructor takes a filespec for the compiled index file, the applet or frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, and a specific locale.
htmlHelpIndexPanel(String, Object, Object, String). Constructor for class jHelp.htmlHelpIndexPanel
This constructor takes a zip entry name for the compiled index file, the frame instance of the application deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, and the filespec of the zip or jar file that contains the index file as specified.
htmlHelpIndexPanel(String, Object, Object, String, Locale). Constructor for class jHelp.htmlHelpIndexPanel
This constructor takes a zip entry name for the compiled index file, the frame instance of the application deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, the filespec of the zip or jar file that contains the index file as specified, and a specific locale.
htmlHelpIndexPanel(String, Object, Object, String, ResourceBundle). Constructor for class jHelp.htmlHelpIndexPanel
This constructor takes a zip entry name for the compiled index file, the applet or frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel object, the filespec of the zip or jar file that contains the index file as specified, and a specific ResourceBundle

htmlHelpPanel(Object, String). Constructor for class jHelp.htmlHelpPanel
The basic htmlHelpPanel constructor is provided for use as a browser widget.
htmlHelpPanel(Object, String, int). Constructor for class jHelp.htmlHelpPanel
This constructor permits specifying the width of the scrollbar without passing navigation buttons.
htmlHelpPanel(Object, String, int, Locale). Constructor for class jHelp.htmlHelpPanel
This constructor permits specifying the width of the scrollbar without passing navigation buttons.
htmlHelpPanel(Object, String, Locale). Constructor for class jHelp.htmlHelpPanel
The basic htmlHelpPanel constructor is provided for use as a browser widget.
htmlHelpPanel(Object, String, Object, Object). Constructor for class jHelp.htmlHelpPanel
This htmlHelpPanel constructor is provided for developers to produce customized framed help browsers, basing their code on the htmlHelpFrame source code, if available.
htmlHelpPanel(Object, String, Object, Object, int). Constructor for class jHelp.htmlHelpPanel
This htmlHelpPanel constructor permits specifying the width of the vertical scrollbar along with back and forward buttons.
htmlHelpPanel(Object, String, Object, Object, int, Locale). Constructor for class jHelp.htmlHelpPanel
This htmlHelpPanel constructor permits specifying the width of the vertical scrollbar along with back and forward buttons.
htmlHelpPanel(Object, String, Object, Object, Locale). Constructor for class jHelp.htmlHelpPanel
This htmlHelpPanel constructor is provided for developers to produce customized framed help browsers, basing their code on the htmlHelpFrame source code, if available.
htmlHelpQueryPanel(htmlHelpSearchPanel, Object). Constructor for class jHelp.htmlHelpQueryPanel
Create a basic query panel, given a search panel (where the word list is found) and an associated jHelp.htmlHelpFrame or jHelp.htmlHelpPanel object.
htmlHelpQueryPanel(htmlHelpSearchPanel, Object, Locale). Constructor for class jHelp.htmlHelpQueryPanel
Create a basic query panel, given a search panel (where the word list is found) an associated htmlHelpFrame or htmlHelpPanel object, and a specific Locale object.
htmlHelpQueryPanel(htmlHelpSearchPanel, Object, ResourceBundle). Constructor for class jHelp.htmlHelpQueryPanel
Create a basic query panel, given a search panel (where the word list is found) an associated htmlHelpFrame or htmlHelpPanel object, and a jHelp.htmlResources object.
htmlHelpSearchPanel(String, Object, Object). Constructor for class jHelp.htmlHelpSearchPanel
This constructor creates a search panel, given the filespec of the compiled word list, the Applet or valid Frame instance of the program deploying jHelp, and an htmlHelpFrame or htmlHelpPanel associated with the word list.
htmlHelpSearchPanel(String, Object, Object, Locale). Constructor for class jHelp.htmlHelpSearchPanel
This constructor creates a search panel, given the filespec of the compiled word list, the Applet or valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a specific Locale object.
htmlHelpSearchPanel(String, Object, Object, String). Constructor for class jHelp.htmlHelpSearchPanel
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, and an htmlHelpFrame or htmlHelpPanel associated with the word list.
htmlHelpSearchPanel(String, Object, Object, String, Locale). Constructor for class jHelp.htmlHelpSearchPanel
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a specific locale object.
htmlHelpSearchPanel(String, Object, Object, String, ResourceBundle). Constructor for class jHelp.htmlHelpSearchPanel
This constructor creates a search panel, given the zip entry name of the compiled word list, the valid Frame instance of the program deploying jHelp, an htmlHelpFrame or htmlHelpPanel associated with the word list, and a jHelp.htmlResources ResourceBundle.
htmlLocator(). Constructor for class jHelp.htmlLocator
htmlResources(). Constructor for class jHelp.htmlResources
htmlResources_en(). Constructor for class jHelp.htmlResources_en
htmlResources_en_US(). Constructor for class jHelp.htmlResources_en_US

I

IDX_FIND. Static variable in class jHelp.htmlResources
IDX_INDEX. Static variable in class jHelp.htmlResources
IDX_QUERY. Static variable in class jHelp.htmlResources
IMAGE_ERROR. Static variable in class jHelp.htmlResources
INDEX. Static variable in class jHelp.htmlResources
INDEX_ERROR. Static variable in class jHelp.htmlResources
IndexResources(). Constructor for class jHelp.index.IndexResources
INFORMATION. Static variable in class jHelp.htmlResources

J

JHELP_PRINTER. Static variable in class jHelp.htmlResources

L

LINK_ACTIVATED. Static variable in class jHelp.htmlLinkEvent

M

main(String[]). Static method in class jHelp.htmlHelpIndexBuilder
static main method for standalone execution.
main(String[]). Static method in class jHelp.index.Wizard
MATCH_CASE. Static variable in class jHelp.htmlResources
moreDown(). Method in class jHelp.htmlHelpPanel
This method returns true if the current document may still be scrolled up.
moreUp(). Method in class jHelp.htmlHelpPanel
This method returns true if the current document may still be scrolled down.

N

NO_DOCUMENT. Static variable in class jHelp.htmlResources
NO_ENTRY. Static variable in class jHelp.htmlResources
NO_SEARCH_TEXT. Static variable in class jHelp.htmlResources
NO_SEPARATOR. Static variable in class jHelp.htmlResources
noScrollbar(). Method in class jHelp.htmlHelpPanel
This method is used to remove the scrollbar.
NOT_FOUND. Static variable in class jHelp.htmlResources
NOTHING. Static variable in class jHelp.htmlResources

P

pageDown(). Method in class jHelp.htmlHelpPanel
This method is used to scroll down one page increment.
pageUp(). Method in class jHelp.htmlHelpPanel
This method is used to scroll up one page increment.
paint(Graphics). Method in class jHelp.htmlHelpPanel
PREPARING. Static variable in class jHelp.htmlResources
PRINT. Static variable in class jHelp.htmlResources
printHelpFile(Frame). Method in class jHelp.htmlHelpPanel
Invokes printing the current document.
PRINTING_PAGE. Static variable in class jHelp.htmlResources

Q

QRY_FIND. Static variable in class jHelp.htmlResources
QRY_FOUND. Static variable in class jHelp.htmlResources
QRY_WORD. Static variable in class jHelp.htmlResources

R

REFORMATING. Static variable in class jHelp.htmlResources
removeActionListener(ActionListener). Method in class jHelp.htmlHelpPanel
resetStacks(). Method in class jHelp.htmlHelpFrame
This method can be called to force clearing/resetting the back/forward navigation stacks.
resetStacks(). Method in class jHelp.htmlHelpPanel
This method can be called to force clearing/resetting the back/forward navigation stacks.

S

SEARCH. Static variable in class jHelp.htmlResources
SEARCH_PROMPT. Static variable in class jHelp.htmlResources
SEARCH_TITLE. Static variable in class jHelp.htmlResources
setBounds(int, int, int, int). Method in class jHelp.htmlHelpSearchPanel
setEnabled(boolean). Method in interface jHelp.htmlNavControl
setGoToBase(String). Method in class jHelp.htmlHelpPanel
This method permits setting a help document path at runtime, so that the goTo method can be used with a filename, rather than an explicit path when it needs to be invoked.
setHelpIndex(htmlHelpIndexFrame). Method in class jHelp.htmlHelpFrame
The setHelpIndex method assigns an htmlHelpIndexFrame object to this help frame and enables the "Index" button.
setIndexButtonVisible(boolean). Method in class jHelp.htmlHelpFrame
This method hides/shows the index button.
setJhelpListener(htmlJhelpListener). Method in class jHelp.htmlHelpFrame
Sets an external listener, implementing htmlJhelpListener, that may respond to the user hiding the htmlHelpFrame, or a low memory or other exception, thrown when jHelp attempts to create the text image.
setJhelpListener(htmlJhelpListener). Method in class jHelp.htmlHelpPanel
Sets an external listener, implementing htmlJhelpListener, that may respond to the user hiding the htmlHelpFrame, or a low memory or other exception, thrown when jHelp attempts to create the text image.
setLocation(int, int). Method in class jHelp.htmlHelpIndexFrame
Set the index frame's location.
setLocation(Point). Method in class jHelp.htmlHelpIndexFrame
Set the index frame's location.
setMaxCache(int). Method in class jHelp.htmlHelpFrame
This method permits setting a maximum number of help documents that are retained in memory by jHelp.
setMaxCache(int). Method in class jHelp.htmlHelpPanel
This method permits setting a maximum number of help documents that are retained in memory by jHelp.
setPrintButtonVisible(boolean). Method in class jHelp.htmlHelpFrame
This method hides/shows the print button.
setPrinterEnabled(boolean). Method in class jHelp.htmlHelpFrame
This method enables/disables the print button.
setShowBase(String). Method in class jHelp.htmlHelpFrame
This method permits setting a help document path at runtime, so that the show method can be used with a filename, rather than an explicit path when it needs to be invoked.
setSize(Dimension). Method in class jHelp.htmlHelpIndexFrame
Set the size of the index frame.
setSize(int, int). Method in class jHelp.htmlHelpIndexFrame
Set the size of the index frame.
setText(String). Method in class jHelp.htmlHelpPanel
A convenience method to display a String of text.
setVisible(boolean). Method in class jHelp.htmlHelpFrame
Hide the help frame
setVisible(boolean). Method in class jHelp.htmlHelpIndexFrame
Display the index frame, at either the default size and location, or at a previously set size and location.
show(). Method in class jHelp.htmlHelpFrame
This overridden show method simply displays the current help file, at the current document position.
show(). Method in class jHelp.htmlHelpIndexFrame
Display the index frame, at either the default size and location, or at a previously set size and location.
show(String). Method in class jHelp.htmlHelpFrame
This overridden show method permits the named help file to be displayed, optionally at a specific NAME'd location within the file.
show(String, int). Method in class jHelp.htmlHelpFrame
This overridden show method permits the named help file to be displayed, at a specific index location within the file.
sort(Object[]). Static method in class jHelp.index.htmlQSortAlgorithm
Sorts the specified array of Objects, based upon the String returned by the Object's toString() method.
SRCH_ENTER. Static variable in class jHelp.htmlResources
SRCH_FOUND. Static variable in class jHelp.htmlResources

T

TabPanel(String, Panel). Constructor for class jHelp.tabs.TabPanel
Creates a tabbed-folders panel, with the provided caption and panels as the initially selected tab.
TAG_ERROR. Static variable in class jHelp.htmlResources
TXTLBL. Static variable in class jHelp.htmlResources

U

update(Graphics). Method in class jHelp.htmlHelpPanel
useHeaders(). Method in class jHelp.index.htmlHelpIndexBuilderProject
useTitles(). Method in class jHelp.index.htmlHelpIndexBuilderProject

V

vSources. Static variable in class jHelp.htmlHelpIndexBuilder

W

WHOLE_WORD. Static variable in class jHelp.htmlResources