org.x4o.xml.eld.doc.api

Class ApiDocContentWriter

java.lang.Object

org.x4o.xml.io.sax.ext.AbstractContentWriterHandler

org.x4o.xml.io.sax.ext.AbstractContentWriterLexical

org.x4o.xml.io.sax.ext.AbstractContentWriter

org.x4o.xml.io.sax.ext.ContentWriterXml

org.x4o.xml.io.sax.ext.ContentWriterXmlTag<ContentWriterHtml.Tag>

org.x4o.xml.io.sax.ext.ContentWriterHtml

org.x4o.xml.eld.doc.api.ApiDocContentWriter

All Implemented Interfaces:

ContentWriter, ContentWriterTag<ContentWriterHtml.Tag>, ContentHandler, LexicalHandler

public class ApiDocContentWriter
extends ContentWriterHtml

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 org.x4o.xml.io.sax.ext.ContentWriterHtml

ContentWriterHtml.DocType, ContentWriterHtml.Tag

Field Summary

Fields inherited from class org.x4o.xml.io.sax.ext.AbstractContentWriterLexical

printCDATA

Fields inherited from class org.x4o.xml.io.sax.ext.AbstractContentWriterHandler

EMPTY_ATTRIBUTES, encoding

Constructor Summary

Constructors

Constructor and Description
ApiDocContentWriter(Writer out, String encoding, String charNewLine, String charTab)

Method Summary

Methods

Modifier and Type	Method and Description
void	docCommentGenerated()
void	docHtmlEnd(org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig conf, String copyright)
void	docHtmlStart(org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig conf, String title, List<String> keywords)
void	docPageBlockEnd()
void	docPageBlockNext()
void	docPageBlockStart()
void	docPageBlockStart(String title, String namedLink, String comment)
void	docPageClassEnd()
void	docPageClassStart(String title, String subTitle)
void	docPageContentEnd()
void	docPageContentStart()
void	docPagePackageDescription(String title, String summary, String description)
void	docPagePackageTitle(String title, String summary)
void	docTableEnd()
void	docTableHeader(String titleFirst, String titleLast)
void	docTableRow(String dataFirst, String dataLast)
void	docTableRow(String dataFirst, String dataLast, String dataBlock)
void	docTableRowHref(String dataFirstHref, String dataFirst, String dataLast, String dataBlock)
void	docTableStart(String tableTitle, String tableDescription)
static String	toSafeUri(List<String> paths)
static String	toSafeUri(String... paths)
static String	toSafeUri(String uri)

Methods inherited from class org.x4o.xml.io.sax.ext.ContentWriterHtml

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

Methods inherited from class org.x4o.xml.io.sax.ext.ContentWriterXmlTag

getTagNamespaceUri, printTagCharacters, printTagEnd, printTagStart, printTagStart, printTagStartEnd, printTagStartEnd

Methods inherited from class org.x4o.xml.io.sax.ext.AbstractContentWriter

startElementEnd

Methods inherited from class org.x4o.xml.io.sax.ext.AbstractContentWriterLexical

characters, characters, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.x4o.xml.io.sax.ext.AbstractContentWriterHandler

autoCloseStartElement, characters, charactersRaw, closeWriter, closeWriterSafe, comment, comment, endDocument, endElement, endPrefixMapping, ignorableWhitespace, ignorableWhitespace, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startElementNamespace, startElementNamespaceAll, startElementTag, startPrefixMapping, writeFlush

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.x4o.xml.io.sax.ext.ContentWriter

characters, characters, comment, ignorableWhitespace, ignorableWhitespace, startElementEnd

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Constructor Detail

ApiDocContentWriter

public ApiDocContentWriter(Writer out,
                   String encoding,
                   String charNewLine,
                   String charTab)

Method Detail

docCommentGenerated

public void docCommentGenerated()
                         throws SAXException

Throws:

SAXException

docHtmlStart

public void docHtmlStart(org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig conf,
                String title,
                List<String> keywords)
                  throws SAXException

Throws:

SAXException

docHtmlEnd

public void docHtmlEnd(org.x4o.xml.eld.doc.api.ApiDocContentWriter.NavBarConfig conf,
              String copyright)
                throws SAXException

Throws:

SAXException

docPagePackageTitle

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

Throws:

SAXException

docPagePackageDescription

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

Throws:

SAXException

docPageClassStart

public void docPageClassStart(String title,
                     String subTitle)
                       throws SAXException

Throws:

SAXException

docPageClassEnd

public void docPageClassEnd()
                     throws SAXException

Throws:

SAXException

docPageContentStart

public void docPageContentStart()
                         throws SAXException

Throws:

SAXException

docPageContentEnd

public void docPageContentEnd()
                       throws SAXException

Throws:

SAXException

docPageBlockStart

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

Throws:

SAXException

docPageBlockStart

public void docPageBlockStart()
                       throws SAXException

Throws:

SAXException

docPageBlockEnd

public void docPageBlockEnd()
                     throws SAXException

Throws:

SAXException

docPageBlockNext

public void docPageBlockNext()
                      throws SAXException

Throws:

SAXException

docTableStart

public void docTableStart(String tableTitle,
                 String tableDescription)
                   throws SAXException

Throws:

SAXException

docTableEnd

public void docTableEnd()
                 throws SAXException

Throws:

SAXException

docTableHeader

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

Throws:

SAXException

docTableRow

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

Throws:

SAXException

docTableRow

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

Throws:

SAXException

docTableRowHref

public void docTableRowHref(String dataFirstHref,
                   String dataFirst,
                   String dataLast,
                   String dataBlock)
                     throws SAXException

Throws:

SAXException

toSafeUri

public static String toSafeUri(List<String> paths)

toSafeUri

public static String toSafeUri(String... paths)

toSafeUri

public static String toSafeUri(String uri)