public class

MinimalHTMLWriter

extends AbstractWriter
java.lang.Object
   ↳ javax.swing.text.AbstractWriter
     ↳ javax.swing.text.html.MinimalHTMLWriter

Class Overview

MinimalHTMLWriter is a fallback writer used by the HTMLEditorKit to write out HTML for a document that is a not produced by the EditorKit. The format for the document is: 

 <html>
   <head>
     <style>
        <!-- list of named styles
         p.normal {
            font-family: SansSerif;
            margin-height: 0;
            font-size: 14
         }
        -->
      </style>
   </head>
   <body>
    <p style=normal>
        Bold, italic, and underline attributes
        of the run are emitted as HTML tags.
        The remaining attributes are emitted as
        part of the style attribute of a <span> tag.
        The syntax is similar to inline styles.
    </p>
   </body>
 </html>

Summary

[Expand]
Inherited Constants
From class javax.swing.text.AbstractWriter
Public Constructors
MinimalHTMLWriter(Writer w, StyledDocument doc)
Creates a new MinimalHTMLWriter.
MinimalHTMLWriter(Writer w, StyledDocument doc, int pos, int len)
Creates a new MinimalHTMLWriter.
Public Methods
void write()
Generates HTML output from a StyledDocument.
Protected Methods
void endFontTag()
This is no longer used, instead <span> will be written out.
boolean inFontTag()
Returns true if we are currently in a <font> tag.
boolean isText(Element elem)
Returns true if the element is a text element.
void startFontTag(String style)
This is no longer used, instead <span> will be written out.
void text(Element elem)
Writes out text.
void writeAttributes(AttributeSet attr)
Writes out all the attributes for the following types: StyleConstants.ParagraphConstants, StyleConstants.CharacterConstants, StyleConstants.FontConstants, StyleConstants.ColorConstants.
void writeBody()
Iterates over the elements in the document and processes elements based on whether they are branch elements or leaf elements.
void writeComponent(Element elem)
Responsible for handling Component Elements; deliberately unimplemented.
void writeContent(Element elem, boolean needsIndenting)
Writes out the attribute set in an HTML-compliant manner.
void writeEndParagraph()
Emits an end tag for a <p> tag.
void writeEndTag(String endTag)
Writes out an end tag appropriately indented.
void writeHTMLTags(AttributeSet attr)
Generates bold <b>, italic <i>, and <u> tags for the text based on its attribute settings.
void writeHeader()
Writes out the <head> and <style> tags, and then invokes writeStyles() to write out all the named styles as the content of the <style> tag.
void writeImage(Element elem)
Responsible for handling Icon Elements; deliberately unimplemented.
void writeLeaf(Element elem)
Responsible for writing out other non-text leaf elements.
void writeNonHTMLAttributes(AttributeSet attr)
Writes out the remaining character-level attributes (attributes other than bold, italic, and underline) in an HTML-compliant way.
void writeStartParagraph(Element elem)
Emits the start tag for a paragraph.
void writeStartTag(String tag)
Writes out a start tag appropriately indented.
void writeStyles()
Writes out all the named styles as the content of the <style> tag.
[Expand]
Inherited Methods
From class javax.swing.text.AbstractWriter
From class java.lang.Object

Public Constructors

public MinimalHTMLWriter (Writer w, StyledDocument doc)

Creates a new MinimalHTMLWriter.

Parameters
w Writer
doc StyledDocument

public MinimalHTMLWriter (Writer w, StyledDocument doc, int pos, int len)

Creates a new MinimalHTMLWriter.

Parameters
w Writer
doc StyledDocument
pos The location in the document to fetch the content.
len The amount to write out.

Public Methods

public void write ()

Generates HTML output from a StyledDocument.

Throws
IOException on any I/O error
BadLocationException if pos represents an invalid location within the document.

Protected Methods

protected void endFontTag ()

This is no longer used, instead <span> will be written out.

Writes out an end tag for the <font> tag.

Throws
IOException on any I/O error

protected boolean inFontTag ()

Returns true if we are currently in a <font> tag.

protected boolean isText (Element elem)

Returns true if the element is a text element.

protected void startFontTag (String style)

This is no longer used, instead <span> will be written out.

Writes out a start tag for the <font> tag. Because font tags cannot be nested, this method closes out any enclosing font tag before writing out a new start tag.

Throws
IOException on any I/O error

protected void text (Element elem)

Writes out text.

Parameters
elem an Element.
Throws
IOException on any I/O error
BadLocationException

protected void writeAttributes (AttributeSet attr)

Writes out all the attributes for the following types: StyleConstants.ParagraphConstants, StyleConstants.CharacterConstants, StyleConstants.FontConstants, StyleConstants.ColorConstants. The attribute name and value are separated by a colon. Each pair is separated by a semicolon.

Parameters
attr an AttributeSet.
Throws
IOException on any I/O error

protected void writeBody ()

Iterates over the elements in the document and processes elements based on whether they are branch elements or leaf elements. This method specially handles leaf elements that are text.

Throws
IOException on any I/O error
BadLocationException

protected void writeComponent (Element elem)

Responsible for handling Component Elements; deliberately unimplemented. How this method is implemented is a matter of policy.

Throws
IOException

protected void writeContent (Element elem, boolean needsIndenting)

Writes out the attribute set in an HTML-compliant manner.

Throws
IOException on any I/O error
BadLocationException if pos represents an invalid location within the document.

protected void writeEndParagraph ()

Emits an end tag for a <p> tag. Before writing out the tag, this method ensures that all other tags that have been opened are appropriately closed off.

Throws
IOException on any I/O error

protected void writeEndTag (String endTag)

Writes out an end tag appropriately indented. Also decrements the indent level.

Throws
IOException on any I/O error

protected void writeHTMLTags (AttributeSet attr)

Generates bold <b>, italic <i>, and <u> tags for the text based on its attribute settings.

Throws
IOException on any I/O error

protected void writeHeader ()

Writes out the <head> and <style> tags, and then invokes writeStyles() to write out all the named styles as the content of the <style> tag. The content is surrounded by valid HTML comment markers to ensure that the document is viewable in applications/browsers that do not support the tag.

Throws
IOException on any I/O error

protected void writeImage (Element elem)

Responsible for handling Icon Elements; deliberately unimplemented. How to implement this method is an issue of policy. For example, if you're generating an <img> tag, how should you represent the src attribute (the location of the image)? In certain cases it could be a URL, in others it could be read from a stream.

Parameters
elem element of type StyleConstants.IconElementName
Throws
IOException

protected void writeLeaf (Element elem)

Responsible for writing out other non-text leaf elements.

Throws
IOException on any I/O error

protected void writeNonHTMLAttributes (AttributeSet attr)

Writes out the remaining character-level attributes (attributes other than bold, italic, and underline) in an HTML-compliant way. Given that attributes such as font family and font size have no direct mapping to HTML tags, a <span> tag is generated and its style attribute is set to contain the list of remaining attributes just like inline styles.

Throws
IOException on any I/O error

protected void writeStartParagraph (Element elem)

Emits the start tag for a paragraph. If the paragraph has a named style associated with it, then this method also generates a class attribute for the <p> tag and sets its value to be the name of the style.

Throws
IOException on any I/O error

protected void writeStartTag (String tag)

Writes out a start tag appropriately indented. Also increments the indent level.

Throws
IOException on any I/O error

protected void writeStyles ()

Writes out all the named styles as the content of the <style> tag.

Throws
IOException on any I/O error