com.finalist.jaggenerator
Class HtmlContentPopUp

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      com.finalist.jaggenerator.HtmlContentPopUp

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class HtmlContentPopUp

extends javax.swing.JDialog

A general purpose popup window for displaying hyperlinked HTML pages. The window may be initialised with either a URL or with a String containing HTML (but a HtmlContentPopUp initialised with a String does not support hyperlinks).

The HtmlContentPopup allows hyperlinks to be followed and maintains a page history, which is navigatable with a back and forward button. The back and forward buttons also may be triggered by the familiar keyboard shortcuts (Backspace or ALT-left_arrow for 'back', and ALT+right_arrow for 'forward'), and the popup may be dismissed with the ESCAPE key.

The page history maintained by this component includes scrollbar position information. For example if you hyperlink to document#2 from the end of document#1, and then navigate back to document#1: you will find yourself back at the very same place in document#1 where you left it (the end, in this case).

Any hyperlinked URLs that end in !!!EXTERNAL!!! (HtmlContentPopup.EXTERNAL_TAG) will attempt to launch the link in an external browser - this is defaulted to Internet Explorer (sorry!).

Author:

Michael O'Connor - Finalist IT Group

See Also:

Serialized Form

Nested Class Summary

(package private) class

HtmlContentPopUp.Bookmark

Nested classes inherited from class javax.swing.JDialog

javax.swing.JDialog.AccessibleJDialog

Nested classes inherited from class java.awt.Dialog

java.awt.Dialog.AccessibleAWTDialog

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	RET_CANCEL A return status code - returned if Cancel button has been pressed
static int	RET_OK A return status code - returned if OK button has been pressed

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

Fields inherited from class java.awt.Window

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS

Constructor Summary

HtmlContentPopUp(java.awt.Frame parent, java.lang.String title, boolean modal, java.lang.String html)
Creates new form HtmlAboutPopUp with the specified content.

HtmlContentPopUp(java.awt.Frame parent, java.lang.String title, boolean modal, java.lang.String html, boolean navigation)
Creates new form HtmlAboutPopUp with the specified content.

HtmlContentPopUp(java.awt.Frame parent, java.lang.String title, boolean modal, java.net.URL url)
Creates new form HtmlAboutPopUp with a specified URL.

Method Summary

java.lang.String	getExternalBrowserCommand()
int	getReturnStatus()
void	setExternalBrowserCommand(java.lang.String externalBrowserCommand)

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Dialog

addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

RET_CANCEL

public static final int RET_CANCEL

A return status code - returned if Cancel button has been pressed

See Also:

Constant Field Values

RET_OK

public static final int RET_OK

A return status code - returned if OK button has been pressed

See Also:

Constant Field Values

Constructor Detail

HtmlContentPopUp

public HtmlContentPopUp(java.awt.Frame parent,
                        java.lang.String title,
                        boolean modal,
                        java.lang.String html,
                        boolean navigation)

Creates new form HtmlAboutPopUp with the specified content.

Parameters:

parent - the parent frame.

title - the title for the popup.

modal - whether or not the popup is modal.

html - the HTML content for the popup.

navigation - set to true if 'back' and 'forward' navigation buttons are required.

HtmlContentPopUp

public HtmlContentPopUp(java.awt.Frame parent,
                        java.lang.String title,
                        boolean modal,
                        java.lang.String html)

Creates new form HtmlAboutPopUp with the specified content.

Parameters:

parent - the parent frame.

title - the title for the popup.

modal - whether or not the popup is modal.

html - the HTML content for the popup.

HtmlContentPopUp

public HtmlContentPopUp(java.awt.Frame parent,
                        java.lang.String title,
                        boolean modal,
                        java.net.URL url)

Creates new form HtmlAboutPopUp with a specified URL.

Parameters:

parent - the parent frame.

title - the title for the popup.

modal - whether or not the popup is modal.

url - the URL of the HTML content.

Method Detail

getReturnStatus

public int getReturnStatus()

Returns:

the return status of this dialog - one of RET_OK or RET_CANCEL

getExternalBrowserCommand

public java.lang.String getExternalBrowserCommand()

setExternalBrowserCommand

public void setExternalBrowserCommand(java.lang.String externalBrowserCommand)