com.physpics.tools.ui

Class HTMLDocPlus

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.DefaultStyledDocument

javax.swing.text.html.HTMLDocument

com.physpics.tools.ui.HTMLDocPlus

All Implemented Interfaces:

Serializable, javax.swing.text.Document, javax.swing.text.StyledDocument

Deprecated.

Use instead HTMLPage HTMLPane HTMLKit and Embed The relationships of the objects of HTMLDocPlus is diagrammed as <img src="doc-files/HTMLDocPlusObjects.png" width="561" height="436" slt="Relations among the HTMLDocPlus objects"> 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 HTMLDEocument to just change an attribute. This class's method setElementAttribute() does just that.

public class HTMLDocPlus
extends javax.swing.text.html.HTMLDocument

Support for embedding an application in an HTMLDocument.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLDocPlus.ChoiceDiv Deprecated.
static class	HTMLDocPlus.ChoiceGroup Deprecated. A document may be displayed piecemeal; nominally each piece corresponds to a tab in the view, but other organizations will also be used.
static class	HTMLDocPlus.Embed Deprecated. Manage a user input object embedded in a document.
static class	HTMLDocPlus.EmbedAbstractButton Deprecated. An Embed that manages a button.
static class	HTMLDocPlus.EmbedButton Deprecated. Embed JButton.
static class	HTMLDocPlus.EmbedCheckBox Deprecated. An Embed that manages a JCheckBox.
static class	HTMLDocPlus.EmbedComboBox Deprecated. An Embed that manages a JComboBox
static class	HTMLDocPlus.EmbedFilename Deprecated. Embed a JTextField AND an associated button to raise a JFileChooser.
static class	HTMLDocPlus.EmbedLabel Deprecated. An Embed that manages a JLabel.
static class	HTMLDocPlus.EmbedList Deprecated. An Embed that manages a JList.
static class	HTMLDocPlus.EmbedListener Deprecated.
static class	HTMLDocPlus.EmbedRadioButton Deprecated. An Embed that manages a JRadioButton.
static class	HTMLDocPlus.EmbedTextComponent Deprecated. An Embed that manages a JTextField or a JTextArea.
static class	HTMLDocPlus.HTMLEdKitPlus Deprecated.
static class	HTMLDocPlus.HTMLFactoryPlus Deprecated.

Nested classes/interfaces inherited from class javax.swing.text.html.HTMLDocument

javax.swing.text.html.HTMLDocument.BlockElement, javax.swing.text.html.HTMLDocument.HTMLReader, javax.swing.text.html.HTMLDocument.Iterator, javax.swing.text.html.HTMLDocument.RunElement

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

javax.swing.text.DefaultStyledDocument.AttributeUndoableEdit, javax.swing.text.DefaultStyledDocument.ElementBuffer, javax.swing.text.DefaultStyledDocument.ElementSpec, javax.swing.text.DefaultStyledDocument.SectionElement

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

javax.swing.text.AbstractDocument.AbstractElement, javax.swing.text.AbstractDocument.AttributeContext, javax.swing.text.AbstractDocument.BranchElement, javax.swing.text.AbstractDocument.Content, javax.swing.text.AbstractDocument.DefaultDocumentEvent, javax.swing.text.AbstractDocument.ElementEdit, javax.swing.text.AbstractDocument.LeafElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIDDEN Deprecated.
static java.lang.String	HTMLPLUS Deprecated.
static java.lang.String	NL Deprecated.
static java.lang.String	RTFPLUS Deprecated.
static java.lang.String	TEXTPLUS Deprecated.

Fields inherited from class javax.swing.text.html.HTMLDocument

AdditionalComments

Fields inherited from class javax.swing.text.DefaultStyledDocument

buffer, BUFFER_SIZE_DEFAULT

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor and Description
HTMLDocPlus() Deprecated. Clone of the no-arg constructor for HTMLDocument.
HTMLDocPlus(javax.swing.text.AbstractDocument.Content c, javax.swing.text.html.StyleSheet styles) Deprecated. Clone of the two-arg constructor for HTMLDocument.
HTMLDocPlus(javax.swing.text.html.StyleSheet styles) Deprecated. Clone of the one-arg constructor for HTMLDocument.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener act) Deprecated. Add a listener for ActionEvents.
void	addEmbedListener(HTMLDocPlus.EmbedListener el) Deprecated.
static void	copyElement(javax.swing.text.html.HTMLDocument.BlockElement src, javax.swing.text.html.HTMLDocument.BlockElement dest) Deprecated. Copy one element to another.
static void	dumpElementTree(java.lang.String fileName, javax.swing.text.Element elt, javax.swing.JEditorPane jed) Deprecated. Dump an element and children to a named file.
static void	dumpHTML(java.lang.String fileName, javax.swing.text.Element elt) Deprecated.
static void	dumpViews(Writer f, javax.swing.text.View v, java.lang.String indent) Deprecated. Write a view tree to a Writer.
static void	dumpViewTree(java.lang.String fileName, javax.swing.text.View v) Deprecated. Write view tree to to file.
void	extractChoices() Deprecated. Remove and save the DIVs that are children of DIVs with attribute choicegroup="groupname" attribute.
protected void	fireActionListeners(java.awt.event.ActionEvent aev) Deprecated.
java.util.ArrayList<java.awt.event.ActionListener>	getActionListeners() Deprecated.
static int	getAttrInt(javax.swing.text.AttributeSet attrs, java.lang.Object name) Deprecated. Find a named attribute and convert its value to an int.
static java.lang.String	getAttrString(javax.swing.text.AttributeSet attrs, java.lang.Object name) Deprecated.
HTMLDocPlus.ChoiceGroup	getChoiceGroup(java.lang.String name) Deprecated.
java.util.HashMap<java.lang.String,HTMLDocPlus.ChoiceGroup>	getChoiceTable() Deprecated.
java.lang.String	getColor(int dot) Deprecated.
HTMLDocPlus.Embed	getEmbed(java.lang.String id) Deprecated.
java.util.ArrayList<HTMLDocPlus.EmbedListener>	getEmbedListeners() Deprecated.
java.util.Collection<HTMLDocPlus.Embed>	getEmbeds() Deprecated.
javax.swing.text.html.HTMLEditorKit.ParserCallback	getReader(int pos) Deprecated.
javax.swing.text.html.HTMLEditorKit.ParserCallback	getReader(int pos, int popDepth, int pushDepth, javax.swing.text.html.HTML.Tag insertTag) Deprecated.
static java.awt.Rectangle	getViewRectangle(javax.swing.text.Element e, javax.swing.text.JTextComponent txt) Deprecated. Compute the union of all visible Rectangles of this element and its descendants.
static void	loadDocument(javax.swing.JEditorPane jed, java.lang.Class aClass, java.lang.String locator, java.net.URL base) Deprecated. Load the document of the given JEditorPane from a webpage at a given locator (IOUtils.getInputStream).
static void	loadDocument(javax.swing.JEditorPane jed, java.lang.String locator) Deprecated. Load the document of the given JEditorPane from a webpage at a given locator (IOUtils.getInputStream).
static void	loadDocumentFromStream(javax.swing.JEditorPane jed, InputStream src) Deprecated. Load an HTML document from an InputStream.
void	nbsp(javax.swing.text.html.HTMLDocument.BlockElement e) Deprecated. replace the contents of an element with a single
HTMLDocPlus.Embed	registerEmbed(java.lang.String enm, HTMLDocPlus.Embed e) Deprecated.
void	removeActionListener(java.awt.event.ActionListener act) Deprecated.
void	removeEmbedListener(HTMLDocPlus.EmbedListener el) Deprecated.
void	setElementAttribute(javax.swing.text.Element elt, java.lang.Object key, java.lang.Object val) Deprecated. Sets an attribute for an HTMLDocument's Element.
static void	setType(javax.swing.JEditorPane jedp) Deprecated. to make jEditorPane actually create an HTMLDocPlus.

Methods inherited from class javax.swing.text.html.HTMLDocument

create, createBranchElement, createDefaultRoot, createLeafElement, fireChangedUpdate, fireUndoableEditUpdate, getBase, getElement, getElement, getIterator, getParser, getPreservesUnknownTags, getStyleSheet, getTokenThreshold, insert, insertAfterEnd, insertAfterStart, insertBeforeEnd, insertBeforeStart, insertUpdate, processHTMLFrameHyperlinkEvent, setBase, setInnerHTML, setOuterHTML, setParagraphAttributes, setParser, setPreservesUnknownTags, setTokenThreshold

Methods inherited from class javax.swing.text.DefaultStyledDocument

addDocumentListener, addStyle, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, getStyleNames, removeDocumentListener, removeElement, removeStyle, removeUpdate, setCharacterAttributes, setLogicalStyle, styleChanged

Methods inherited from class javax.swing.text.AbstractDocument

addUndoableEditListener, createPosition, dump, fireInsertUpdate, fireRemoveUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.text.Document

addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render

Field Detail

HTMLPLUS

public static final java.lang.String HTMLPLUS

Deprecated.

See Also:

Constant Field Values

TEXTPLUS

public static final java.lang.String TEXTPLUS

Deprecated.

See Also:

Constant Field Values

RTFPLUS

public static final java.lang.String RTFPLUS

Deprecated.

See Also:

Constant Field Values

HIDDEN

public static final java.lang.String HIDDEN

Deprecated.

See Also:

Constant Field Values

NL

public static final java.lang.String NL

Deprecated.

Constructor Detail

HTMLDocPlus

public HTMLDocPlus()

Deprecated.

Clone of the no-arg constructor for HTMLDocument. It provides empty Content and StyleSheet.

HTMLDocPlus

public HTMLDocPlus(javax.swing.text.html.StyleSheet styles)

Deprecated.

Clone of the one-arg constructor for HTMLDocument. It provides empty Content.

Parameters:

styles - The StyleSheet to be used.

HTMLDocPlus

public HTMLDocPlus(javax.swing.text.AbstractDocument.Content c,
                   javax.swing.text.html.StyleSheet styles)

Deprecated.

Clone of the two-arg constructor for HTMLDocument.

Parameters:

c - Contents for the document; may have HTML markup

styles - The StyleSheet to be used.

Method Detail

getEmbeds

public java.util.Collection<HTMLDocPlus.Embed> getEmbeds()

Deprecated.

registerEmbed

public HTMLDocPlus.Embed registerEmbed(java.lang.String enm,
                                       HTMLDocPlus.Embed e)

Deprecated.

getEmbed

public HTMLDocPlus.Embed getEmbed(java.lang.String id)

Deprecated.

getEmbedListeners

public java.util.ArrayList<HTMLDocPlus.EmbedListener> getEmbedListeners()

Deprecated.

addEmbedListener

public void addEmbedListener(HTMLDocPlus.EmbedListener el)

Deprecated.

removeEmbedListener

public void removeEmbedListener(HTMLDocPlus.EmbedListener el)

Deprecated.

getActionListeners

public java.util.ArrayList<java.awt.event.ActionListener> getActionListeners()

Deprecated.

addActionListener

public void addActionListener(java.awt.event.ActionListener act)

Deprecated.

Add a listener for ActionEvents. The event will have an Embed as its source. Usually the Event will have occurred on that Embed's JComponent. If the Embed is for a JList, it is of type EmbedList and the ListSelectionEvent is available from getLatestEvent.

Parameters:

act - the listener object whose ActionPerformed is to be called

removeActionListener

public void removeActionListener(java.awt.event.ActionListener act)

Deprecated.

fireActionListeners

protected void fireActionListeners(java.awt.event.ActionEvent aev)

Deprecated.

getReader

public javax.swing.text.html.HTMLEditorKit.ParserCallback getReader(int pos)

Deprecated.

Overrides:

getReader in class javax.swing.text.html.HTMLDocument

getReader

public javax.swing.text.html.HTMLEditorKit.ParserCallback getReader(int pos,
                                                                    int popDepth,
                                                                    int pushDepth,
                                                                    javax.swing.text.html.HTML.Tag insertTag)

Deprecated.

Overrides:

getReader in class javax.swing.text.html.HTMLDocument

loadDocument

public static void loadDocument(javax.swing.JEditorPane jed,
                                java.lang.String locator)

Deprecated.

Load the document of the given JEditorPane from a webpage at a given locator (IOUtils.getInputStream). The locator must not be a "resource:" or "jardir:"; for these see the four argument loadDocument. If webpage elements have references to relative locations, the webpage should have a <base> element.

Parameters:

jed - The JEditorPane whose getDocument will be loaded into

locator - a locator identifying the document to be loaded

loadDocument

public static void loadDocument(javax.swing.JEditorPane jed,
                                java.lang.Class aClass,
                                java.lang.String locator,
                                java.net.URL base)

Deprecated.

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

Parameters:

jed - The JEditorPane whose getDocument will be loaded into

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

locator - a locator identifying the document to be loaded

base - base URL for resolving relative references in the document

loadDocumentFromStream

public static void loadDocumentFromStream(javax.swing.JEditorPane jed,
                                          InputStream src)
                                   throws IOException

Deprecated.

Load an HTML document from an InputStream.

Parameters:

jed - The editor into which to do the load. The method sets the type to .html with a call to HTMLDocPlus.setType(jed).

src - the document source.

Throws:

IOException - for input error

getChoiceGroup

public HTMLDocPlus.ChoiceGroup getChoiceGroup(java.lang.String name)

Deprecated.

getChoiceTable

public java.util.HashMap<java.lang.String,HTMLDocPlus.ChoiceGroup> getChoiceTable()

Deprecated.

extractChoices

public void extractChoices()

Deprecated.

Remove and save the DIVs that are children of DIVs with attribute choicegroup="groupname" attribute. Sadly, HTMLdocument has attributes inherit. Therefore, only the first encountered choicegroup of a given name will be processed.

nbsp

public void nbsp(javax.swing.text.html.HTMLDocument.BlockElement e)

Deprecated.

replace the contents of an element with a single

Parameters:

e - The BlockElement to eviscerate

getViewRectangle

public static java.awt.Rectangle getViewRectangle(javax.swing.text.Element e,
                                                  javax.swing.text.JTextComponent txt)
                                           throws javax.swing.text.BadLocationException

Deprecated.

Compute the union of all visible Rectangles of this element and its descendants. This should be pointless, but is necessary for footnotes. Maybe insertBefore is messing up.

Parameters:

e - the Element

txt - the View

Returns:

a rectangle within the document view that is the union of the rectangles for elt and all its descendants.

Throws:

javax.swing.text.BadLocationException - for java.swing error

setElementAttribute

public void setElementAttribute(javax.swing.text.Element elt,
                                java.lang.Object key,
                                java.lang.Object val)

Deprecated.

Sets an attribute for an HTMLDocument's Element. If the val parameter is null, the attribute is removed.

This method is thread safe.

Parameters:

elt - an Element in an HTMLDocument

key - the attribute key. Usually this should be HTML.Attribute.xxx

val - the value. For HTML.Attribute.xxx, the value is a String. // Most ways to set color fail: // CSS.Attribute.BACKGROUND_COLOR, // doc.getStyleSheet().stringToColor("#ffff66")); // // HTML.Attribute.STYLE, "background-color: #ffff66"); // // // addAttribute fails because set is immutable // dl.addAttribute(HTML.Attribute.BGCOLOR, // doc.getStyleSheet().stringToColor("#FFFF66")); // // // setParagraphAttributes does get color, // // but only behind the text, not the full column // SimpleAttributeSet attrset = new SimpleAttributeSet(); // attrset.addAttribute(HTML.Attribute.BGCOLOR, "#FFFF66"); // doc.setParagraphAttributes(start, end-start-1, // attrset, false);

getColor

public java.lang.String getColor(int dot)

Deprecated.

getAttrString

public static java.lang.String getAttrString(javax.swing.text.AttributeSet attrs,
                                             java.lang.Object name)

Deprecated.

getAttrInt

public static int getAttrInt(javax.swing.text.AttributeSet attrs,
                             java.lang.Object name)

Deprecated.

Find a named attribute and convert its value to an int.

Parameters:

attrs - An AttributeSet of attributes

name - Name of an attribute that could be in the set.

Returns:

The int value of the attribute. Return -999 if the attribute is absent or not an integer.

setType

public static void setType(javax.swing.JEditorPane jedp)

Deprecated.

to make jEditorPane actually create an HTMLDocPlus.

Parameters:

jedp - The JEditorPane to be made to use HTMLDocPlus.

dumpElementTree

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

Deprecated.

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:

fileName - where to write the output

elt - the Element to dump

jed - the Text component that maps from model to view

dumpHTML

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

Deprecated.

dumpViewTree

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

Deprecated.

Write view tree to to file.

Parameters:

fileName - File name

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

Deprecated.

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

copyElement

public static void copyElement(javax.swing.text.html.HTMLDocument.BlockElement src,
                               javax.swing.text.html.HTMLDocument.BlockElement dest)

Deprecated.

Copy one element to another. In practice, the two elements are in two different HTMLDocuments. The prior contents of the destination element are replaced. HTMLDocument.replace() does nothing with the document text. Hence the text is first inserted in its entirety and then the structure of elements referring to it is constructed.

Parameters:

src - a BlockElement to be copied, including its document text

dest - another BlockElement; its contents are to be replaced with the copy