Chapter 31. The javax.swing.text.html Package

BlockView	Java 1.2
javax.swing.text.html

This View implementation displays HTML block elements and can handle CSS attributes for those elements.

Hierarchy: Object-->View(SwingConstants)-->CompositeView-->BoxView-->BlockView

Subclasses: ListView

CSS	Java 1.2
javax.swing.text.html

This class defines an inner class that is used to represent Cascading Style Sheet (CSS) attributes in an AttributeSet. It also defines static methods that return all defined CSS attribute objects and allow you to look up a CSS attribute object by name.

CSS.Attribute	Java 1.2
javax.swing.text.html

Instances of this class are used as key values in an AttributeSet to represent CSS attributes. Each CSS.Attribute object supports getDefaultValue() and isInherited() methods that return more information about the attribute. In addition, the toString() method returns the name of the attribute. The CSS.Attribute class is final and does not have a public constructor, so it cannot be instantiated or subclassed. However, it defines constant object values for each of the CSS attributes specified by the CSS specification.

Returned By: CSS.{getAllAttributeKeys(), getAttribute()}

Type Of: Too many fields to list.

FormView	Java 1.2
javax.swing.text.html

This View displays <INPUT>, <SELECT>, and <TEXTAREA> elements within an HTML <FORM>.

Hierarchy: Object-->View(SwingConstants)-->ComponentView-->FormView(java.awt.event.ActionListener(java.util.EventListener))

FormView.MouseEventListener	Java 1.2
javax.swing.text.html

This class is used internally by FormView to handle clicks on HTML <INPUT> tags that have the TYPE=image attribute specified.

HTML	Java 1.2
javax.swing.text.html

This class defines inner classes that are used to represent HTML tags and attributes. It also defines several static convenience methods that are used with the inner classes. In particular, getAttributeKey() and getTag() look up HTML.Attribute and HTML.Tag values by name.

HTML.Attribute	Java 1.2
javax.swing.text.html

This class defines a number of constant instances of itself to represent HTML attributes. The class has no public constructor and is final, so new attribute objects cannot be created by instantiation or subclassing.

Passed To: HTML.getIntegerAttributeValue()

Returned By: HTML.{getAllAttributeKeys(), getAttributeKey()}

Type Of: Too many fields to list.

HTML.Tag	Java 1.2
javax.swing.text.html

This class defines constant instances of itself that represent HTML tags. The breaksFlow(), isBlock(), and isPreformatted() methods return additional information about the basic behavior of each tag. HTML.Tag defines constants for all of the standard HTML tags. It can be subclassed to add support for custom tags used with a customized HTML parser.

Subclasses: HTML.UnknownTag

Passed To: Too many methods to list.

Returned By: HTML.{getAllTags(), getTag()}, HTMLDocument.Iterator.getTag(), javax.swing.text.html.parser.TagElement.getHTMLTag()

Type Of: Too many fields to list.

HTML.UnknownTag	Java 1.2
javax.swing.text.html	serializable

This HTML.Tag subclass is used to represent nonstandard tags that the HTML parser does not recognize.

HTMLDocument	Java 1.2
javax.swing.text.html	serializable

This class represents an HTML document, optionally augmented with CSS style sheets. The document is composed of a tree of BlockElement and RunElement objects, each of which has an HTML.Tag object specified as the value of its StyleContext.NameAttribute attribute. setBase() specifies a base URL relative to which hyperlinks in the document are interpreted. setTokenThreshold() specifies how many parsed tokens should be parsed before they are inserted into the document. setPreservesUnknownTags() specifies whether unknown tags in a document should be saved in the document structure or discarded. If you are not writing the document back out, they usually can be discarded. getStyleSheet() returns a StyleSheet object that represents any CSS style sheet that appeared in the document itself. getIterator() returns an HTMLDocument.Iterator object that can be used to find all tags of a given type in the document. The getReader() methods return an HTMLDocument.HTMLReader object that converts method calls from the HTML parser into document elements. Subclasses that want to perform customized HTML parsing should override these methods to return an appropriately customized subclass of HTMLReader.

Hierarchy: Object-->AbstractDocument(Document,Serializable)-->DefaultStyledDocument(StyledDocument(Document))-->HTMLDocument

Passed To: HTMLEditorKit.insertHTML(), HTMLEditorKit.HTMLTextAction.{elementCountToTag(), findElementMatchingTag(), getElementsAt()}, HTMLEditorKit.InsertHTMLTextAction.{insertAtBoundry(), insertHTML()}, HTMLWriter.HTMLWriter()

Returned By: HTMLEditorKit.HTMLTextAction.getHTMLDocument()

HTMLDocument.BlockElement	Java 1.2
javax.swing.text.html	serializable

This class is used to represent block elements (i.e., elements that contain other elements) of an HTML document.

HTMLDocument.HTMLReader	Java 1.2
javax.swing.text.html

This class implements the HTMLEditorKit.ParserCallback interface and serves as an adapter between the HTML parser of the javax.swing.text.html.parser package and the HTMLDocument class. The parser invokes methods of the HTMLReader object, and the HTMLReader is responsible for converting those methods into content in the HTMLDocument. This class defines a number of inner classes of type HTMLDocument.HTMLReader.TagAction. These classes define special code to be executed when the parser encounters particular start and end tags. HTMLDocument.HTMLReader subclasses can perform customized HTML parsing by defining new TagAction subclasses and associating them with specific HTML tags by calling registerTag().

HTMLDocument.HTMLReader.BlockAction	Java 1.2
javax.swing.text.html

This TagAction handles blocks, such as <TD> and <DIV> tags.

Subclasses: HTMLDocument.HTMLReader.ParagraphAction, HTMLDocument.HTMLReader.PreAction

HTMLDocument.HTMLReader.CharacterAction	Java 1.2
javax.swing.text.html

This TagAction handles character elements, such as <B> and <FONT> tags.

HTMLDocument.HTMLReader.FormAction	Java 1.2
javax.swing.text.html

This TagAction handles form elements, such as <INPUT> and <SELECT> tags.

HTMLDocument.HTMLReader.HiddenAction	Java 1.2
javax.swing.text.html

This TagAction handles elements that have no visual appearance, such as <LINK> and <MAP> tags.

HTMLDocument.HTMLReader.IsindexAction	Java 1.2
javax.swing.text.html

This TagAction handles the <ISINDEX> tag.

HTMLDocument.HTMLReader.ParagraphAction	Java 1.2
javax.swing.text.html

This TagAction handles paragraph elements, such as <P> and <H1> tags.

HTMLDocument.HTMLReader.PreAction	Java 1.2
javax.swing.text.html

This TagAction handles the <PRE> tag.

HTMLDocument.HTMLReader.SpecialAction	Java 1.2
javax.swing.text.html

This TagAction handles elements that require special handling, such as <OBJECT> and <FRAME> tags.

Subclasses: HTMLDocument.HTMLReader.FormAction

HTMLDocument.HTMLReader.TagAction	Java 1.2
javax.swing.text.html

This class defines methods that are called when the HTML parser encounters start and end tags of a particular type. To customize HTML parsing, implement a subclass of TagAction, create an instance, and register it with an HTMLReader subclass by calling registerTag().

Subclasses: HTMLDocument.HTMLReader.BlockAction, HTMLDocument.HTMLReader.CharacterAction, HTMLDocument.HTMLReader.HiddenAction, HTMLDocument.HTMLReader.IsindexAction, HTMLDocument.HTMLReader.SpecialAction

Passed To: HTMLDocument.HTMLReader.registerTag()

HTMLDocument.Iterator	Java 1.2
javax.swing.text.html

This class is used to iterate through an HTMLDocument, returning only tags of a specified type. This class is abstract and cannot be instantiated. Call the getIterator() method of HTMLDocument to obtain an instance that returns all instances of a specified HTML.Tag. getAttributes(), getStartOffset(), and getEndOffset() return information about the current tag. next() moves the iterator to the next tag, and isValid() returns true if there is a current tag or false if there are no more tags.

Returned By: HTMLDocument.getIterator()

HTMLDocument.RunElement	Java 1.2
javax.swing.text.html	serializable

This class is used to represent content elements of an HTML document.

HTMLEditorKit	Java 1.2
javax.swing.text.html	cloneable serializable

This class is used to customize a JEditorPane component to display and edit HTML documents. Most applications need do nothing more than instantiate an HTMLEditorKit and pass it to the setEditorKit() method of a JEditorPane. The write() method converts the contents of an HTMLDocument into HTML text and writes it to the specified stream. The read() method parses HTML text from a stream and creates a corresponding element structure in the specified HTMLDocument. insertHTML() parses HTML text from a string and inserts it into the specified HTMLDocument.

You can customize the appearance of HTML text displayed using an HTMLEditorKit by passing a StyleSheet object to setStyleSheet(). Other customizations require you to subclass HTMLEditorKit and override some of its methods. Override getViewFactory() if you want to use customized View subclasses to display certain HTML document elements. Override createDefaultDocument() if you want to change the properties of the default HTMLDocument or if you want to return a subclass of HTMLDocument. Override getParser() if you want to use a custom HTML parser implementation, instead of the default parser implemented in javax.swing.text.html.parser.

Hierarchy: Object-->EditorKit(Cloneable,Serializable)-->DefaultEditorKit-->StyledEditorKit-->HTMLEditorKit

Returned By: HTMLEditorKit.HTMLTextAction.getHTMLEditorKit()

HTMLEditorKit.HTMLFactory	Java 1.2
javax.swing.text.html

This class is a ViewFactory for HTML documents. Its create() method returns a View object that is appropriate for the display of a given Element object. The View object is an instance of one of the View subclasses defined in this package.

HTMLEditorKit.HTMLTextAction	Java 1.2
javax.swing.text.html	cloneable serializable

This class is an abstract Action implementation that provides protected convenience methods that may be helpful to Action implementations that manipulate or edit an HTMLDocument.

Subclasses: HTMLEditorKit.InsertHTMLTextAction

HTMLEditorKit.InsertHTMLTextAction	Java 1.2
javax.swing.text.html	cloneable serializable

This Action implementation can be used to insert HTML text into an HTML document at the current location. You can create custom instances of this class and bind them to KeyStroke objects to provide custom editing actions for your users. When you create an InsertHTMLTextAction instance, you must specify the string of HTML text to be inserted and two HTML.Tag objects. The first HTML.Tag specifies the parent tag of the inserted text. For example, if the text you are inserting belongs in a paragraph element, you specify HTML.Tag.P. If the text you are inserting is a <DIV> or a <TABLE>, you specify HTML.Tag.BODY. The second HTML.Tag you must specify is the first tag of the parsed HTML string that is actually being inserted. For example, you may want to insert only a <TD> tag but may have to specify an HTML string that contains <TABLE> and <TR> tags so that the parser can correctly parse the HTML text. In this case, your second HTML.Tag argument is HTML.Tag.TD.

HTMLEditorKit.LinkController	Java 1.2
javax.swing.text.html	serializable

This class is a MouseAdapter that listens for mouse clicks and responds when the user clicks the mouse on a hyperlink. An instance of this class is installed on a JEditorPane by the install() method of the HTMLEditorKit.

HTMLEditorKit.Parser	Java 1.2
javax.swing.text.html

This is the abstract superclass of any class that wants to serve as an HTML parser for an HTMLEditorKit. The parse() method must read HTML text from the specified stream and convert the structure of the HTML text into a sequence of calls to the appropriate methods of the specified HTMLEditorKit.ParserCallback object. It is the responsibility of the ParserCallback object to initialize the HTMLDocument as appropriate in response to those method calls. If the ignoreCharSet argument is true, the parser ignores any HTML <META> tags that specify the document encoding. If this argument is false and the parser encounters such a tag, it should compare the document-specified encoding to the encoding used by the Reader stream from which it is reading. If the encodings do not match, it should throw a javax.swing.text.ChangedCharSetException.

Most applications can rely on the full-featured HTML parser provided by the javax.swing.text.html.parser package and do not need to subclass this class. The default parser is DTD-driven and can also be customized by providing a custom DTD. If you implement your own Parser subclass or customize the default parser, you must subclass HTMLEditorKit and override the getParser() method.

Subclasses: javax.swing.text.html.parser.ParserDelegator

Returned By: HTMLEditorKit.getParser()

HTMLEditorKit.ParserCallback	Java 1.2
javax.swing.text.html

This class defines the methods that are invoked by an HTMLEditorKit.Parser to describe the structure of an HTML document. The methods should be implemented to add appropriate content to an HTMLDocument. HTMLEditorKit uses an HTMLDocument.HTMLReader object as its default implementation of ParserCallback.

Subclasses: HTMLDocument.HTMLReader

Passed To: HTMLEditorKit.Parser.parse(), javax.swing.text.html.parser.DocumentParser.parse(), javax.swing.text.html.parser.ParserDelegator.parse()

Returned By: HTMLDocument.getReader()

HTMLFrameHyperlinkEvent	Java 1.2
javax.swing.text.html	serializable event

This class is an extension of HyperlinkEvent that is used when a hyperlink in one frame refers to another frame with an HTML TARGET attribute. getSourceElement() returns the Element object in the HTMLDocument that corresponds to the <FRAME> tag of the source frame. getTarget() returns a string that specifies the target frame. This may be a frame name or one of the standard special target names, "_self", "_parent", or "_top". The processHTMLFrameHyperlinkEvent() method of HTMLDocument can handle events of this type.

Hierarchy: Object-->java.util.EventObject(Serializable)-->javax.swing.event.HyperlinkEvent-->HTMLFrameHyperlinkEvent

Passed To: HTMLDocument.processHTMLFrameHyperlinkEvent()

HTMLWriter	Java 1.2
javax.swing.text.html

This class knows how to convert an HTMLDocument to textual form and write it to a specified stream. To use an HTMLWriter, simply pass an HTMLDocument and a Writer stream to the constructor, then call the public write() method. The various protected methods are used internally to output the document and can be overridden in a subclass to customize the HTML output process.

Hierarchy: Object-->AbstractWriter-->HTMLWriter

InlineView	Java 1.2
javax.swing.text.html

This View class displays styled text that appears in an HTML document. It extends javax.swing.text.LabelView to add support for CSS attributes.

Hierarchy: Object-->View(SwingConstants)-->LabelView-->InlineView

ListView	Java 1.2
javax.swing.text.html

This View class displays HTML list elements.

Hierarchy: Object-->View(SwingConstants)-->CompositeView-->BoxView-->BlockView-->ListView

MinimalHTMLWriter	Java 1.2
javax.swing.text.html

This class knows how to convert an arbitrary StyledDocument to simple HTML text. Its use is similar to the use of HTMLWriter. Because there is not an exact mapping between the character and paragraph attributes supported by StyledDocument objects and those defined by standard HTML tags and attributes, MinimalHTMLWriter relies heavily on CSS attributes in the HTML text it outputs.

Hierarchy: Object-->AbstractWriter-->MinimalHTMLWriter

ObjectView	Java 1.2
javax.swing.text.html

This View subclass dynamically loads, instantiates, and displays an arbitrary java.awt.Component object specified by the CLASSID attribute of an HTML <OBJECT> tag.

Hierarchy: Object-->View(SwingConstants)-->ComponentView-->ObjectView

Option	Java 1.2
javax.swing.text.html

This class is used internally by HTMLDocument to represent <OPTION> tags within a <SELECT> tag.

Passed To: HTMLWriter.writeOption()

ParagraphView	Java 1.2
javax.swing.text.html

This class displays HTML paragraph elements. It extends the javax.swing.text.ParagraphView class to add support for CSS attributes.

Hierarchy: Object-->View(SwingConstants)-->CompositeView-->BoxView-->javax.swing.text.ParagraphView(TabExpander)-->javax.swing.text.html.ParagraphView

StyleSheet	Java 1.2
javax.swing.text.html	serializable

This class is a StyleContext subclass that represents a CSS style sheet. In Java 1.2, it is only partially implemented. However, it can parse CSS style sheets with the loadRules() method. View objects are the primary user of this class. A View object calls getViewAttributes() to obtain an appropriate AttributeSet that takes all cascading styles into account to use when displaying itself.

StyleSheet also defines two inner classes that perform certain common drawing tasks for HTML View classes. The getBoxPainter() and getListPainter() methods return immutable (possibly shared and cached) instances of these inner classes that are suitable for drawing text boxes and list items for a given AttributeSet. Various View implementations use this cache for efficiency.

Hierarchy: Object-->StyleContext(AbstractDocument.AttributeContext,Serializable)-->StyleSheet

Passed To: HTMLDocument.HTMLDocument(), HTMLEditorKit.setStyleSheet()

Returned By: BlockView.getStyleSheet(), HTMLDocument.getStyleSheet(), HTMLEditorKit.getStyleSheet(), InlineView.getStyleSheet(), javax.swing.text.html.ParagraphView.getStyleSheet()

StyleSheet.BoxPainter	Java 1.2
javax.swing.text.html	serializable

This class knows how to display the CSS border and background box attributes of an HTML element. Various HTML View objects use this object to perform this drawing.

Returned By: StyleSheet.getBoxPainter()

StyleSheet.ListPainter	Java 1.2
javax.swing.text.html	serializable

This class knows how to display list bullets and numbers as specified by the various list-related CSS attributes. View objects responsible for displaying HTML lists delegate to this class to perform this drawing.

Returned By: StyleSheet.getListPainter()