oracle.help.htmlBrowser
Class ICEBrowser

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.help.htmlBrowser.ICEBrowser

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, HTMLBrowser, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable

public class ICEBrowser

extends javax.swing.JPanel

implements HTMLBrowser, java.beans.PropertyChangeListener

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.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ICEBrowser()
Creates an instance of ICEBrowser.

Method Summary

void	addPopupListener(oracle.help.htmlBrowser.PopupListener listener) Adds a popup listener.
void	addProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener) Adds a ProtocolListener.
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.
javax.swing.JPanel	getHTMLContainer() Returns an LWContainer 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() Gets the current 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 if printing is supported;
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	propertyChange(java.beans.PropertyChangeEvent e) PropertyChangeListener implementation to dispatch ChangeUrl events.
void	reloadURL() Reloads the current document.
void	removePopupListener(oracle.help.htmlBrowser.PopupListener listener) Removes a popup listener.
void	removeProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener) Removes a ProtocolListener.
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 ICEBrowser URL to be the specified URL.
void	setURL(java.net.URL url, boolean waitForRendering) Sets the HTMLBrowser URL to the specified URL.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, paramString, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Constructor Detail

ICEBrowser

public ICEBrowser()

Creates an instance of ICEBrowser.

Method Detail

setURL

public void setURL(java.net.URL url)

Sets the ICEBrowser URL to be the specified URL.

Specified by:

setURL in interface HTMLBrowser

Parameters:

url - url is the URL to be displayed

setURL

public void setURL(java.net.URL url,
                   boolean waitForRendering)

Sets the HTMLBrowser URL to the specified URL. If waitForRendering is set to true, the method will render the HTML page synchronously (if the underlying browser permits).

Specified by:

setURL in interface HTMLBrowser

Parameters:

url - url is the URL to be displayed

waitForRendering - if true the page will be rendered synchronously (if the underlying browser permits).

clear

public void clear()

Instructs the HTMLBrowser to clear the display of any loaded HTML

Specified by:

clear in interface HTMLBrowser

getPrintable

public java.awt.print.Printable getPrintable(java.net.URL[] urls)

Description copied from interface: HTMLBrowser

Get the printable to be printed for the specified URLs

Specified by:

getPrintable in interface HTMLBrowser

getURL

public java.net.URL getURL()

Gets the current Url.

Specified by:

getURL in interface HTMLBrowser

Following copied from interface: oracle.help.htmlBrowser.HTMLBrowser

Returns:

The current URL.

reloadURL

public void reloadURL()

Reloads the current document.

Specified by:

reloadURL in interface HTMLBrowser

isPrintingSupported

public boolean isPrintingSupported()

Determines if printing is supported;

Specified by:

isPrintingSupported in interface HTMLBrowser

Following copied from interface: oracle.help.htmlBrowser.HTMLBrowser

Returns:

true if printing support; false otherwise;

printURL

public void printURL(java.net.URL url)

Print the HTML page at the given URL

Specified by:

printURL in interface HTMLBrowser

Parameters:

url - the URL to be printed

printURLs

public void printURLs(java.net.URL[] urls)

Prints the HTML pages given (in book form if possible)

Specified by:

printURLs in interface HTMLBrowser

Parameters:

urls - the URL[] to be printed

getHTMLContainer

public javax.swing.JPanel getHTMLContainer()

Returns an LWContainer containing the HTMLBrowser if possible, null otherwise.

Specified by:

getHTMLContainer in interface HTMLBrowser

getCurrentRenderedSize

public java.awt.Dimension getCurrentRenderedSize()

Returns the size of the rendered document.

Specified by:

getCurrentRenderedSize in interface HTMLBrowser

addURLListener

public void addURLListener(oracle.help.htmlBrowser.URLListener listener)

Adds a url listener. All the registered URLListeners will be notified when the current page is replaced by a new page. This can happen when user selects a HTML link in the current page or when help requests HTMLBrowser to show a document.

Specified by:

addURLListener in interface HTMLBrowser

Parameters:

listener - URLListener to be added.

removeURLListener

public void removeURLListener(oracle.help.htmlBrowser.URLListener listener)

Removes a url listener.

Specified by:

removeURLListener in interface HTMLBrowser

Parameters:

listener - URLListener to be removed.

addPopupListener

public void addPopupListener(oracle.help.htmlBrowser.PopupListener listener)

Adds a popup listener. All the registered PopupListeners will be notified when user activates the popupTrigger. PopupTrigger is usually activated through right mouse click.

Specified by:

addPopupListener in interface HTMLBrowser

Parameters:

listener - PopupListener to be added

removePopupListener

public void removePopupListener(oracle.help.htmlBrowser.PopupListener listener)

Removes a popup listener.

Specified by:

removePopupListener in interface HTMLBrowser

Parameters:

listener - PopupListener to be removed.

runFindDialog

public void runFindDialog()

Runs the FindDialog via CTRL-F and Tools|Find menu seaches.

Specified by:

runFindDialog in interface HTMLBrowser

getCharset

public java.lang.String getCharset()

Gets the HTML character encoding. This is required for supporting internationalization in Help.

Specified by:

getCharset in interface HTMLBrowser

Returns:

HTML character encoding

setCharset

public void setCharset(java.lang.String charset)

Sets the character encoding to be used when loading URLs. This is required for supporting internationalization in Help.

Specified by:

setCharset in interface HTMLBrowser

Parameters:

charset - A java supported character encoding

getLocale

public java.util.Locale getLocale()

Gets the Locale set on the HTMLBrowser.

Specified by:

getLocale in interface HTMLBrowser

Overrides:

getLocale in class java.awt.Component

Returns:

HTML character encoding

setLocale

public void setLocale(java.util.Locale aLocale)

Sets the Locale on the HTMLBrowser, if possible.

Specified by:

setLocale in interface HTMLBrowser

Overrides:

setLocale in class java.awt.Component

Parameters:

charset - A java supported character encoding

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

PropertyChangeListener implementation to dispatch ChangeUrl events.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

e - The event for the property change

setDefaultBackground

public void setDefaultBackground(java.awt.Color bgcolor)

Sets the default background color for HTML pages. This is required for full support of window types.

Specified by:

setDefaultBackground in interface HTMLBrowser

Parameters:

bgcolor - The new default background color

setDefaultTextForeground

public void setDefaultTextForeground(java.awt.Color textfg)

Sets the default foreground color for plain text on HTML pages. This is required for full support of window types.

Specified by:

setDefaultTextForeground in interface HTMLBrowser

Parameters:

textfg - The new default text foreground color

setDefaultLinkForeground

public void setDefaultLinkForeground(java.awt.Color linkfg)

Sets the default foreground color for links on HTML pages. This is required for full support of window types.

Specified by:

setDefaultLinkForeground in interface HTMLBrowser

Parameters:

linkfg - The new default link foreground color

addProtocolListener

public void addProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener)

Adds a ProtocolListener. All the registered listeners will be notified when a special protocol link is clicked on in the HTML browser.

Specified by:

addProtocolListener in interface HTMLBrowser

Parameters:

listener - ProtocolListener to be added.

removeProtocolListener

public void removeProtocolListener(oracle.help.htmlBrowser.ProtocolListener listener)

Removes a ProtocolListener.

Specified by:

removeProtocolListener in interface HTMLBrowser

Parameters:

listener - Listener to be removed.

canGoBack

public boolean canGoBack()

Determines whether it is possible to move backward

Specified by:

canGoBack in interface HTMLBrowser

Returns:

true if possible; false otherwise;

goBack

public void goBack()

Goes back

Specified by:

goBack in interface HTMLBrowser

canGoForward

public boolean canGoForward()

Determines whether it is possible to move forward in the stack.

Specified by:

canGoForward in interface HTMLBrowser

Returns:

true if possible; false otherwise;

goForward

public void goForward()

Goes forward in the stack.

Specified by:

goForward in interface HTMLBrowser

getSelectedText

public java.lang.String getSelectedText()

Gets the text highlighted in the TopicDisplay

Specified by:

getSelectedText in interface HTMLBrowser

increaseFontSize

public void increaseFontSize()

Increases the font size used by the TopicDisplay

Specified by:

increaseFontSize in interface HTMLBrowser

decreaseFontSize

public void decreaseFontSize()

Decreases the font size used by the TopicDisplay

Specified by:

decreaseFontSize in interface HTMLBrowser

selectAll

public void selectAll()

Selects all the text in the browser window

Specified by:

selectAll in interface HTMLBrowser

getCurrentPageTitle

public java.lang.String getCurrentPageTitle()

Returns the title of the page currently viewed in the browser

Specified by:

getCurrentPageTitle in interface HTMLBrowser

dispose

public void dispose()

Disposes HTMLBrowser resources

Specified by:

dispose in interface HTMLBrowser