public interface HTMLBrowser
An HTMLBrowser implementation must support the following features for Help to be fully functional :
setURL(..)
methods.
Oracle Help for Java includes the ICEBrowser implementation of the HTMLBrowser interface. The ICEBrowser implementation wraps ICESoft AS's ICE Browser which has been licensed for use with Oracle Help for Java.
URLEvent
,
URLListener
,
ProtocolEvent
,
ProtocolListener
,
ICEBrowser
Modifier and Type | Method and Description |
---|---|
void |
addPopupListener(oracle.help.htmlBrowser.PopupListener listener)
Adds a popup listener.
|
void |
addProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener)
Adds a protocol listener.
|
void |
addURLListener(oracle.help.htmlBrowser.URLListener listener)
Adds a url listener.
|
boolean |
canGoBack()
Determines whether it is possible to move backward
|
boolean |
canGoForward()
Determines whether it is possible to move forward in the stack.
|
void |
clear()
Instructs the HTMLBrowser to clear the display of any loaded HTML
|
void |
decreaseFontSize()
Decreases the font size used by the TopicDisplay
|
void |
dispose()
Disposes HTMLBrowser resources
|
java.lang.String |
getCharset()
Gets the HTML character encoding.
|
java.lang.String |
getCurrentPageTitle()
Returns the title of the page currently viewed in the browser
|
java.awt.Dimension |
getCurrentRenderedSize()
Returns the size of the rendered document.
|
oracle.help.htmlBrowser.FindSupport |
getFindSupport()
Returns the FindSupport implementation for this
HTMLBrowser implementation (or null if the browser
does not support this feature)
|
javax.swing.JPanel |
getHTMLContainer()
Returns a JPanel containing the HTMLBrowser
if possible, null otherwise.
|
java.util.Locale |
getLocale()
Gets the Locale set on the HTMLBrowser.
|
java.awt.print.Printable |
getPrintable(java.net.URL[] urls)
Get the printable to be printed for the specified URLs
|
java.lang.String |
getSelectedText()
Gets the text highlighted in the TopicDisplay
|
java.net.URL |
getURL()
Returns the currently displayed URL.
|
void |
goBack()
Goes back
|
void |
goForward()
Goes forward in the stack.
|
void |
increaseFontSize()
Increases the font size used by the TopicDisplay
|
boolean |
isPrintingSupported()
Determines whether printing is supported by this HTMLBrowser.
|
void |
printURL(java.net.URL url)
Print the HTML page at the given URL
|
void |
printURLs(java.net.URL[] urls)
Prints the HTML pages given (in book form if possible)
|
void |
reloadURL()
Reloads the current URL.
|
void |
removePopupListener(oracle.help.htmlBrowser.PopupListener listener)
Removes a popup listener.
|
void |
removeProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener)
Removes a ProtocolLink listener.
|
void |
removeURLListener(oracle.help.htmlBrowser.URLListener listener)
Removes a url listener.
|
void |
runFindDialog()
Runs the FindDialog via CTRL-F and Tools|Find menu seaches.
|
void |
selectAll()
Selects all the text in the browser window
|
void |
setCharset(java.lang.String charset)
Sets the character encoding to be used when loading URLs.
|
void |
setDefaultBackground(java.awt.Color bgcolor)
Sets the default background color for HTML pages.
|
void |
setDefaultLinkForeground(java.awt.Color linkfg)
Sets the default foreground color for links on HTML pages.
|
void |
setDefaultTextForeground(java.awt.Color textfg)
Sets the default foreground color for plain text on HTML pages.
|
void |
setLocale(java.util.Locale aLocale)
Sets the Locale on the HTMLBrowser, if possible.
|
void |
setURL(java.net.URL url)
Sets the HTMLBrowser URL to the specified URL.
|
void |
setURL(java.net.URL url,
boolean waitForRendering)
Sets the HTMLBrowser URL to the specified URL.
|
void setURL(java.net.URL url)
url
- url
is the URL to be displayedvoid setURL(java.net.URL url, boolean waitForRendering)
url
- url
is the URL to be displayedwaitForRendering
- if true the page will be rendered
synchronously (if the underlying browser permits).void clear()
void reloadURL()
java.awt.print.Printable getPrintable(java.net.URL[] urls)
java.net.URL getURL()
javax.swing.JPanel getHTMLContainer()
java.awt.Dimension getCurrentRenderedSize()
boolean isPrintingSupported()
true
if printing support;
false
otherwise;void printURL(java.net.URL url)
url
- the URL to be printedvoid printURLs(java.net.URL[] urls)
urls
- the URL[] to be printedvoid addURLListener(oracle.help.htmlBrowser.URLListener listener)
This is required to support auto-tree-refresh feature in Help.
listener
- URLListener to be added.void removeURLListener(oracle.help.htmlBrowser.URLListener listener)
listener
- URLListener to be removed.void addPopupListener(oracle.help.htmlBrowser.PopupListener listener)
listener
- PopupListener to be addedvoid removePopupListener(oracle.help.htmlBrowser.PopupListener listener)
listener
- PopupListener to be removed.oracle.help.htmlBrowser.FindSupport getFindSupport()
void runFindDialog()
java.lang.String getCharset()
void setCharset(java.lang.String charset)
charset
- A java supported character encodingjava.util.Locale getLocale()
void setLocale(java.util.Locale aLocale)
charset
- A java supported character encodingvoid setDefaultBackground(java.awt.Color bgcolor)
bgcolor
- The new default background colorvoid setDefaultTextForeground(java.awt.Color textfg)
textfg
- The new default text foreground colorvoid setDefaultLinkForeground(java.awt.Color linkfg)
linkfg
- The new default link foreground colorvoid addProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener)
listener
- ProtocolListener to be added.void removeProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener)
listener
- Listener to be removed.void dispose()
boolean canGoBack()
void goBack()
boolean canGoForward()
void goForward()
java.lang.String getSelectedText()
void increaseFontSize()
void decreaseFontSize()
void selectAll()
java.lang.String getCurrentPageTitle()