Html2Txt (html2txt 1.0.1 API)

java.lang.Object
- de.unkrig.html2txt.Html2Txt

```
public class Html2Txt
extends Object
```
A converter that turns an HTML document into plain text, using spaces and various punctuation characters to format it.
One important restriction is that the HTML document must be "well-formed", i.e. all opening tags must be exactly matched by closing tags, i.e.:
```
 Let's <i>emphasize</i>.
 <ul>
   <li>List items</li>
   <li>must be terminated with "<tt>&lt;/li></tt>".
 </ul>
 <br />
 <hr />
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Html2Txt.BlockElementFormatter` Formats an HTML block element.
`static interface`	`Html2Txt.HtmlErrorHandler` Handles `Html2Txt.HtmlException`s.
`static class`	`Html2Txt.HtmlException` Representation of an exceptional condition that occurred during HTML processing.
`static class`	`Html2Txt.IndentingBlockElementFormatter` Formats a block `N` characters indented, relative to the enclosing block.
`static interface`	`Html2Txt.InlineElementFormatter` Formats an HTML inline element.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Map<String,Html2Txt.BlockElementFormatter>`	`ALL_BLOCK_ELEMENTS` Defines the strategies for formatting HTML block elements.
`protected static Map<String,Html2Txt.InlineElementFormatter>`	`ALL_INLINE_ELEMENTS` Defines the strategies for formatting HTML inline elements.
`protected static Html2Txt.BlockElementFormatter`	`OL_FORMATTER` Formatter for the "`<ol>`" ("ordered list") HTML block element.
`static Html2Txt.HtmlErrorHandler`	`SIMPLE_HTML_ERROR_HANDLER` All methods of theis `Html2Txt.HtmlErrorHandler` throw the `Html2Txt.HtmlException` they recieve.
`static ErrorHandler`	`SIMPLE_SAX_ERROR_HANDLER` All methods of this `ErrorHandler` throw the `SAXException` they recieve.
`protected static Html2Txt.BlockElementFormatter`	`TABLE_FORMATTER` Formatter for the "`<table>`" HTML block element.

Constructor Summary

Constructors
Constructor and Description

Html2Txt()

Constructors
Constructor and Description
`Html2Txt()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`html2txt(Document document, Writer output)` Generates a plain text document from the given HTML `document`, and writes it to the `output`.
`void`	`html2txt(File inputFile, File outputFile)` Reads, scans and parses the HTML document in the `inputFile`, generates a plain text document, and writes it to the `outputFile`.
`void`	`html2txt(File inputFile, Writer output)` Reads, scans and parses the HTML document in the `inputFile`, generates a plain text document, and writes it to the `output`.
`void`	`html2txt(Reader input, Writer output)` Reads, scans and parses the HTML document in the `inputFile`, generates a plain text document, and writes it to the `output`.
`static int`	`maxLength(Iterable<? extends CharSequence> css)`
`static de.unkrig.commons.lang.protocol.Producer<? extends String>`	`rightPad(de.unkrig.commons.lang.protocol.Producer<? extends CharSequence> delegate, int width, char c)` Wraps the given `delegate` such that it right-pads the products with `c` to the given `width`.
`static de.unkrig.commons.lang.protocol.Consumer<CharSequence>`	`rightTrim(de.unkrig.commons.lang.protocol.Consumer<? super String> delegate)` Creates and returns a `Consumer` that forwards its subjects to the `delegate`, with trailing spaces (`' '`) removed.
`Html2Txt`	`setErrorHandler(Html2Txt.HtmlErrorHandler htmlErrorHandler)` Sets a custom `Html2Txt.HtmlErrorHandler` on this object.
`void`	`setInputCharset(Charset cs)` Sets the charset to use when reading HTML input files.
`void`	`setOutputCharset(Charset cs)` Sets the charset to use when writing text input files.
`Html2Txt`	`setPageLeftMarginWidth(int pageLeftMarginWidth)` The number of spaces that preceeds each line of output; defaults to zero.
`Html2Txt`	`setPageRightMarginWidth(int pageRightMarginWidth)` The maximum length of output lines is "`pageWidth` - `rightMarginWidth`".
`Html2Txt`	`setPageWidth(int pageWidth)` The maximum length of output lines is "`pageWidth` - `rightMarginWidth`".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SIMPLE_SAX_ERROR_HANDLER
```
public static final ErrorHandler SIMPLE_SAX_ERROR_HANDLER
```
    All methods of this ErrorHandler throw the SAXException they recieve.
  - SIMPLE_HTML_ERROR_HANDLER
```
public static final Html2Txt.HtmlErrorHandler SIMPLE_HTML_ERROR_HANDLER
```
    All methods of theis Html2Txt.HtmlErrorHandler throw the Html2Txt.HtmlException they recieve.
  - OL_FORMATTER
```
protected static final Html2Txt.BlockElementFormatter OL_FORMATTER
```
    Formatter for the "<ol>" ("ordered list") HTML block element.
  - TABLE_FORMATTER
```
protected static final Html2Txt.BlockElementFormatter TABLE_FORMATTER
```
    Formatter for the "<table>" HTML block element.
  - ALL_BLOCK_ELEMENTS
```
protected static final Map<String,Html2Txt.BlockElementFormatter> ALL_BLOCK_ELEMENTS
```
    Defines the strategies for formatting HTML block elements.
    To see the HTML block elements and how they are formatted, click the word "ALL_BLOCK_ELEMENTS" (right above). The right hand side of the mapping means:
    
    NYI_BLOCK_ELEMENT_FORMATTER
    
    Issues a "Not yet implemented" warning.
    
    IGNORE_BLOCK_ELEMENT_FORMATTER
    
    The element is simply replaced with its content (a.k.a. "the element is ignored").
    
    new IndentingBlockElementFormatter(N)
    
    The block is formatted N characters indented, relative to the enclosing block.
    
    (Other)
    
    This HTML block element is formatted specially; see the respective field documentation on this page (e.g. OL_FORMATTER).
  - ALL_INLINE_ELEMENTS
```
protected static final Map<String,Html2Txt.InlineElementFormatter> ALL_INLINE_ELEMENTS
```
    Defines the strategies for formatting HTML inline elements.
    To see the HTML inline elements and how they are formatted, click the word "ALL_INLINE_ELEMENTS" (right above). The right hand side of the mapping means:
    
    NYI_INLINE_ELEMENT_FORMATTER
    
    Issues a "Not yet implemented" warning.
    
    IGNORE_INLINE_ELEMENT_FORMATTER
    
    The element is simply replaced with its content (a.k.a. "the element is ignored").
    
    new SimpleInlineElementFormatter("foo", "bar")
    
    The element is replaced with "foo", the element content, and "bar".
    
    (Other)
    
    This HTML inline element is formatted specially; see the respective field documentation on this page (e.g. A_FORMATTER).
- Constructor Detail
  - Html2Txt
```
public Html2Txt()
```
- Method Detail
  - setErrorHandler
```
public Html2Txt setErrorHandler(Html2Txt.HtmlErrorHandler htmlErrorHandler)
```
    Sets a custom Html2Txt.HtmlErrorHandler on this object. The default handler is SIMPLE_HTML_ERROR_HANDLER.
  - setPageLeftMarginWidth
```
public Html2Txt setPageLeftMarginWidth(int pageLeftMarginWidth)
```
    The number of spaces that preceeds each line of output; defaults to zero.
  - setPageRightMarginWidth
```
public Html2Txt setPageRightMarginWidth(int pageRightMarginWidth)
```
    The maximum length of output lines is "pageWidth - rightMarginWidth".
    Defaults to "1", to avoid extra line wraps on certain terminals.
    
    See Also:
    
    setPageWidth(int)
  - setInputCharset
```
public void setInputCharset(Charset cs)
```
    Sets the charset to use when reading HTML input files. Defaults to the JVM default charset.
  - setOutputCharset
```
public void setOutputCharset(Charset cs)
```
    Sets the charset to use when writing text input files. Defaults to the JVM default charset.
  - setPageWidth
```
public Html2Txt setPageWidth(int pageWidth)
```
    The maximum length of output lines is "pageWidth - rightMarginWidth".
    Defaults to the value of the environment variable "$COLUMNS", or, if that is not set, to 80.
    
    See Also:
    
    setPageRightMarginWidth(int)
  - html2txt
```
public void html2txt(File inputFile,
                     Writer output)
              throws ParserConfigurationException,
                     SAXException,
                     TransformerException,
                     Html2Txt.HtmlException
```
    Reads, scans and parses the HTML document in the inputFile, generates a plain text document, and writes it to the output.
    
    Throws:
    
    ParserConfigurationException
    
    SAXException
    
    TransformerException
    
    Html2Txt.HtmlException
  - html2txt
```
public void html2txt(Reader input,
                     Writer output)
              throws ParserConfigurationException,
                     SAXException,
                     TransformerException,
                     Html2Txt.HtmlException
```
    Reads, scans and parses the HTML document in the inputFile, generates a plain text document, and writes it to the output.
    
    Throws:
    
    ParserConfigurationException
    
    SAXException
    
    TransformerException
    
    Html2Txt.HtmlException
  - html2txt
```
public void html2txt(Document document,
                     Writer output)
              throws Html2Txt.HtmlException
```
    Generates a plain text document from the given HTML document, and writes it to the output.
    
    Throws:
    
    Html2Txt.HtmlException
  - html2txt
```
public void html2txt(File inputFile,
                     File outputFile)
              throws Exception
```
    Reads, scans and parses the HTML document in the inputFile, generates a plain text document, and writes it to the outputFile.
    
    Throws:
    
    Exception
  - maxLength
```
public static int maxLength(Iterable<? extends CharSequence> css)
```
    Returns:
    
    The length of the longest of the css, or 0 iff css is empty
  - rightPad
```
public static de.unkrig.commons.lang.protocol.Producer<? extends String> rightPad(de.unkrig.commons.lang.protocol.Producer<? extends CharSequence> delegate,
                                                                                  int width,
                                                                                  char c)
```
    Wraps the given delegate such that it right-pads the products with c to the given width.
  - rightTrim
```
public static de.unkrig.commons.lang.protocol.Consumer<CharSequence> rightTrim(de.unkrig.commons.lang.protocol.Consumer<? super String> delegate)
```
    Creates and returns a Consumer that forwards its subjects to the delegate, with trailing spaces (' ') removed.

Class Html2Txt

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIMPLE_SAX_ERROR_HANDLER

SIMPLE_HTML_ERROR_HANDLER

OL_FORMATTER

TABLE_FORMATTER

ALL_BLOCK_ELEMENTS

ALL_INLINE_ELEMENTS

Constructor Detail

Html2Txt

Method Detail

setErrorHandler

setPageLeftMarginWidth

setPageRightMarginWidth

setInputCharset

setOutputCharset

setPageWidth

html2txt

html2txt

html2txt

html2txt

maxLength

rightPad

rightTrim