javax.swing.text.html

Class HTMLEditorKit.ParserCallback

Enclosing Class:
HTMLEditorKit
Known Direct Subclasses:
HTMLDocument.HTMLReader

public static class HTMLEditorKit.ParserCallback
extends Object

The "hook" that receives all information about the HTML document structure while parsing it. The methods are invoked by parser and should be normally overridden.

Field Summary

static Object
IMPLIED
If the tag does not occurs in the html stream directly, but is supposed by parser, the tag attribute set contains this additional attribute, having value Boolean.True.

Constructor Summary

ParserCallback()
Constructor

Method Summary

void
flush()
The parser calls this method after it finishes parsing the document.
void
handleComment(char[] comment, int position)
Handle HTML comment, present in the given position.
void
handleEndOfLineString(String end_of_line)
Notifies about the character sequences, used to separate lines in this document.
void
handleEndTag(HTML.Tag tag, int position)
The method is called when the HTML closing tag ((like </table>) is found or if the parser concludes that the one should be present in the current position.
void
handleError(String message, int position)
Handle the error.
void
handleSimpleTag(HTML.Tag tag, MutableAttributeSet attributes, int position)
Handle the tag with no content, like <br>.
void
handleStartTag(HTML.Tag tag, MutableAttributeSet attributes, int position)
The method is called when the HTML opening tag ((like <table>) is found or if the parser concludes that the one should be present in the current position.
void
handleText(char[] text, int position)
Handle the text section.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

IMPLIED

public static final Object IMPLIED
If the tag does not occurs in the html stream directly, but is supposed by parser, the tag attribute set contains this additional attribute, having value Boolean.True.

Constructor Details

ParserCallback

public ParserCallback()
Constructor

Method Details

flush

public void flush()
            throws BadLocationException
The parser calls this method after it finishes parsing the document.

handleComment

public void handleComment(char[] comment,
                          int position)
Handle HTML comment, present in the given position.
Parameters:
comment - the comment

handleEndOfLineString

public void handleEndOfLineString(String end_of_line)
Notifies about the character sequences, used to separate lines in this document. The parser calls this method after it finishes parsing the document, but before flush().
Parameters:
end_of_line - The "end of line sequence", one of: \r or \n or \r\n.

handleEndTag

public void handleEndTag(HTML.Tag tag,
                         int position)
The method is called when the HTML closing tag ((like </table>) is found or if the parser concludes that the one should be present in the current position.
Parameters:
tag - The tag being handled
position - the tag position in the text being parsed.

handleError

public void handleError(String message,
                        int position)
Handle the error.
Parameters:
message - The message, explaining the error.
position - The starting position of the fragment that has caused the error in the html document being parsed.

handleSimpleTag

public void handleSimpleTag(HTML.Tag tag,
                            MutableAttributeSet attributes,
                            int position)
Handle the tag with no content, like <br>. The method is called for the elements that, in accordance with the current DTD, has an empty content.
Parameters:
tag - The tag being handled.
position - The tag position in the text being parsed.

handleStartTag

public void handleStartTag(HTML.Tag tag,
                           MutableAttributeSet attributes,
                           int position)
The method is called when the HTML opening tag ((like <table>) is found or if the parser concludes that the one should be present in the current position.
Parameters:
tag - The tag being handled
position - The tag position in the text being parsed

handleText

public void handleText(char[] text,
                       int position)
Handle the text section.
Parameters:
text - A section text.
position - The text position in the HTML document text being parsed.

HTMLEditorKit.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.