com.physpics.tools.ui

Class HTMLPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JEditorPane

javax.swing.JTextPane

com.physpics.tools.ui.HTMLPane

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

public class HTMLPane
extends javax.swing.JTextPane

Support for embedding components in an HTMLDocument. This Component has poor sizing behavior when embedded in a JPanel. Better is within a scroller:

        TryHTMLPane testPane = new TryHTMLPane();
        final JFrame f = new JFrame();
        JScrollPane scroller = new JScrollPane(testPane,
             ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED,
             ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
        );
        f.add(scroller);

The relationships of the HTMLxxxx objects is JComponents are embedded in documents using the syntax described with the Embed class. Frozen images of the components can be created as described with the ImageSaver class. Footnotes are written as described with method postProcess. There is no good way in HTMLDocument to just change an attribute. This class's method setElementAttribute() does just that.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLPane.ChoiceDiv
static class	HTMLPane.ChoiceGroup A document may be displayed piecemeal; nominally each piece corresponds to a tab in the view, but other organizations will also be used.

Nested classes/interfaces inherited from class javax.swing.JEditorPane

javax.swing.JEditorPane.AccessibleJEditorPane, javax.swing.JEditorPane.AccessibleJEditorPaneHTML, javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIDDEN
static java.lang.String	HTMLPLUS

Fields inherited from class javax.swing.JEditorPane

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
HTMLPane() Create an empty HTMLPane.

Method Summary

Modifier and Type	Method and Description
static HTMLPane	create(java.lang.String html, HTMLPage.EmbedListener embedEar) Produce an HTMLPane viewing a String.An EmbedListener may be supplied to process embedded elements.
void	dumpElementTree(javax.swing.text.Element elt, java.lang.String indent) Dump an element and children to stdout.
void	dumpElementTree(javax.swing.text.Element elt, java.lang.String indent, java.lang.String fileName) Dump an element and children to a named file.
static void	dumpHTML(java.lang.String fileName, javax.swing.text.Element elt)
static void	dumpViews(Writer f, javax.swing.text.View v, java.lang.String indent) Write a view tree to a Writer.
static void	dumpViewTree(java.lang.String fileName, javax.swing.text.View v) Write view tree to to file.
static void	dumpViewTree(javax.swing.text.View v) Write view tree to stdout
java.awt.Dimension	getPreferredSize()
boolean	getScrollableTracksViewportWidth()
java.lang.String	getToolTipText(java.awt.event.MouseEvent evt) Change title attributes into tooltips.
boolean	loadDocument(java.lang.Class<?> aClass, java.lang.String locator) Shortcut for loadDocument with a third argument of null.
boolean	loadDocument(java.lang.Class<?> aClass, java.lang.String locator, java.net.URL base) Load the document of the given JEditorPane from a webpage at a given locator (ala IOUtils.getInputStream).
boolean	loadDocument(java.lang.String locator) Load the document from a webpage at a given locator (ala IOUtils.getInputStream).
void	loadDocumentFromStream(InputStream src) Load an HTML document from an InputStream.
void	loadDocumentFromString(java.lang.String s)
void	setPreferredSize(java.awt.Dimension d)

Methods inherited from class javax.swing.JTextPane

addStyle, createDefaultEditorKit, getCharacterAttributes, getInputAttributes, getLogicalStyle, getParagraphAttributes, getStyle, getStyledDocument, getStyledEditorKit, getUIClassID, insertComponent, insertIcon, paramString, removeStyle, replaceSelection, setCharacterAttributes, setDocument, setEditorKit, setLogicalStyle, setParagraphAttributes, setStyledDocument

Methods inherited from class javax.swing.JEditorPane

addHyperlinkListener, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getScrollableTracksViewportHeight, getStream, getText, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

HTMLPLUS

public static final java.lang.String HTMLPLUS

See Also:

Constant Field Values

HIDDEN

public static final java.lang.String HIDDEN

See Also:

Constant Field Values

Constructor Detail

HTMLPane

public HTMLPane()

Create an empty HTMLPane. Contents cen be provided with the inherited setText method, or one of the loadDocument methods.

Method Detail

loadDocument

public boolean loadDocument(java.lang.String locator)

Load the document from a webpage at a given locator (ala IOUtils.getInputStream). The locator must not be a "resource:" or "jardir:"; for these see the three argument loadDocument.

Parameters:

locator - a locator identifying the document to be loaded

Returns:

true only if loading succeeded

loadDocument

public boolean loadDocument(java.lang.Class<?> aClass,
                            java.lang.String locator)

Shortcut for loadDocument with a third argument of null.

Parameters:

aClass - the Class for the application; its ClassLoader will be applied to resolve "resource:" and "jardir:" locators.

locator - name of the document to be loaded (ala IOUtils.getInputStream).

Returns:

true only if loading succeeded

loadDocument

public boolean loadDocument(java.lang.Class<?> aClass,
                            java.lang.String locator,
                            java.net.URL base)

Load the document of the given JEditorPane from a webpage at a given locator (ala IOUtils.getInputStream).

Parameters:

aClass - the Class for the application; its ClassLoader will be applied to resolve "resource:" and "jardir:" locators.

locator - name of the document to be loaded (ala IOUtils.getInputStream).

base - base URL for resolving relative references in the document. This value will be overridden if the document has a <base> element.

Returns:

true only if loading succeeded

loadDocumentFromStream

public void loadDocumentFromStream(InputStream src)
                            throws IOException

Load an HTML document from an InputStream. The <base> is not set; it may have been set in the document or as in the three-argument loadDocument.

Parameters:

src - the document source text.

Throws:

IOException - if reading fails TODO switch to HTMLEditorKit.read. It can read strings and read incrementally.

loadDocumentFromString

public void loadDocumentFromString(java.lang.String s)
                            throws IOException

Throws:

IOException

create

public static HTMLPane create(java.lang.String html,
                              HTMLPage.EmbedListener embedEar)
                       throws IOException

Produce an HTMLPane viewing a String.An EmbedListener may be supplied to process embedded elements.

Parameters:

html - the html to display reading the source and creating the contents of the pane. This function may apply setWidthOfBody (below).

embedEar - an HTMLPage.EmbedListener to be applied while reading the html into the page. May be null.

Returns:

the created HTMLPane

Throws:

IOException - for IO error

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Specified by:

getScrollableTracksViewportWidth in interface javax.swing.Scrollable

Overrides:

getScrollableTracksViewportWidth in class javax.swing.JEditorPane

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent evt)

Change title attributes into tooltips. Newlines as entities &#xA; have been converted to \n; these are further converted to <br>.

Overrides:

getToolTipText in class javax.swing.text.JTextComponent

Parameters:

evt - a mouse event

Returns:

the tooltip text, converted as necessary

dumpElementTree

public void dumpElementTree(javax.swing.text.Element elt,
                            java.lang.String indent)
                     throws IOException,
                            javax.swing.text.BadLocationException

Dump an element and children to stdout. Calls the three-argument dumpElementTree.

Parameters:

elt - the Element to dump

indent - One instance of this is prepended to a line for each level of nesting.

Throws:

IOException - for error

javax.swing.text.BadLocationException - cannot happen

dumpElementTree

public void dumpElementTree(javax.swing.text.Element elt,
                            java.lang.String indent,
                            java.lang.String fileName)

Dump an element and children to a named file. For each element there is a prefix of the content string and location within stream and in view rectangle.

Parameters:

elt - the Element to dump

indent - line prefix one for each level of nesting

fileName - where to write the output

dumpHTML

public static void dumpHTML(java.lang.String fileName,
                            javax.swing.text.Element elt)

dumpViewTree

public static void dumpViewTree(java.lang.String fileName,
                                javax.swing.text.View v)

Write view tree to to file.

Parameters:

fileName - File name

v - top level view in the tree

dumpViewTree

public static void dumpViewTree(javax.swing.text.View v)

Write view tree to stdout

Parameters:

v - top level view in the tree

dumpViews

public static void dumpViews(Writer f,
                             javax.swing.text.View v,
                             java.lang.String indent)
                      throws IOException

Write a view tree to a Writer.

Parameters:

f - The destination.

v - The parent view.

indent - Prefix to lines. Three spaces are appended for each level of depth.

Throws:

IOException - If writing to f throws and exception

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JEditorPane

setPreferredSize

public void setPreferredSize(java.awt.Dimension d)

Overrides:

setPreferredSize in class javax.swing.JComponent