Class MaisDocContentWriter

java.lang.Object

org.x4o.sax3.SAX3WriterEnum<SAX3WriterHtml.Tag, SAX3WriterXml>

org.x4o.sax3.SAX3WriterHtml

org.x4o.maisdoc.flake.MaisDocContentWriter

All Implemented Interfaces:

Closeable, AutoCloseable, SAX3WriterEnumHammer<SAX3WriterHtml.Tag>

public class MaisDocContentWriter
extends SAX3WriterHtml

ContentWriterHtml Writes eld/java documentation in html.

Version:

1.0 Apr 30, 2013

Author:

Willem Cazander

Nested Class Summary

Nested classes/interfaces inherited from class SAX3WriterHtml

SAX3WriterHtml.DocType, SAX3WriterHtml.Tag

Constructor Summary

Constructors

Constructor	Description
MaisDocContentWriter(Writer out, String encoding)

Method Summary

Modifier and Type	Method	Description
void	docCommentGenerated()
void	docHtmlEnd(String copyright, String statsJS)
void	docHtmlStart(String title, List<String> keywords, String pathPrefix)
void	docNavBarAbout(String about)
void	docPageBlockEnd()
void	docPageBlockNext()
void	docPageBlockStart()
void	docPageBlockStart(String title, String namedLink, String comment)
void	docPageClassEnd()
void	docPageClassStart(String title, String subTitle, SAX3WriterHtml.Tag titleTag)
ContentCloseable	docPageContent()
void	docPageContentEnd()
void	docPageContentStart()
void	docPagePackageDescription(String title, String summary, String description)
void	docPagePackageTitle(String title, String summary)
ContentCloseable	docTable(String tableTitle, String tableDescription, MaisDocContentCss tableCss)
void	docTableEnd()
void	docTableHeader(String titleFirst, String titleLast)
ContentCloseable	docTableRow()
void	docTableRow(String dataFirst, String dataLast)
void	docTableRow(String dataFirst, String dataLast, String dataBlock)
void	docTableRowLastEnd()
void	docTableRowLastStart(String dataFirst, String dataFirstHref)
void	docTableRowLink(String dataFirstHref, String dataFirst, String dataLast)
void	docTableStart(String tableTitle, String tableDescription, MaisDocContentCss tableCss)
static String	toSafeUri(String uri)
static String	toSafeUri(String... paths)
static String	toSafeUri(List<String> paths)

Methods inherited from class SAX3WriterHtml

getPropertyConfig, printDocType, printHeadLinkCss, printHeadMeta, printHeadMetaContentType, printHeadMetaDate, printHeadTitle, printHref, printHref, printHref, printHrefNamed, printHrefTarget, printHtmlEnd, printHtmlStart, printScriptInline, printScriptNoDiv, printScriptNoDiv, printScriptSrc, printTag, printTag, printTag, printTag, printTag, printTagCharacters, printTagCharacters, printTagStart, printTagStart, printTagStart, printTagStart, printTagStart

Methods inherited from class SAX3WriterEnum

close, endDocument, getContentWriterWrapped, getTagNamespaceUri, printCharacters, printComment, printTag, printTag, printTagCharacters, printTagEnd, printTagStart, printTagStart, printTagStartEnd, printTagStartEnd, startDocument

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MaisDocContentWriter

public MaisDocContentWriter(Writer out,
 String encoding)

Method Details

docCommentGenerated

public void docCommentGenerated()
                         throws IOException

Throws:

IOException

docHtmlStart

public void docHtmlStart(String title,
 List<String> keywords,
 String pathPrefix)
                  throws IOException

Throws:

IOException

docHtmlEnd

public void docHtmlEnd(String copyright,
 String statsJS)
                throws IOException

Throws:

IOException

docNavBarAbout

public void docNavBarAbout(String about)
                    throws IOException

Throws:

IOException

docPagePackageTitle

public void docPagePackageTitle(String title,
 String summary)
                         throws IOException

Throws:

IOException

docPagePackageDescription

public void docPagePackageDescription(String title,
 String summary,
 String description)
                               throws IOException

Throws:

IOException

docPageClassStart

public void docPageClassStart(String title,
 String subTitle,
 SAX3WriterHtml.Tag titleTag)
                       throws IOException

Throws:

IOException

docPageClassEnd

public void docPageClassEnd()
                     throws IOException

Throws:

IOException

docPageContent

public ContentCloseable docPageContent()
                                throws IOException

Throws:

IOException

docPageContentStart

public void docPageContentStart()
                         throws IOException

Throws:

IOException

docPageContentEnd

public void docPageContentEnd()
                       throws IOException

Throws:

IOException

docPageBlockStart

public void docPageBlockStart(String title,
 String namedLink,
 String comment)
                       throws IOException

Throws:

IOException

docPageBlockStart

public void docPageBlockStart()
                       throws IOException

Throws:

IOException

docPageBlockEnd

public void docPageBlockEnd()
                     throws IOException

Throws:

IOException

docPageBlockNext

public void docPageBlockNext()
                      throws IOException

Throws:

IOException

docTable

public ContentCloseable docTable(String tableTitle,
 String tableDescription,
 MaisDocContentCss tableCss)
                          throws IOException

Throws:

IOException

docTableStart

public void docTableStart(String tableTitle,
 String tableDescription,
 MaisDocContentCss tableCss)
                   throws IOException

Throws:

IOException

docTableEnd

public void docTableEnd()
                 throws IOException

Throws:

IOException

docTableHeader

public void docTableHeader(String titleFirst,
 String titleLast)
                    throws IOException

Throws:

IOException

docTableRowLink

public void docTableRowLink(String dataFirstHref,
 String dataFirst,
 String dataLast)
                     throws IOException

Throws:

IOException

docTableRow

public void docTableRow(String dataFirst,
 String dataLast)
                 throws IOException

Throws:

IOException

docTableRow

public void docTableRow(String dataFirst,
 String dataLast,
 String dataBlock)
                 throws IOException

Throws:

IOException

docTableRowLastStart

public void docTableRowLastStart(String dataFirst,
 String dataFirstHref)
                          throws IOException

Throws:

IOException

docTableRowLastEnd

public void docTableRowLastEnd()
                        throws IOException

Throws:

IOException

docTableRow

public ContentCloseable docTableRow()
                             throws IOException

Throws:

IOException

toSafeUri

public static String toSafeUri(List<String> paths)

toSafeUri

public static String toSafeUri(String... paths)

toSafeUri

public static String toSafeUri(String uri)