HTMLDocument.HTMLReader JDK 1.6)

Description

public class HTMLDocument.HTMLReader

An HTML reader to load an HTML document with an HTML element structure.

An HTML reader to load an HTML document with an HTML element structure. This is a set of callbacks from the parser, implemented to create a set of elements tagged with attributes. The parse builds up tokens (ElementSpec) that describe the element subtree desired, and burst it into the document under the protection of a write lock using the insert method on the document outer class.

The reader can be configured by registering actions (of type HTMLDocument.HTMLReader.TagAction) that describe how to handle the action. The idea behind the actions provided is that the most natural text editing operations can be provided if the element structure boils down to paragraphs with runs of some kind of style in them. Some things are more naturally specified structurally, so arbitrary structure should be allowed above the paragraphs, but will need to be edited with structural actions. The implication of this is that some of the HTML elements specified in the stream being parsed will be collapsed into attributes, and in some cases paragraphs will be synthesized. When HTML elements have been converted to attributes, the attribute key will be of type HTML.Tag, and the value will be of type AttributeSet so that no information is lost. This enables many of the existing actions to work so that the user can type input, hit the return key, backspace, delete, etc and have a reasonable result. Selections can be created, and attributes applied or removed, etc. With this in mind, the work done by the reader can be categorized into the following kinds of tasks:

Block: Build the structure like it's specified in the stream. This produces elements that contain other elements.
Paragraph: Like block except that it's expected that the element will be used with a paragraph view so a paragraph element won't need to be synthesized.
Character: Contribute the element as an attribute that will start and stop at arbitrary text locations. This will ultimately be mixed into a run of text, with all of the currently flattened HTML character elements.
Special: Produce an embedded graphical element.
Form: Produce an element that is like the embedded graphical element, except that it also has a component model associated with it.
Hidden: Create an element that is hidden from view when the document is being viewed read-only, and visible when the document is being edited. This is useful to keep the model from losing information, and used to store things like comments and unrecognized tags.

Currently, <APPLET>, <PARAM>, <MAP>, <AREA>, <LINK>, <SCRIPT> and <STYLE> are unsupported.

The assignment of the actions described is shown in the following table for the tags defined in HTML.Tag.

Tag Action

HTML.Tag.A CharacterAction
HTML.Tag.ADDRESS CharacterAction
HTML.Tag.APPLET HiddenAction
HTML.Tag.AREA AreaAction
HTML.Tag.B CharacterAction
HTML.Tag.BASE BaseAction
HTML.Tag.BASEFONT CharacterAction
HTML.Tag.BIG CharacterAction
HTML.Tag.BLOCKQUOTE BlockAction
HTML.Tag.BODY BlockAction
HTML.Tag.BR SpecialAction
HTML.Tag.CAPTION BlockAction
HTML.Tag.CENTER BlockAction
HTML.Tag.CITE CharacterAction
HTML.Tag.CODE CharacterAction
HTML.Tag.DD BlockAction
HTML.Tag.DFN CharacterAction
HTML.Tag.DIR BlockAction
HTML.Tag.DIV BlockAction
HTML.Tag.DL BlockAction
HTML.Tag.DT ParagraphAction
HTML.Tag.EM CharacterAction
HTML.Tag.FONT CharacterAction
HTML.Tag.FORM As of 1.4 a BlockAction
HTML.Tag.FRAME SpecialAction
HTML.Tag.FRAMESET BlockAction
HTML.Tag.H1 ParagraphAction
HTML.Tag.H2 ParagraphAction
HTML.Tag.H3 ParagraphAction
HTML.Tag.H4 ParagraphAction
HTML.Tag.H5 ParagraphAction
HTML.Tag.H6 ParagraphAction
HTML.Tag.HEAD HeadAction
HTML.Tag.HR SpecialAction
HTML.Tag.HTML BlockAction
HTML.Tag.I CharacterAction
HTML.Tag.IMG SpecialAction
HTML.Tag.INPUT FormAction
HTML.Tag.ISINDEX IsndexAction
HTML.Tag.KBD CharacterAction
HTML.Tag.LI BlockAction
HTML.Tag.LINK LinkAction
HTML.Tag.MAP MapAction
HTML.Tag.MENU BlockAction
HTML.Tag.META MetaAction
HTML.Tag.NOFRAMES BlockAction
HTML.Tag.OBJECT SpecialAction
HTML.Tag.OL BlockAction
HTML.Tag.OPTION FormAction
HTML.Tag.P ParagraphAction
HTML.Tag.PARAM HiddenAction
HTML.Tag.PRE PreAction
HTML.Tag.SAMP CharacterAction
HTML.Tag.SCRIPT HiddenAction
HTML.Tag.SELECT FormAction
HTML.Tag.SMALL CharacterAction
HTML.Tag.STRIKE CharacterAction
HTML.Tag.S CharacterAction
HTML.Tag.STRONG CharacterAction
HTML.Tag.STYLE StyleAction
HTML.Tag.SUB CharacterAction
HTML.Tag.SUP CharacterAction
HTML.Tag.TABLE BlockAction
HTML.Tag.TD BlockAction
HTML.Tag.TEXTAREA FormAction
HTML.Tag.TH BlockAction
HTML.Tag.TITLE TitleAction
HTML.Tag.TR BlockAction
HTML.Tag.TT CharacterAction
HTML.Tag.U CharacterAction
HTML.Tag.UL BlockAction
HTML.Tag.VAR CharacterAction

Tag	Action
`HTML.Tag.A`	CharacterAction
`HTML.Tag.ADDRESS`	CharacterAction
`HTML.Tag.APPLET`	HiddenAction
`HTML.Tag.AREA`	AreaAction
`HTML.Tag.B`	CharacterAction
`HTML.Tag.BASE`	BaseAction
`HTML.Tag.BASEFONT`	CharacterAction
`HTML.Tag.BIG`	CharacterAction
`HTML.Tag.BLOCKQUOTE`	BlockAction
`HTML.Tag.BODY`	BlockAction
`HTML.Tag.BR`	SpecialAction
`HTML.Tag.CAPTION`	BlockAction
`HTML.Tag.CENTER`	BlockAction
`HTML.Tag.CITE`	CharacterAction
`HTML.Tag.CODE`	CharacterAction
`HTML.Tag.DD`	BlockAction
`HTML.Tag.DFN`	CharacterAction
`HTML.Tag.DIR`	BlockAction
`HTML.Tag.DIV`	BlockAction
`HTML.Tag.DL`	BlockAction
`HTML.Tag.DT`	ParagraphAction
`HTML.Tag.EM`	CharacterAction
`HTML.Tag.FONT`	CharacterAction
`HTML.Tag.FORM`	As of 1.4 a BlockAction
`HTML.Tag.FRAME`	SpecialAction
`HTML.Tag.FRAMESET`	BlockAction
`HTML.Tag.H1`	ParagraphAction
`HTML.Tag.H2`	ParagraphAction
`HTML.Tag.H3`	ParagraphAction
`HTML.Tag.H4`	ParagraphAction
`HTML.Tag.H5`	ParagraphAction
`HTML.Tag.H6`	ParagraphAction
`HTML.Tag.HEAD`	HeadAction
`HTML.Tag.HR`	SpecialAction
`HTML.Tag.HTML`	BlockAction
`HTML.Tag.I`	CharacterAction
`HTML.Tag.IMG`	SpecialAction
`HTML.Tag.INPUT`	FormAction
`HTML.Tag.ISINDEX`	IsndexAction
`HTML.Tag.KBD`	CharacterAction
`HTML.Tag.LI`	BlockAction
`HTML.Tag.LINK`	LinkAction
`HTML.Tag.MAP`	MapAction
`HTML.Tag.MENU`	BlockAction
`HTML.Tag.META`	MetaAction
`HTML.Tag.NOFRAMES`	BlockAction
`HTML.Tag.OBJECT`	SpecialAction
`HTML.Tag.OL`	BlockAction
`HTML.Tag.OPTION`	FormAction
`HTML.Tag.P`	ParagraphAction
`HTML.Tag.PARAM`	HiddenAction
`HTML.Tag.PRE`	PreAction
`HTML.Tag.SAMP`	CharacterAction
`HTML.Tag.SCRIPT`	HiddenAction
`HTML.Tag.SELECT`	FormAction
`HTML.Tag.SMALL`	CharacterAction
`HTML.Tag.STRIKE`	CharacterAction
`HTML.Tag.S`	CharacterAction
`HTML.Tag.STRONG`	CharacterAction
`HTML.Tag.STYLE`	StyleAction
`HTML.Tag.SUB`	CharacterAction
`HTML.Tag.SUP`	CharacterAction
`HTML.Tag.TABLE`	BlockAction
`HTML.Tag.TD`	BlockAction
`HTML.Tag.TEXTAREA`	FormAction
`HTML.Tag.TH`	BlockAction
`HTML.Tag.TITLE`	TitleAction
`HTML.Tag.TR`	BlockAction
`HTML.Tag.TT`	CharacterAction
`HTML.Tag.U`	CharacterAction
`HTML.Tag.UL`	BlockAction
`HTML.Tag.VAR`	CharacterAction

Once </html> is encountered, the Actions are no longer notified.

See also:

Methods

Hide/Show inherited methods

protected void addContent (char[] data, int offs, int length)

Adds some text with the current character attributes.

protected void addContent (char[] data, int offs, int length, boolean generateImpliedPIfNecessary)

Adds some text with the current character attributes.

pack-private void addCSSRules (String rules)

Adds the CSS rules in rules.

protected void addSpecialElement (Tag t, MutableAttributeSet a)

Adds content that is basically specified entirely in the attribute set.

protected void blockClose (Tag t)

Adds an instruction to the parse buffer to close out a block element of the given type.

protected void blockOpen (Tag t, MutableAttributeSet attr)

Adds an instruction to the parse buffer to create a block element with the given attributes.

public void flush () throws BadLocationException [Overrides HTMLEditorKit.ParserCallback]

The last method called on the reader.

pack-private void flushBuffer (boolean endOfStream) throws BadLocationException

Flushes the current parse buffer into the document.

public void handleComment (char[] data, int pos) [Overrides HTMLEditorKit.ParserCallback]

public void handleEndOfLineString (String eol) [Overrides HTMLEditorKit.ParserCallback]

This is invoked after the stream has been parsed, but before flush.

This is invoked after the stream has been parsed, but before
flush. eol will be one of \n, \r
or \r\n, which ever is encountered the most in parsing the
stream.
Since: 1.3

public void handleEndTag (Tag t, int pos) [Overrides HTMLEditorKit.ParserCallback]

Callback from the parser.

public void handleError (String errorMsg, int pos) [Inherited From HTMLEditorKit.ParserCallback]

public void handleSimpleTag (Tag t, MutableAttributeSet a, int pos) [Overrides HTMLEditorKit.ParserCallback]

Callback from the parser.

public void handleStartTag (Tag t, MutableAttributeSet a, int pos) [Overrides HTMLEditorKit.ParserCallback]

Callback from the parser.

public void handleText (char[] data, int pos) [Overrides HTMLEditorKit.ParserCallback]

Called by the parser to indicate a block of text was encountered.

pack-private void linkCSSStyleSheet (String href)

Adds the CSS stylesheet at href to the known list of stylesheets.

protected void popCharacterStyle ()

Pops a previously pushed character style off the stack to return to a previous style.

protected void preContent (char[] data)

Adds the given content that was encountered in a PRE element.

protected void pushCharacterStyle ()

Pushes the current character style on a stack in preparation for forming a new nested character style.

protected void registerTag (Tag t, TagAction a)

Registers a handler for the given tag.

protected void textAreaContent (char[] data)

Adds the given content to the textarea document.

Fields

Hide/Show inherited fields

protected MutableAttributeSet charAttr

pack-private Stack charAttrStack

pack-private String defaultStyle

Name of style to use.

pack-private boolean emptyAnchor

pack-private boolean emptyDocument

True if inserting into an empty document.

pack-private boolean foundInsertTag

Set to true when insertTag has been found.

publicfinalstatic Object IMPLIED [Inherited From HTMLEditorKit.ParserCallback]

This is passed as an attribute in the attributeset to indicate the element is implied eg, the string '<>foo<\t>' contains an implied html element and an implied body element.

pack-private boolean impliedP

pack-private int inBlock

pack-private boolean inBody

True when the body has been encountered.

pack-private boolean inHead

True if inside the head tag.

pack-private boolean inParagraph

pack-private boolean inPre

pack-private boolean insertInsertTag

If true, the insertTag is inserted, otherwise elements after the insertTag is found are inserted.

pack-private Tag insertTag

If non null, gives parent Tag that insert is to happen at.

pack-private int insertTagDepthDelta

When foundInsertTag is set to true, this will be updated to reflect the delta between the two structures.

pack-private boolean inStyle

Set to true when a style element is encountered.

pack-private boolean inTextArea

pack-private boolean inTitle

pack-private boolean isStyleCSS

Set to true if the style language is text/css.

pack-private Map lastMap

Last Map that was encountered.

pack-private boolean lastWasNewline

pack-private boolean midInsert

True if (!emptyDocument && insertTag == null), this is used so much it is cached.

pack-private int offset

pack-private Option option

Current option, if in an option element (needed to load the label.

protected Vector<ElementSpec> parseBuffer

pack-private int popDepth

How many parents to ascend before insert new elements.

pack-private int pushDepth

How many parents to descend (relative to popDepth) before inserting.

pack-private AttributeSet styleAttributes

Attributes from a style Attribute.

pack-private Vector styles

Vector describing styles that should be include.

pack-private Hashtable tagMap

pack-private TextAreaDocument textAreaDocument

pack-private int threshold