Oracle Help for Java API Reference
Release 4.2.6.0.0
B12198-01
A B C D E F G H I L M N O P Q R S T U V X _

A

addBook(Book) - Method in class oracle.help.Help
Add a book to the help system's library.
addBook(Book) - Method in class oracle.help.viewer.Viewer
Add a book to the Viewer's library.
addBook(Book, boolean) - Method in class oracle.help.CSHManager
Adds the book to the help system.
addComponent(Component, Book, String) - Method in class oracle.help.CSHManager
Registers a component with the help manager.
addComponent(Component, Book, String, boolean, boolean) - Method in class oracle.help.CSHManager
Registers a component with the CSHManager.
addComponent(Component, String) - Method in class oracle.help.CSHManager
Registers a component with the help manager.
addComponent(Component, String, boolean, boolean) - Method in class oracle.help.CSHManager
Registers a component with the CSHManager using the default book.
addNavigatorListener(NavigatorListener) - Method in class oracle.help.navigator.Navigator
 
addPopupListener(PopupListener) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Adds a popup listener.
addPopupListener(PopupListener) - Method in class oracle.help.htmlBrowser.ICEBrowser
Adds a popup listener.
addProtocolListener(ProtocolListener) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Adds a protocol listener.
addProtocolListener(ProtocolListener) - Method in class oracle.help.htmlBrowser.ICEBrowser
Adds a ProtocolListener.
addURLListener(URLListener) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Adds a url listener.
addURLListener(URLListener) - Method in class oracle.help.htmlBrowser.ICEBrowser
Adds a url listener.
addView(View) - Method in class oracle.help.navigator.LazyNavigator
 
addView(View) - Method in interface oracle.help.common.navigator.BaseNavigator
Add a view to the navigator.
addViewNow(View) - Method in class oracle.help.navigator.LazyNavigator
Methods for adding a view assuming the navigator has been initialized

B

BaseNavigator - interface oracle.help.common.navigator.BaseNavigator.
The BaseNavigator interface defines a set of methods common to all navigators.
Book - interface oracle.help.library.Book.
The Book interface defines a set of methods for accessing a set of Help data.
BROWSER_PATH - Static variable in class oracle.help.viewer.Viewer
 

C

canGoBack() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Determines whether it is possible to move backward
canGoBack() - Method in class oracle.help.htmlBrowser.ICEBrowser
Determines whether it is possible to move backward
canGoForward() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Determines whether it is possible to move forward in the stack.
canGoForward() - Method in class oracle.help.htmlBrowser.ICEBrowser
Determines whether it is possible to move forward in the stack.
clear() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Instructs the HTMLBrowser to clear the display of any loaded HTML
clear() - Method in class oracle.help.htmlBrowser.ICEBrowser
Instructs the HTMLBrowser to clear the display of any loaded HTML
CLOSE - Static variable in class oracle.help.viewer.PreferenceManager
 
COMMENT - Static variable in class oracle.help.viewer.PreferenceManager
 
createDataObject(View, String, String, String) - Method in class oracle.help.engine.DataEngine
Create an Object for the file at the specified file system basePath and filename that uses the specified encoding
createDataObject(View, String, URL, String) - Method in class oracle.help.engine.DataEngine
Create an object for a file at the specified URL that uses the specified encoding
createDataObject(View, String, URL, String, String) - Method in class oracle.help.engine.DataEngine
Create an Object for a file at URL url that uses the specified encoding and engine parameters engineParams.
createNavigator(String, Library, String, Image, boolean) - Static method in class oracle.help.navigator.Navigator
 
createNavigator(String, String, Image) - Static method in class oracle.help.navigator.Navigator
 
CSHManager - class oracle.help.CSHManager.
CSHManager is a helper class to manage Help with in an application.
CSHManager(Help) - Constructor for class oracle.help.CSHManager
Creates a new instance of CSHManager class.
CustomProtocolHandler - interface oracle.help.CustomProtocolHandler.
A CustomProtocolHandler is registered with the help system according to some identifier Consider the following HTML: <a href="custom:protocolName:protocolValue"/> If this CustomProtocolHandler is registered with the Help object using the "protocolName" identifier, then its handleValue method will be invoked, passing protocolValue as the value

D

DataEngine - class oracle.help.engine.DataEngine.
Each View in a book will have a DataEngine for getting its data.
DataEngine() - Constructor for class oracle.help.engine.DataEngine
 
decreaseFontSize() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Decreases the font size used by the TopicDisplay
decreaseFontSize() - Method in class oracle.help.htmlBrowser.ICEBrowser
Decreases the font size used by the TopicDisplay
dispose() - Method in class oracle.help.Help
Dispose the help system.
dispose() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Disposes HTMLBrowser resources
dispose() - Method in class oracle.help.htmlBrowser.ICEBrowser
Disposes HTMLBrowser resources
dispose() - Method in class oracle.help.viewer.Viewer
Dispose the Viewer.
doInitializationNow() - Method in class oracle.help.navigator.LazyNavigator
Method for performing the time consuming work of the initialization.

E

engineParams - Variable in class oracle.help.engine.DataEngine
 
EQUALS - Static variable in class oracle.help.viewer.PreferenceManager
 
EXTERNAL_ENABLED - Static variable in class oracle.help.viewer.Viewer
 

F

filterByLabel - Variable in class oracle.help.navigator.Navigator
 
filterViewsByLabel(View[], String) - Method in class oracle.help.navigator.Navigator
 
fireNavigatorEvent(NavigatorEvent) - Method in class oracle.help.navigator.Navigator
 

G

getAllNavigators() - Method in class oracle.help.CSHManager
Get the Navigator objects displayed in the help system's Navigator Window
getAllNavigators() - Method in class oracle.help.Help
Get the Navigator objects displayed in the Navigator Window.
getAllNavigators() - Method in class oracle.help.viewer.Viewer
Get the Navigator objects displayed in the Navigator Window.
getAllViews() - Method in interface oracle.help.library.Book
Get all of the View objects defined in this book (views of all types).
getAllViews() - Method in class oracle.help.library.helpbook.HelpBook
 
getAllViews() - Method in class oracle.help.library.helpset.HelpSet
 
getAssociativeLinks() - Method in interface oracle.help.library.Book
Get the AssociativeLink objects defined in this book.
getAssociativeLinks() - Method in class oracle.help.library.helpbook.HelpBook
 
getAssociativeLinks() - Method in class oracle.help.library.helpset.HelpSet
 
getBaseName() - Method in class oracle.help.library.helpbook.HelpBook
Returns the baseName.
getBaseURL() - Method in class oracle.help.library.helpbook.HelpBook
 
getBookCount() - Method in class oracle.help.Help
Returns the number of Book objects currently in the help system's library.
getBookCount() - Method in class oracle.help.viewer.Viewer
Returns the number of Book objects currently in the Viewer's library.
getBooks() - Method in class oracle.help.Help
Get all of the Book objects currently in the help system's library.
getBooks() - Method in class oracle.help.viewer.Viewer
Get all of the Book objects currently in the Viewer's library.
getBookTitle() - Method in interface oracle.help.library.Book
Get the title of the Book
getBookTitle() - Method in class oracle.help.library.helpbook.HelpBook
 
getBookTitle() - Method in class oracle.help.library.helpset.HelpSet
 
getCharset() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Gets the HTML character encoding.
getCharset() - Method in class oracle.help.htmlBrowser.ICEBrowser
Gets the HTML character encoding.
getCurrentRenderedSize() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Returns the size of the rendered document.
getCurrentRenderedSize() - Method in class oracle.help.htmlBrowser.ICEBrowser
Returns the size of the rendered document.
getCurrentSelection() - Method in interface oracle.help.common.navigator.BaseNavigator
Get the Topic currently selected in the navigator.
getDefaultLabel() - Method in interface oracle.help.common.navigator.BaseNavigator
Get the default label for the navigator.
getHelpEncoding() - Static method in class oracle.help.Help
Get the Character Set Encoding used by the Oracle Help for Java classes for reading in client help files.
getHelpEncoding() - Static method in class oracle.help.viewer.Viewer
Get the Character Set Encoding used by the Oracle Help for Java classes for reading in client help files.
getHelpLocale() - Static method in class oracle.help.Help
Get the Locale currently being used by the Oracle Help for Java classes for Locale sensitive operations and resource loading.
getHelpLocale() - Static method in class oracle.help.viewer.Viewer
Get the Locale currently being used by the Oracle Help for Java classes for Locale sensitive operations and resource loading.
getHelpObject() - Method in class oracle.help.CSHManager
Gets the Help object of this HelpManager.
getHelpSetEncoding() - Method in class oracle.help.library.helpset.HelpSet
Gets the encoding of the HelpSet, null if using the LocaleUtils default encoding
getHelpSetSections() - Method in class oracle.help.library.helpset.HelpSet
 
getHomeID() - Method in class oracle.help.library.helpset.HelpSet
Gets the HomeID for the HelpSet.
getHTMLContainer() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Returns a JPanel containing the HTMLBrowser if possible, null otherwise.
getHTMLContainer() - Method in class oracle.help.htmlBrowser.ICEBrowser
Returns an LWContainer containing the HTMLBrowser if possible, null otherwise.
getInitialViewsArray() - Method in class oracle.help.navigator.LazyNavigator
Get the initial views for the Navigator
getLabel() - Method in class oracle.help.navigator.Navigator
 
getLabel() - Method in interface oracle.help.common.navigator.BaseNavigator
Get the label corresponding to the navigator.
getLabelImage() - Method in class oracle.help.navigator.Navigator
 
getLocale() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Gets the Locale set on the HTMLBrowser.
getLocale() - Method in class oracle.help.htmlBrowser.ICEBrowser
Gets the Locale set on the HTMLBrowser.
getPreference(String) - Static method in class oracle.help.viewer.PreferenceManager
Retrieve the value of a preference.
getPrintable(URL[]) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Get the printable to be printed for the specified URLs
getPrintable(URL[]) - Method in class oracle.help.htmlBrowser.ICEBrowser
 
getSelectedText() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Gets the text highlighted in the TopicDisplay
getSelectedText() - Method in class oracle.help.htmlBrowser.ICEBrowser
Gets the text highlighted in the TopicDisplay
getTitle() - Method in class oracle.help.library.helpbook.HelpBook
Returns the book title.
getType() - Method in class oracle.help.navigator.Navigator
 
getType() - Method in interface oracle.help.common.navigator.BaseNavigator
Get the type corresponding to the navigator.
getURL() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Returns the currently displayed URL.
getURL() - Method in class oracle.help.htmlBrowser.ICEBrowser
Gets the current Url.
getViewsByType(String) - Method in interface oracle.help.library.Book
Get the View objects defined in this book of the specified type.
getViewsByType(String) - Method in class oracle.help.library.helpbook.HelpBook
 
getViewsByType(String) - Method in class oracle.help.library.helpset.HelpSet
 
getWindowTypes() - Method in interface oracle.help.library.Book
Get the WindowType objects defined in this book.
getWindowTypes() - Method in class oracle.help.library.helpbook.HelpBook
 
getWindowTypes() - Method in class oracle.help.library.helpset.HelpSet
 
goBack() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Goes back
goBack() - Method in class oracle.help.htmlBrowser.ICEBrowser
Goes back
goForward() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Goes forward in the stack.
goForward() - Method in class oracle.help.htmlBrowser.ICEBrowser
Goes forward in the stack.

H

handleValue(String) - Method in interface oracle.help.CustomProtocolHandler
 
Help - class oracle.help.Help.
The Help class provides a default implementation of a help system using the Oracle Help for Java components.
Help() - Constructor for class oracle.help.Help
Creates an instance of the Help object with ICEBrowser as the HTMLBrowser component used for topic display.
Help(AppletContext, String) - Constructor for class oracle.help.Help
Creates an instance of the Help object using the native browser as the topic display through the given applet context.
Help(AppletContext, String, boolean, boolean) - Constructor for class oracle.help.Help
Creates an instance of the Help object using the native browser as the topic display through the given applet context.
Help(boolean, boolean) - Constructor for class oracle.help.Help
Creates an instance of the Help object with ICEBrowser as the HTMLBrowser component used for topic display.
Help(boolean, boolean, boolean) - Constructor for class oracle.help.Help
Creates an instance of the Help object with ICEBrowser as the HTMLBrowser component used for topic display.
Help(Class) - Constructor for class oracle.help.Help
Creates an instance of the Help object with specified browser as the HTMLBrowser component used for topic display.
Help(Class, boolean, boolean) - Constructor for class oracle.help.Help
Creates an instance of the Help object with specified HTMLBrowser as the HTMLBrowser component used for topic display.
Help(Class, boolean, boolean, boolean) - Constructor for class oracle.help.Help
Creates an instance of the Help object with specified HTMLBrowser as the HTMLBrowser component used for topic display.
Help(Class, boolean, boolean, boolean, boolean) - Constructor for class oracle.help.Help
Creates an instance of the Help object with specified HTMLBrowser as the HTMLBrowser component used for topic display.
HelpBook - class oracle.help.library.helpbook.HelpBook.
An implementation of the Book interface that supports the file formats used in Oracle Help for Java version 3.0 and earlier.
HelpBook() - Constructor for class oracle.help.library.helpbook.HelpBook
Create an empty HelpBook.
HelpBook(Class, String, String, String) - Constructor for class oracle.help.library.helpbook.HelpBook
Create a HelpBook with the specified title, loading the data from the given location.
HelpBook(Class, String, String, String, String) - Constructor for class oracle.help.library.helpbook.HelpBook
Create a HelpBook with the specified title, loading the data from the given location using the specified encoding.
HelpBook(String, String, String) - Constructor for class oracle.help.library.helpbook.HelpBook
Create a HelpBook with the specified title, loading the data from the given location.
HelpBook(String, String, String, String) - Constructor for class oracle.help.library.helpbook.HelpBook
Create a HelpBook with the specified title, loading the data from the given location using the specified encoding.
HelpSet - class oracle.help.library.helpset.HelpSet.
A robust implementation of the Book interface that supports the Oracle Help for Java extensions of the JavaHelp standard file format.
HelpSet() - Constructor for class oracle.help.library.helpset.HelpSet
Create an empty HelpSet Note: Most clients will use the HelpSet() constructors that load help content from an existing helpset file.
HelpSet(Class, String) - Constructor for class oracle.help.library.helpset.HelpSet
Create a HelpSet from the helpset file at the specified location.
HelpSet(Class, String, String) - Constructor for class oracle.help.library.helpset.HelpSet
Create a HelpSet from the helpset file at the specified location using the specified encoding.
HelpSet(URL) - Constructor for class oracle.help.library.helpset.HelpSet
Create a HelpSet from the helpset file at the specified location.
HelpSet(URL, String) - Constructor for class oracle.help.library.helpset.HelpSet
Create a HelpSet from the helpset file at the specified location using the specified encoding.
HelpSetParseException - exception oracle.help.library.helpset.HelpSetParseException.
An exception thrown when the HelpSet Parser finds a state that can't happen.
HelpSetParseException(String) - Constructor for class oracle.help.library.helpset.HelpSetParseException
The constructor takes the string to print with the exception.
HTMLBrowser - interface oracle.help.htmlBrowser.HTMLBrowser.
Oracle Help for Java depends on a pluggable HTML display engine (browser) to display help documents.

I

ICEBrowser - class oracle.help.htmlBrowser.ICEBrowser.
ICEBrowser implements the HTMLBrowser interface based on Oracle's modified version of ICESoft AS's ICE Browser which has been licensed for use with Oracle Help for Java.
ICEBrowser() - Constructor for class oracle.help.htmlBrowser.ICEBrowser
Creates an instance of ICEBrowser.
increaseFontSize() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Increases the font size used by the TopicDisplay
increaseFontSize() - Method in class oracle.help.htmlBrowser.ICEBrowser
Increases the font size used by the TopicDisplay
INDENT - Static variable in class oracle.help.viewer.PreferenceManager
 
initBaseClass(Library, String, String, Image, boolean) - Method in class oracle.help.navigator.Navigator
 
initializeLazyNavigator() - Method in class oracle.help.navigator.LazyNavigator
 
initNavigator(View[]) - Method in class oracle.help.navigator.LazyNavigator
 
initNavigator(View[]) - Method in interface oracle.help.common.navigator.BaseNavigator
Initialize the navigator with the initialViews.
isInitialized() - Method in class oracle.help.navigator.LazyNavigator
 
isPrintingSupported() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Determines whether printing is supported by this HTMLBrowser.
isPrintingSupported() - Method in class oracle.help.htmlBrowser.ICEBrowser
Determines if printing is supported;

L

label - Variable in class oracle.help.navigator.Navigator
 
labelImage - Variable in class oracle.help.navigator.Navigator
 
LazyNavigator - class oracle.help.navigator.LazyNavigator.
The LazyNavigator class extends the Navigator class and makes it easy to delay time-consuming navigator initializations.
LazyNavigator() - Constructor for class oracle.help.navigator.LazyNavigator
 
library - Variable in class oracle.help.navigator.Navigator
 
libraryChanged(LibraryEvent) - Method in class oracle.help.navigator.Navigator
 
listeners - Variable in class oracle.help.navigator.Navigator
 
loadPreferences() - Static method in class oracle.help.viewer.PreferenceManager
Load the preferences from the file currently associated with the preference manager.

M

main(String[]) - Static method in class oracle.help.viewer.ViewerApplication
Parse the command line arguments and create an instance of the ViewerApplication
mapIDToURL(String) - Method in interface oracle.help.library.Book
Get the URL the Book mapped to the given ID.
mapIDToURL(String) - Method in class oracle.help.library.helpbook.HelpBook
 
mapIDToURL(String) - Method in class oracle.help.library.helpset.HelpSet
 
mapURLToWindowTypeName(URL) - Method in interface oracle.help.library.Book
Get the name of the WindowType this Book has mapped to the given URL.
mapURLToWindowTypeName(URL) - Method in class oracle.help.library.helpbook.HelpBook
 
mapURLToWindowTypeName(URL) - Method in class oracle.help.library.helpset.HelpSet
Get the name of the WindowType this Book has mapped to the given URL.

N

NAME - Static variable in class oracle.help.viewer.PreferenceManager
 
Navigator - class oracle.help.navigator.Navigator.
The abstract Navigator class extends Swing's JPanel and implements the oracle.help.common.navigator.BaseNavigator interface to support operations common to all Navigators used in Oracle Help for Java.
Navigator() - Constructor for class oracle.help.navigator.Navigator
Create a navigator

O

OPEN - Static variable in class oracle.help.viewer.PreferenceManager
 

P

PARAM_CLASS - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_DEFAULT - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_ENGINE - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_ENGINEPARAMS - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_ID - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_IMAGE - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_LOCATION - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_TYPE - Static variable in class oracle.help.library.helpset.HelpSet
 
PARAM_URL - Static variable in class oracle.help.library.helpset.HelpSet
 
PREF - Static variable in class oracle.help.viewer.PreferenceManager
 
PreferenceManager - class oracle.help.viewer.PreferenceManager.
The PreferenceManager class provides a generic way of maintaining a collection of preferences.
PreferenceManager() - Constructor for class oracle.help.viewer.PreferenceManager
 
PREFERENCES - Static variable in class oracle.help.viewer.PreferenceManager
 
printURL(URL) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Print the HTML page at the given URL
printURL(URL) - Method in class oracle.help.htmlBrowser.ICEBrowser
Print the HTML page at the given URL
printURLs(URL[]) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Prints the HTML pages given (in book form if possible)
printURLs(URL[]) - Method in class oracle.help.htmlBrowser.ICEBrowser
Prints the HTML pages given (in book form if possible)
propertyChange(PropertyChangeEvent) - Method in class oracle.help.htmlBrowser.ICEBrowser
PropertyChangeListener implementation to dispatch ChangeUrl events.

Q

QUEST - Static variable in class oracle.help.viewer.PreferenceManager
 
QUOTE - Static variable in class oracle.help.viewer.PreferenceManager
 

R

registerClientWindow(Window) - Static method in class oracle.help.Help
Clients should register Window instances with the Help object.
registerCustomProtocolHandler(String, CustomProtocolHandler) - Method in class oracle.help.Help
Registers a CustomProtocolHandler for a custom protocol Consider the following HTML: <a href="custom:protocolName:protocolValue"/> When OHJ follows links that link, it will check for any CustomProtocolHandlers registered by the identifier "protocolName." If it finds a CustomProtocolHandler, its handleValue method will be invoked, passing protocolValue as the value
reloadURL() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Reloads the current URL.
reloadURL() - Method in class oracle.help.htmlBrowser.ICEBrowser
Reloads the current document.
removeAllBooks() - Method in class oracle.help.Help
Removes all books from the help system's library.
removeAllBooks() - Method in class oracle.help.viewer.Viewer
Removes all books from the Viewer's library.
removeBook(Book) - Method in class oracle.help.CSHManager
Removes a book from the help system.
removeBook(Book) - Method in class oracle.help.Help
Remove a book from the help system.
removeBook(Book) - Method in class oracle.help.viewer.Viewer
Remove a book from the Viewer.
removeComponent(Component) - Method in class oracle.help.CSHManager
Unregisters a component with the CSHManager.
removeNavigatorListener(NavigatorListener) - Method in class oracle.help.navigator.Navigator
 
removePopupListener(PopupListener) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Removes a popup listener.
removePopupListener(PopupListener) - Method in class oracle.help.htmlBrowser.ICEBrowser
Removes a popup listener.
removeProtocolListener(ProtocolListener) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Removes a ProtocolLink listener.
removeProtocolListener(ProtocolListener) - Method in class oracle.help.htmlBrowser.ICEBrowser
Removes a ProtocolListener.
removeURLListener(URLListener) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Removes a url listener.
removeURLListener(URLListener) - Method in class oracle.help.htmlBrowser.ICEBrowser
Removes a url listener.
removeView(View) - Method in class oracle.help.navigator.LazyNavigator
 
removeView(View) - Method in interface oracle.help.common.navigator.BaseNavigator
Remove the specified view from the navigator.
removeViewNow(View) - Method in class oracle.help.navigator.LazyNavigator
Methods for removing a view assuming the navigator has been initialized
runFindDialog() - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Runs the FindDialog via CTRL-F and Tools|Find menu seaches.
runFindDialog() - Method in class oracle.help.htmlBrowser.ICEBrowser
Runs the FindDialog via CTRL-F and Tools|Find menu seaches.

S

savePreferences() - Static method in class oracle.help.viewer.PreferenceManager
Save the preferences to the file currently associated with the preference manager in XML format.
setCharset(String) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Sets the character encoding to be used when loading URLs.
setCharset(String) - Method in class oracle.help.htmlBrowser.ICEBrowser
Sets the character encoding to be used when loading URLs.
setDefaultBackground(Color) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Sets the default background color for HTML pages.
setDefaultBackground(Color) - Method in class oracle.help.htmlBrowser.ICEBrowser
Sets the default background color for HTML pages.
setDefaultBook(Book) - Method in class oracle.help.CSHManager
Sets the specified Book as the default Book.
setDefaultBook(Book) - Method in class oracle.help.Help
Sets the default book for use with the showHelp methods.
setDefaultLinkForeground(Color) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Sets the default foreground color for links on HTML pages.
setDefaultLinkForeground(Color) - Method in class oracle.help.htmlBrowser.ICEBrowser
Sets the default foreground color for links on HTML pages.
setDefaultTextForeground(Color) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Sets the default foreground color for plain text on HTML pages.
setDefaultTextForeground(Color) - Method in class oracle.help.htmlBrowser.ICEBrowser
Sets the default foreground color for plain text on HTML pages.
setDefaultTopicID(String) - Method in class oracle.help.Help
Sets the default topicID for use with the showHelp methods.
setFilename(String) - Static method in class oracle.help.viewer.PreferenceManager
Sets the file associated with the preference manager
setHelpEncoding(String) - Static method in class oracle.help.Help
Set the Character Set Encoding used by the Oracle Help for Java classes for reading in client help files.
setHelpEncoding(String) - Static method in class oracle.help.viewer.Viewer
Set the Character Set Encoding used by the Oracle Help for Java classes for reading in client help files.
setHelpLocale(Locale) - Static method in class oracle.help.Help
Set the Locale used by the Oracle Help for Java classes for Locale sensitive operations and resource loading.
setHelpLocale(Locale) - Static method in class oracle.help.viewer.Viewer
Set the Locale used by the Oracle Help for Java classes for Locale sensitive operations and resource loading.
setHelpOnHelp(Book, String) - Method in class oracle.help.Help
Calling this method with valid book and topicID parameters will enable the "Help on Help" menu option in the Help Navigator.
setHelpOnHelp(Book, String) - Method in class oracle.help.viewer.Viewer
Calling this method with valid book and topicID parameters will enable the "Help on Help" menu option in the Help Navigator.
setHelpOnHelp(URL) - Method in class oracle.help.Help
Calling this method with a valid URL parameter will enable the "Help on Help" menu option in the Help Navigator.
setHelpOnHelp(URL) - Method in class oracle.help.viewer.Viewer
Calling this method with a valid URL parameter will enable the "Help on Help" menu option in the Viewer Navigator.
setHomeID(String) - Method in class oracle.help.library.helpset.HelpSet
Sets the HomeID for the HelpSet.
setIconImage(Image) - Method in class oracle.help.Help
Call this method to set a custom image for the window icons in the Oracle Help for Java windows.
setIconImage(Image) - Method in class oracle.help.viewer.Viewer
Call this method to set a custom image for the window icons in the Oracle Help for Java windows.
setLabel(String) - Method in class oracle.help.navigator.Navigator
 
setLabelImage(Image) - Method in class oracle.help.navigator.Navigator
 
setLocale(Locale) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Sets the Locale on the HTMLBrowser, if possible.
setLocale(Locale) - Method in class oracle.help.htmlBrowser.ICEBrowser
Sets the Locale on the HTMLBrowser, if possible.
setPreference(String, String) - Static method in class oracle.help.viewer.PreferenceManager
Add a preference (a name/value pair) to the current set of preferences.
setPreferenceNoClobber(String, String) - Static method in class oracle.help.viewer.PreferenceManager
If no preference of the given name exists in the set of preferences already, then create it and set its value; otherwise leave the existing preference alone.
setURL(URL) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Sets the HTMLBrowser URL to the specified URL.
setURL(URL) - Method in class oracle.help.htmlBrowser.ICEBrowser
Sets the ICEBrowser URL to be the specified URL.
setURL(URL, boolean) - Method in interface oracle.help.htmlBrowser.HTMLBrowser
Sets the HTMLBrowser URL to the specified URL.
setURL(URL, boolean) - Method in class oracle.help.htmlBrowser.ICEBrowser
Sets the HTMLBrowser URL to the specified URL.
setVisible(boolean) - Method in class oracle.help.Help
Sets the visibility of the help system.
setVisible(boolean) - Method in class oracle.help.viewer.Viewer
Sets the visibility of the Viewer.
setVisible(boolean) - Method in class oracle.help.navigator.LazyNavigator
 
showHelp(Component) - Method in class oracle.help.Help
Implements the HelpProvider interface from Oracle's JEWT toolkit.
showHelp(Object, String, Component) - Method in class oracle.help.Help
Implements the HelpProvider interface from Oracle's EWT toolkit.
showHelpForComponent(Component) - Method in class oracle.help.CSHManager
Shows help for the specified component.
showNavigatorWindow() - Method in class oracle.help.CSHManager
Shows the help system's navigator window
showNavigatorWindow() - Method in class oracle.help.Help
Show the Navigator Window
showNavigatorWindow() - Method in class oracle.help.viewer.Viewer
Show the Navigator Window
showNavigatorWindow(Book) - Method in class oracle.help.CSHManager
Show the Navigator Window with the NavigatorTabPanel for the given Book initially displayed.
showNavigatorWindow(Book) - Method in class oracle.help.Help
Show the Navigator Window with the NavigatorTabPanel for the given Book initially displayed.
showNavigatorWindow(Book) - Method in class oracle.help.viewer.Viewer
Show the Navigator Window with the NavigatorTabPanel for the given Book initially displayed.
showNavigatorWindow(Navigator) - Method in class oracle.help.CSHManager
Shows the help system's navigator window with the given navigator selected
showNavigatorWindow(Navigator) - Method in class oracle.help.Help
Show the Navigator Window with a specific Navigator displayed initially.
showNavigatorWindow(Navigator) - Method in class oracle.help.viewer.Viewer
Show the Navigator Window with a specific Navigator displayed initially.
showTopic(Book, String) - Method in class oracle.help.Help
Shows the given topic from the given book in a currently existing topic window.
showTopic(Book, String) - Method in class oracle.help.viewer.Viewer
Shows the given topic from the given book in a currently existing topic window.
showTopic(Book, String, boolean) - Method in class oracle.help.Help
Shows the given topic from the given book.
showTopic(Book, String, boolean) - Method in class oracle.help.viewer.Viewer
Shows the given topic from the given book.
showTopic(Book, String, boolean, Point, Dimension) - Method in class oracle.help.Help
Shows the given topic from the given book.
showTopic(Book, String, boolean, Point, Dimension) - Method in class oracle.help.viewer.Viewer
Shows the given topic from the given book.
showTopic(String) - Method in class oracle.help.CSHManager
Shows help topic corresponding to the specified topic id.
SLASH - Static variable in class oracle.help.viewer.PreferenceManager
 
SPACE - Static variable in class oracle.help.viewer.PreferenceManager
 
startDemo() - Method in class oracle.help.viewer.ViewerApplication
 

T

TAG_BG - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_DATA - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_HEIGHT - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_HELPSET - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_HOMEID - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_KEY - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_LABEL - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_LINKFG - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_LINKREF - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_LINKS - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_MAP - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_MAPREF - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_MERGETYPE - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_NAME - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_SUBHELPSET - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_TEXTFG - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_TITLE - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_TOOLBAR - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_TYPE - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_VIEW - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_WIDTH - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_WINTYPE - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_X - Static variable in class oracle.help.library.helpset.HelpSet
 
TAG_Y - Static variable in class oracle.help.library.helpset.HelpSet
 
topicActivated(NavigatorEvent) - Method in class oracle.help.Help
Public method as a result of the NavigatorListener interface.
topicActivated(NavigatorEvent) - Method in class oracle.help.viewer.Viewer
Public method as a result of the NavigatorListener interface.
topicSelected(NavigatorEvent) - Method in class oracle.help.Help
Public method as a result of the NavigatorListener interface.
topicSelected(NavigatorEvent) - Method in class oracle.help.viewer.Viewer
Public method as a result of the NavigatorListener interface.
type - Variable in class oracle.help.navigator.Navigator
 

U

unregisterClientWindow(Window) - Static method in class oracle.help.Help
Clients should unregister each Window instance that they registered with the registerClientWindow() method once the window will no longer be active.
usage() - Static method in class oracle.help.viewer.ViewerApplication
Print a statement explaining how to run the application.
USE_DEFAULT_BROWSER - Static variable in class oracle.help.viewer.Viewer
 

V

VALUE - Static variable in class oracle.help.viewer.PreferenceManager
 
Viewer - class oracle.help.viewer.Viewer.
The Viewer class provides a stand-alone application for displaying large sets of HTML documentation.
Viewer(URL, boolean) - Constructor for class oracle.help.viewer.Viewer
Creates an instance of the Viewer object with ViewerICEBrowser as the HTMLBrowser component used for topic display.
Viewer(URL, boolean, boolean, boolean) - Constructor for class oracle.help.viewer.Viewer
Creates an instance of the Viewer object with ViewerICEBrowser as the HTMLBrowser component used for topic display.
ViewerApplication - class oracle.help.viewer.ViewerApplication.
The ViewerApplication class provides the main function from which the Viewer application is run.
ViewerApplication(Vector, URL) - Constructor for class oracle.help.viewer.ViewerApplication
 
views - Variable in class oracle.help.navigator.Navigator
 

X

XML - Static variable in class oracle.help.viewer.PreferenceManager
 

_

_getBufferedReader(URL, String) - Method in class oracle.help.engine.DataEngine
Get a BufferredReader for the file at URL aURL that uses the specified encoding.

A B C D E F G H I L M N O P Q R S T U V X _
HELP ${project.version}

Copyright © 1998,2004, Oracle. All Rights Reserved.