|
|||||||||
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.module.xdoc.XmlWriterXdocSink
public class XmlWriterXdocSink
A doxia Sink which produces an xdoc document.
Field Summary |
---|
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 | |
---|---|
XmlWriterXdocSink(org.codehaus.plexus.util.xml.XMLWriter out)
Constructor, initialize the XMLWriter. |
Method Summary | |
---|---|
void |
anchor_()
|
void |
anchor(java.lang.String name)
|
void |
author_()
|
void |
body_()
|
void |
body()
|
void |
bold_()
|
void |
bold()
|
void |
close()
|
protected void |
content(java.lang.String text)
Write HTML escaped text to output. |
void |
date_()
|
void |
definedTerm_()
|
void |
definedTerm()
|
void |
definition_()
|
void |
definition()
|
void |
definitionList_()
|
void |
definitionList()
|
static java.lang.String |
encodeURL(java.lang.String text)
Forward to HtmlTools.encodeURL( text ). |
static java.lang.String |
escapeHTML(java.lang.String text)
Forward to HtmlTools.escapeHTML( text ). |
void |
flush()
|
void |
head_()
|
void |
head()
|
void |
horizontalRule()
|
void |
italic_()
|
void |
italic()
|
void |
lineBreak()
|
void |
link_()
|
void |
link(java.lang.String name)
|
void |
list_()
|
void |
list()
|
void |
listItem_()
|
void |
listItem()
|
void |
monospaced_()
|
void |
monospaced()
|
void |
nonBreakingSpace()
|
void |
numberedList_()
|
void |
numberedList(int numbering)
|
void |
numberedListItem_()
|
void |
numberedListItem()
|
void |
paragraph_()
|
void |
paragraph()
|
protected void |
resetState()
Reset all variables. |
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 |
table_()
|
void |
table()
|
void |
tableCaption_()
|
void |
tableCaption()
|
void |
tableCell_()
|
void |
tableCell_(boolean headerRow)
Ends a table cell. |
void |
tableCell()
|
void |
tableCell(boolean headerRow)
Starts a table cell. |
void |
tableHeaderCell_()
|
void |
tableHeaderCell()
|
void |
tableRow_()
|
void |
tableRow()
|
void |
tableRows_()
|
void |
tableRows(int[] justification,
boolean grid)
|
void |
text(java.lang.String text)
|
void |
title_()
|
void |
verbatim_()
|
void |
verbatim(boolean boxed)
|
protected void |
verbatimContent(java.lang.String text)
Write text to output, preserving white space. |
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
---|
author, date, definitionListItem_, definitionListItem, figure_, figure, figureCaption_, figureCaption, figureGraphics, pageBreak, rawText, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, tableCell, tableHeaderCell, title |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XmlWriterXdocSink(org.codehaus.plexus.util.xml.XMLWriter out)
out
- The XMLWriter to write the result.Method Detail |
---|
protected void resetState()
public void head()
head
in interface org.apache.maven.doxia.sink.Sink
head
in class org.apache.maven.doxia.sink.SinkAdapter
public void head_()
head_
in interface org.apache.maven.doxia.sink.Sink
head_
in class org.apache.maven.doxia.sink.SinkAdapter
public void title_()
title_
in interface org.apache.maven.doxia.sink.Sink
title_
in class org.apache.maven.doxia.sink.SinkAdapter
public void author_()
author_
in interface org.apache.maven.doxia.sink.Sink
author_
in class org.apache.maven.doxia.sink.SinkAdapter
public void date_()
date_
in interface org.apache.maven.doxia.sink.Sink
date_
in class org.apache.maven.doxia.sink.SinkAdapter
public void body()
body
in interface org.apache.maven.doxia.sink.Sink
body
in class org.apache.maven.doxia.sink.SinkAdapter
public void body_()
body_
in interface org.apache.maven.doxia.sink.Sink
body_
in class org.apache.maven.doxia.sink.SinkAdapter
public void section1()
section1
in interface org.apache.maven.doxia.sink.Sink
section1
in class org.apache.maven.doxia.sink.SinkAdapter
public void section2()
section2
in interface org.apache.maven.doxia.sink.Sink
section2
in class org.apache.maven.doxia.sink.SinkAdapter
public void section3()
section3
in interface org.apache.maven.doxia.sink.Sink
section3
in class org.apache.maven.doxia.sink.SinkAdapter
public void section4()
section4
in interface org.apache.maven.doxia.sink.Sink
section4
in class org.apache.maven.doxia.sink.SinkAdapter
public void section5()
section5
in interface org.apache.maven.doxia.sink.Sink
section5
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle()
sectionTitle
in interface org.apache.maven.doxia.sink.Sink
sectionTitle
in class org.apache.maven.doxia.sink.SinkAdapter
public void sectionTitle_()
sectionTitle_
in interface org.apache.maven.doxia.sink.Sink
sectionTitle_
in class org.apache.maven.doxia.sink.SinkAdapter
public void section1_()
section1_
in interface org.apache.maven.doxia.sink.Sink
section1_
in class org.apache.maven.doxia.sink.SinkAdapter
public void section2_()
section2_
in interface org.apache.maven.doxia.sink.Sink
section2_
in class org.apache.maven.doxia.sink.SinkAdapter
public void section3_()
section3_
in interface org.apache.maven.doxia.sink.Sink
section3_
in class org.apache.maven.doxia.sink.SinkAdapter
public void section4_()
section4_
in interface org.apache.maven.doxia.sink.Sink
section4_
in class org.apache.maven.doxia.sink.SinkAdapter
public void section5_()
section5_
in interface org.apache.maven.doxia.sink.Sink
section5_
in class org.apache.maven.doxia.sink.SinkAdapter
public void list()
list
in interface org.apache.maven.doxia.sink.Sink
list
in class org.apache.maven.doxia.sink.SinkAdapter
public void list_()
list_
in interface org.apache.maven.doxia.sink.Sink
list_
in class org.apache.maven.doxia.sink.SinkAdapter
public void listItem()
listItem
in interface org.apache.maven.doxia.sink.Sink
listItem
in class org.apache.maven.doxia.sink.SinkAdapter
public void listItem_()
listItem_
in interface org.apache.maven.doxia.sink.Sink
listItem_
in class org.apache.maven.doxia.sink.SinkAdapter
public void numberedList(int numbering)
numberedList
in interface org.apache.maven.doxia.sink.Sink
numberedList
in class org.apache.maven.doxia.sink.SinkAdapter
public void numberedList_()
numberedList_
in interface org.apache.maven.doxia.sink.Sink
numberedList_
in class org.apache.maven.doxia.sink.SinkAdapter
public void numberedListItem()
numberedListItem
in interface org.apache.maven.doxia.sink.Sink
numberedListItem
in class org.apache.maven.doxia.sink.SinkAdapter
public void numberedListItem_()
numberedListItem_
in interface org.apache.maven.doxia.sink.Sink
numberedListItem_
in class org.apache.maven.doxia.sink.SinkAdapter
public void definitionList()
definitionList
in interface org.apache.maven.doxia.sink.Sink
definitionList
in class org.apache.maven.doxia.sink.SinkAdapter
public void definitionList_()
definitionList_
in interface org.apache.maven.doxia.sink.Sink
definitionList_
in class org.apache.maven.doxia.sink.SinkAdapter
public void definedTerm()
definedTerm
in interface org.apache.maven.doxia.sink.Sink
definedTerm
in class org.apache.maven.doxia.sink.SinkAdapter
public void definedTerm_()
definedTerm_
in interface org.apache.maven.doxia.sink.Sink
definedTerm_
in class org.apache.maven.doxia.sink.SinkAdapter
public void definition()
definition
in interface org.apache.maven.doxia.sink.Sink
definition
in class org.apache.maven.doxia.sink.SinkAdapter
public void definition_()
definition_
in interface org.apache.maven.doxia.sink.Sink
definition_
in class org.apache.maven.doxia.sink.SinkAdapter
public void paragraph()
paragraph
in interface org.apache.maven.doxia.sink.Sink
paragraph
in class org.apache.maven.doxia.sink.SinkAdapter
public void paragraph_()
paragraph_
in interface org.apache.maven.doxia.sink.Sink
paragraph_
in class org.apache.maven.doxia.sink.SinkAdapter
public void verbatim(boolean boxed)
verbatim
in interface org.apache.maven.doxia.sink.Sink
verbatim
in class org.apache.maven.doxia.sink.SinkAdapter
public void verbatim_()
verbatim_
in interface org.apache.maven.doxia.sink.Sink
verbatim_
in class org.apache.maven.doxia.sink.SinkAdapter
public void horizontalRule()
horizontalRule
in interface org.apache.maven.doxia.sink.Sink
horizontalRule
in class org.apache.maven.doxia.sink.SinkAdapter
public void table()
table
in interface org.apache.maven.doxia.sink.Sink
table
in class org.apache.maven.doxia.sink.SinkAdapter
public void table_()
table_
in interface org.apache.maven.doxia.sink.Sink
table_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRows(int[] justification, boolean grid)
tableRows
in interface org.apache.maven.doxia.sink.Sink
tableRows
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRows_()
tableRows_
in interface org.apache.maven.doxia.sink.Sink
tableRows_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRow()
tableRow
in interface org.apache.maven.doxia.sink.Sink
tableRow
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableRow_()
tableRow_
in interface org.apache.maven.doxia.sink.Sink
tableRow_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCell()
tableCell
in interface org.apache.maven.doxia.sink.Sink
tableCell
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableHeaderCell()
tableHeaderCell
in interface org.apache.maven.doxia.sink.Sink
tableHeaderCell
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCell(boolean headerRow)
headerRow
- If this cell is part of a header row.public void tableCell_()
tableCell_
in interface org.apache.maven.doxia.sink.Sink
tableCell_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableHeaderCell_()
tableHeaderCell_
in interface org.apache.maven.doxia.sink.Sink
tableHeaderCell_
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCell_(boolean headerRow)
headerRow
- If this cell is part of a header row.public void tableCaption()
tableCaption
in interface org.apache.maven.doxia.sink.Sink
tableCaption
in class org.apache.maven.doxia.sink.SinkAdapter
public void tableCaption_()
tableCaption_
in interface org.apache.maven.doxia.sink.Sink
tableCaption_
in class org.apache.maven.doxia.sink.SinkAdapter
public void anchor(java.lang.String name)
anchor
in interface org.apache.maven.doxia.sink.Sink
anchor
in class org.apache.maven.doxia.sink.SinkAdapter
public void anchor_()
anchor_
in interface org.apache.maven.doxia.sink.Sink
anchor_
in class org.apache.maven.doxia.sink.SinkAdapter
public void link(java.lang.String name)
link
in interface org.apache.maven.doxia.sink.Sink
link
in class org.apache.maven.doxia.sink.SinkAdapter
public void link_()
link_
in interface org.apache.maven.doxia.sink.Sink
link_
in class org.apache.maven.doxia.sink.SinkAdapter
public void italic()
italic
in interface org.apache.maven.doxia.sink.Sink
italic
in class org.apache.maven.doxia.sink.SinkAdapter
public void italic_()
italic_
in interface org.apache.maven.doxia.sink.Sink
italic_
in class org.apache.maven.doxia.sink.SinkAdapter
public void bold()
bold
in interface org.apache.maven.doxia.sink.Sink
bold
in class org.apache.maven.doxia.sink.SinkAdapter
public void bold_()
bold_
in interface org.apache.maven.doxia.sink.Sink
bold_
in class org.apache.maven.doxia.sink.SinkAdapter
public void monospaced()
monospaced
in interface org.apache.maven.doxia.sink.Sink
monospaced
in class org.apache.maven.doxia.sink.SinkAdapter
public void monospaced_()
monospaced_
in interface org.apache.maven.doxia.sink.Sink
monospaced_
in class org.apache.maven.doxia.sink.SinkAdapter
public void lineBreak()
lineBreak
in interface org.apache.maven.doxia.sink.Sink
lineBreak
in class org.apache.maven.doxia.sink.SinkAdapter
public void nonBreakingSpace()
nonBreakingSpace
in interface org.apache.maven.doxia.sink.Sink
nonBreakingSpace
in class org.apache.maven.doxia.sink.SinkAdapter
public void text(java.lang.String text)
text
in interface org.apache.maven.doxia.sink.Sink
text
in class org.apache.maven.doxia.sink.SinkAdapter
protected void content(java.lang.String text)
text
- The text to write.protected void verbatimContent(java.lang.String text)
text
- The text to write.public static java.lang.String escapeHTML(java.lang.String text)
text
- the String to escape, may be null
HtmlTools.escapeHTML(String).
public static java.lang.String encodeURL(java.lang.String text)
text
- the String to encode, may be null.
HtmlTools.encodeURL(String).
public void flush()
flush
in interface org.apache.maven.doxia.sink.Sink
flush
in class org.apache.maven.doxia.sink.SinkAdapter
public void close()
close
in interface org.apache.maven.doxia.sink.Sink
close
in class org.apache.maven.doxia.sink.SinkAdapter
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |