|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.maven.doxia.sink.SinkAdapter
org.apache.maven.doxia.sink.AbstractXmlSink
org.apache.maven.doxia.module.docbook.DocBookSink
A doxia Sink which produces a Docbook model.
| Field Summary | |
static String |
DEFAULT_SGML_PUBLIC_ID
DocBook V4.1 SGML public id: "-//OASIS//DTD DocBook V4.1//EN" |
static String |
DEFAULT_XML_PUBLIC_ID
DocBook XML V4.1.2 XML public id: "-//OASIS//DTD DocBook XML V4.1.2//EN" |
static String |
DEFAULT_XML_SYSTEM_ID
DocBook XML V4.0 XML system id: "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd" |
| Fields inherited from interface org.apache.maven.doxia.module.docbook.DocbookMarkup |
ANCHOR_TAG, ARABIC_STYLE, ARTICLE_TAG, ARTICLEINFO_TAG, BOOK_TAG, BOOKINFO_TAG, CHAPTER_TAG, COLS_ATTRIBUTE, COLSEP_ATTRIBUTE, COLSPEC_TAG, CORPAUTHOR_TAG, DATE_TAG, EMAIL_TAG, ENTRY_TAG, FIGURE_TAG, FILEREF_ATTRIBUTE, FORMALPARA_TAG, FORMAT_ATTRIBUTE, FRAME_ATTRIBUTE, IMAGEDATA_TAG, IMAGEOBJECT_TAG, INFO_TAG, INFORMALFIGURE_TAG, INFORMALTABLE_TAG, ITEMIZEDLIST_TAG, LINK_TAG, LINKEND_ATTRIBUTE, LISTITEM_TAG, LOWERALPHA_STYLE, LOWERROMAN_STYLE, MEDIAOBJECT_TAG, NUMERATION_ATTRIBUTE, ORDEREDLIST_TAG, PARA_TAG, PROGRAMLISTING_TAG, ROW_TAG, ROWSEP_ATTRIBUTE, SECTION_TAG, SIMPARA_TAG, TBODY_TAG, TERM_TAG, TGROUP_TAG, THEAD_TAG, ULINK_TAG, UPPERALPHA_STYLE, UPPERROMAN_STYLE, URL_ATTRIBUTE, URL_TAG, VARIABLELIST_TAG, VARLISTENTRY_TAG, XREF_TAG |
| Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup |
BANG, CDATA |
| Fields inherited from interface org.apache.maven.doxia.markup.Markup |
EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SLASH, SPACE, STAR |
| Fields inherited from interface org.apache.maven.doxia.sink.Sink |
NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5 |
| Constructor Summary | |
DocBookSink(Writer writer)
|
|
DocBookSink(Writer out,
boolean isBook)
|
|
| Method Summary | |
void |
anchor_()
|
void |
anchor(String name)
|
void |
author_()
|
void |
author()
|
void |
body_()
|
void |
bold_()
|
void |
bold()
|
void |
book_()
{@inheritDoc} |
void |
book()
{@inheritDoc} |
void |
close()
|
protected void |
content(String text)
Write SGML escaped text to output, not preserving white space. |
void |
date_()
|
void |
date()
|
void |
definedTerm_()
|
void |
definedTerm()
|
void |
definition_()
|
void |
definition()
|
void |
definitionList_()
|
void |
definitionList()
|
void |
definitionListItem_()
|
void |
definitionListItem()
|
static String |
escapeSGML(String text,
boolean xmlMode)
|
void |
figure_()
|
void |
figureCaption_()
|
void |
figureCaption()
|
void |
figureGraphics(String name)
|
void |
flush()
|
String |
getBoldElement()
Returns the current boldBeginTag. |
String |
getEncoding()
Returns the current encoding. |
String |
getHorizontalRuleElement()
Returns the current horizontalRuleElement. |
String |
getItalicElement()
Returns the current italicBeginTag. |
String |
getLanguage()
Returns the current language. |
String |
getLineBreakElement()
Returns the current lineBreakElement. |
String |
getMonospacedElement()
Returns the current monospacedBeginTag. |
String |
getPageBreakElement()
Returns the current pageBreakElement. |
String |
getPublicId()
Returns the current publicId. |
String |
getStyleSheet()
Returns the current styleSheet. |
String |
getSystemId()
Returns the current systemId. |
protected void |
graphicElement()
|
void |
head_()
|
void |
head()
|
void |
horizontalRule()
|
boolean |
isXMLMode()
Returns the current xmlMode. |
void |
italic_()
|
void |
italic()
|
void |
lineBreak()
|
void |
link_()
|
void |
link(String name)
|
void |
list_()
|
void |
list()
|
void |
listItem_()
|
void |
listItem()
|
protected void |
markup(String text)
Write text to output, preserving white space. |
void |
monospaced_()
|
void |
monospaced()
|
void |
nonBreakingSpace()
|
void |
numberedList_()
|
void |
numberedList(int numbering)
|
void |
numberedListItem_()
|
void |
numberedListItem()
|
void |
pageBreak()
|
void |
paragraph_()
|
void |
paragraph()
|
void |
section1_()
|
void |
section1()
|
void |
section2_()
|
void |
section2()
|
void |
section3_()
|
void |
section3()
|
void |
section4_()
|
void |
section4()
|
void |
section5_()
|
void |
section5()
|
void |
sectionTitle_()
|
void |
sectionTitle()
|
void |
setBoldElement(String tag)
Sets the current boldBeginTag and constructs the corresponding end tag from it. |
void |
setEncoding(String enc)
Sets the encoding. |
void |
setHorizontalRuleElement(String element)
Sets the current horizontalRuleElement. |
void |
setItalicElement(String tag)
Sets the current italicBeginTag and constructs the corresponding end tag from it. |
void |
setLanguage(String language)
Sets the language. |
void |
setLineBreakElement(String element)
Sets the current lineBreakElement. |
void |
setMonospacedElement(String tag)
Sets the current monospacedBeginTag and constructs the corresponding end tag from it. |
void |
setPageBreakElement(String element)
Sets the current pageBreakElement. |
void |
setPublicId(String id)
Sets the publicId. |
void |
setStyleSheet(String sheet)
Sets the styleSheet. |
void |
setSystemId(String id)
Sets the systemId. |
void |
setXMLMode(boolean mode)
Sets the xml mode. |
void |
table_()
|
void |
table()
|
void |
tableCaption_()
|
void |
tableCaption()
|
void |
tableCell_()
|
void |
tableCell()
|
void |
tableRow_()
|
void |
tableRow()
|
void |
tableRows_()
|
void |
tableRows(int[] justification,
boolean grid)
|
void |
text(String text)
|
void |
title_()
|
void |
title()
|
void |
verbatim_()
|
void |
verbatim(boolean boxed)
|
protected void |
verbatimContent(String text)
Write SGML escaped text to output, preserving white space. |
protected void |
write(String text)
|
| Methods inherited from class org.apache.maven.doxia.sink.AbstractXmlSink |
writeEndTag, writeEndTagWithoutEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag |
| Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
body, figure, rawText, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final String DEFAULT_SGML_PUBLIC_ID
public static final String DEFAULT_XML_PUBLIC_ID
public static final String DEFAULT_XML_SYSTEM_ID
| Constructor Detail |
public DocBookSink(Writer out,
boolean isBook)
public DocBookSink(Writer writer)
writer - the default writer.| Method Detail |
public static final String escapeSGML(String text,
boolean xmlMode)
text - The text to escape.xmlMode - xmlMode.
public void setXMLMode(boolean mode)
mode - the mode to set.public boolean isXMLMode()
public void setEncoding(String enc)
enc - the encoding to set.public String getEncoding()
public void setStyleSheet(String sheet)
sheet - the styleSheet to set.public String getStyleSheet()
public void setPublicId(String id)
id - the publicId to set.public String getPublicId()
public void setSystemId(String id)
id - the systemId to set.public String getSystemId()
public void setLanguage(String language)
language - the language to set.public String getLanguage()
public void setItalicElement(String tag)
tag - the tag to set. If tag is null, the empty string is used.public String getItalicElement()
public void setBoldElement(String tag)
tag - the tag to set. If tag is null, the empty string is used.public String getBoldElement()
public void setMonospacedElement(String tag)
tag - the tag to set. If tag is null, the empty string is used.public String getMonospacedElement()
public void setHorizontalRuleElement(String element)
element - the element to set.public String getHorizontalRuleElement()
public void setPageBreakElement(String element)
element - the element to set.public String getPageBreakElement()
public void setLineBreakElement(String element)
element - the element to set.public String getLineBreakElement()
public void head()
head in interface org.apache.maven.doxia.sink.SinkDEFAULT_XML_PUBLIC_ID,
DEFAULT_SGML_PUBLIC_ID,
DEFAULT_XML_SYSTEM_ID,
DocbookMarkup.ARTICLE_TAGpublic void head_()
head_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ARTICLEINFO_TAGpublic void title()
title in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ARTICLEINFO_TAG,
HTML.Tag.TITLEpublic void title_()
title_ in interface org.apache.maven.doxia.sink.SinkHTML.Tag.TITLEpublic void author()
author in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.CORPAUTHOR_TAGpublic void author_()
author_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.CORPAUTHOR_TAGpublic void date()
date in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.DATE_TAGpublic void date_()
date_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.DATE_TAGpublic void body_()
body_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ARTICLE_TAGpublic void book()
DocbookMarkup.BOOK_TAGpublic void book_()
DocbookMarkup.BOOK_TAGpublic void section1()
section1 in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section1_()
section1_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section2()
section2 in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section2_()
section2_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section3()
section3 in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section3_()
section3_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section4()
section4 in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section4_()
section4_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section5()
section5 in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void section5_()
section5_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.SECTION_TAGpublic void sectionTitle()
sectionTitle in interface org.apache.maven.doxia.sink.SinkHTML.Tag.TITLEpublic void sectionTitle_()
sectionTitle_ in interface org.apache.maven.doxia.sink.SinkHTML.Tag.TITLEpublic void list()
list in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ITEMIZEDLIST_TAGpublic void list_()
list_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ITEMIZEDLIST_TAGpublic void listItem()
listItem in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.LISTITEM_TAGpublic void listItem_()
listItem_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.LISTITEM_TAGpublic void numberedList(int numbering)
numberedList in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ORDEREDLIST_TAG,
DocbookMarkup.NUMERATION_ATTRIBUTEpublic void numberedList_()
numberedList_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ORDEREDLIST_TAGpublic void numberedListItem()
numberedListItem in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.LISTITEM_TAGpublic void numberedListItem_()
numberedListItem_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.LISTITEM_TAGpublic void definitionList()
definitionList in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.VARIABLELIST_TAGpublic void definitionList_()
definitionList_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.VARIABLELIST_TAGpublic void definitionListItem()
definitionListItem in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.VARLISTENTRY_TAGpublic void definitionListItem_()
definitionListItem_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.VARLISTENTRY_TAGpublic void definedTerm()
definedTerm in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.TERM_TAGpublic void definedTerm_()
definedTerm_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.TERM_TAGpublic void definition()
definition in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.LISTITEM_TAGpublic void definition_()
definition_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.LISTITEM_TAGpublic void paragraph()
paragraph in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.PARA_TAGpublic void paragraph_()
paragraph_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.PARA_TAGpublic void verbatim(boolean boxed)
verbatim in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.PROGRAMLISTING_TAGpublic void verbatim_()
verbatim_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.PROGRAMLISTING_TAGpublic void horizontalRule()
horizontalRule in interface org.apache.maven.doxia.sink.Sinkpublic void pageBreak()
pageBreak in interface org.apache.maven.doxia.sink.Sinkpublic void figure_()
figure_ in interface org.apache.maven.doxia.sink.Sinkprotected void graphicElement()
DocbookMarkup.MEDIAOBJECT_TAG,
DocbookMarkup.IMAGEOBJECT_TAG,
DocbookMarkup.IMAGEDATA_TAG,
DocbookMarkup.FORMAT_ATTRIBUTE,
DocbookMarkup.FILEREF_ATTRIBUTEpublic void figureGraphics(String name)
figureGraphics in interface org.apache.maven.doxia.sink.Sinkpublic void figureCaption()
figureCaption in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.FIGURE_TAG,
HTML.Tag.TITLEpublic void figureCaption_()
figureCaption_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.FIGURE_TAG,
HTML.Tag.TITLEpublic void table()
table in interface org.apache.maven.doxia.sink.Sinkpublic void table_()
table_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.INFORMALTABLE_TAG,
DocbookMarkup.FRAME_ATTRIBUTE,
DocbookMarkup.ROWSEP_ATTRIBUTE,
DocbookMarkup.COLSEP_ATTRIBUTE,
HTML.Tag.TABLE
public void tableRows(int[] justification,
boolean grid)
tableRows in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.TGROUP_TAG,
DocbookMarkup.COLS_ATTRIBUTE,
DocbookMarkup.COLSPEC_TAGpublic void tableRows_()
tableRows_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.TGROUP_TAG,
DocbookMarkup.TBODY_TAGpublic void tableRow()
tableRow in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ROW_TAGpublic void tableRow_()
tableRow_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ROW_TAGpublic void tableCell()
tableCell in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ENTRY_TAG,
DocbookMarkup.PARA_TAGpublic void tableCell_()
tableCell_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ENTRY_TAG,
DocbookMarkup.PARA_TAGpublic void tableCaption()
tableCaption in interface org.apache.maven.doxia.sink.SinkHTML.Tag.TABLE,
DocbookMarkup.FRAME_ATTRIBUTE,
DocbookMarkup.ROWSEP_ATTRIBUTE,
DocbookMarkup.COLSEP_ATTRIBUTE,
HTML.Tag.TITLEpublic void tableCaption_()
tableCaption_ in interface org.apache.maven.doxia.sink.SinkHTML.Tag.TITLEpublic void anchor(String name)
anchor in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ANCHOR_TAGpublic void anchor_()
anchor_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ANCHOR_TAGpublic void link(String name)
link in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ULINK_TAG,
DocbookMarkup.URL_ATTRIBUTE,
DocbookMarkup.LINK_TAG,
DocbookMarkup.LINKEND_ATTRIBUTEpublic void link_()
link_ in interface org.apache.maven.doxia.sink.SinkDocbookMarkup.ULINK_TAG,
DocbookMarkup.LINK_TAGpublic void italic()
italic in interface org.apache.maven.doxia.sink.Sinkpublic void italic_()
italic_ in interface org.apache.maven.doxia.sink.Sinkpublic void bold()
bold in interface org.apache.maven.doxia.sink.Sinkpublic void bold_()
bold_ in interface org.apache.maven.doxia.sink.Sinkpublic void monospaced()
monospaced in interface org.apache.maven.doxia.sink.Sinkpublic void monospaced_()
monospaced_ in interface org.apache.maven.doxia.sink.Sinkpublic void lineBreak()
lineBreak in interface org.apache.maven.doxia.sink.Sinkpublic void nonBreakingSpace()
nonBreakingSpace in interface org.apache.maven.doxia.sink.Sinkpublic void text(String text)
text in interface org.apache.maven.doxia.sink.Sinkprotected void markup(String text)
text - The text to write.protected void content(String text)
text - The text to write.protected void verbatimContent(String text)
text - The text to write.public void flush()
flush in interface org.apache.maven.doxia.sink.Sinkpublic void close()
close in interface org.apache.maven.doxia.sink.Sinkprotected void write(String text)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||