|
||||||||||
| 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.xhtml.XhtmlSink
public class XhtmlSink
Xhtml sink implementation.
| Field Summary |
|---|
| Fields inherited from interface org.apache.maven.doxia.module.xhtml.XhtmlMarkup |
|---|
TBODY_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 | |
|---|---|
XhtmlSink(java.io.Writer writer)
|
|
XhtmlSink(java.io.Writer writer,
RenderingContext renderingContext)
|
|
XhtmlSink(java.io.Writer writer,
RenderingContext renderingContext,
java.util.Map directives)
|
|
| Method Summary | |
|---|---|
void |
anchor_()
Ending an anchor element. |
void |
anchor(java.lang.String name)
Starting an element which defines an anchor. |
void |
author_()
Ending the author element. |
void |
body_()
Ending the body element. |
void |
body()
Starting the body of a document which contains the document's content. |
void |
bold_()
Ending a bold element. |
void |
bold()
Starting a bold element. |
void |
close()
Close the writer or the stream, if needed. |
protected void |
content(java.lang.String text)
|
void |
date_()
Ending the date element. |
void |
definedTerm_()
Starting a definition term element within a definition list. |
void |
definedTerm()
Starting a definition term element within a definition list. |
void |
definition_()
Ending a definition element within a definition list. |
void |
definition()
Starting a definition element within a definition list. |
void |
definitionList_()
Ending a definition list element. |
void |
definitionList()
Starting a definition list element. |
static java.lang.String |
encodeFragment(java.lang.String text)
|
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 |
figure_()
Ending a basic image embedding element. |
void |
figure()
Starting a basic image embedding element. |
void |
figureCaption_()
Ending a caption of an image. |
void |
figureCaption()
Starting a caption of an image element. |
void |
figureGraphics(java.lang.String name)
Adding a source of a graphic. |
void |
flush()
Flush the writer or the stream, if needed. |
protected java.lang.StringBuffer |
getBuffer()
|
RenderingContext |
getRenderingContext()
|
void |
head_()
Ending the head element. |
void |
head()
Starting the head element which contains information about the current document, such as its title, that is not considered document content. |
void |
horizontalRule()
Adding a separator of sections from a text to each other. |
void |
italic_()
Ending an italic element. |
void |
italic()
Starting an italic element. |
void |
lineBreak()
Adding a line breaks. |
void |
link_()
Ending a link element. |
void |
link(java.lang.String name)
Starting an element which defines a link. |
void |
link(java.lang.String name,
java.lang.String target)
The default style class for external link is externalLink. |
void |
list_()
Ending an unordered list element. |
void |
list()
Starting an unordered list element. |
void |
listItem_()
Ending a list item element within an unordered list. |
void |
listItem()
Starting a list item element within an unordered list. |
void |
monospaced_()
Ending a monospaced element. |
void |
monospaced()
Starting a monospaced element. |
void |
nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations. |
void |
numberedList_()
Ending an ordered list element. |
void |
numberedList(int numbering)
Starting an ordered list element. |
void |
numberedListItem_()
Ending a list item element within an ordered list. |
void |
numberedListItem()
Starting a list item element within an ordered list. |
void |
paragraph_()
Ending a paragraph element. |
void |
paragraph()
Starting an element which represents a paragraph. |
void |
rawText(java.lang.String text)
Adding a raw text, ie a text without any special formatting operations. |
protected void |
resetBuffer()
Reset the buffer. |
protected void |
resetState()
Reset all the Sink state. |
void |
section1_()
Ending a first heading element. |
void |
section1()
The default class style is section. |
void |
section2_()
Ending a second heading element. |
void |
section2()
The default class style is section. |
void |
section3_()
Ending a third heading element. |
void |
section3()
The default class style is section. |
void |
section4_()
Ending a 4th heading element. |
void |
section4()
The default class style is section. |
void |
section5_()
Ending a 5th heading element. |
void |
section5()
The default class style is section. |
void |
sectionTitle1_()
Ending a first title heading element. |
void |
sectionTitle1()
Starting a first title heading element. |
void |
sectionTitle2_()
Ending a second title heading element. |
void |
sectionTitle2()
Starting a second title heading element. |
void |
sectionTitle3_()
Ending a third title heading element. |
void |
sectionTitle3()
Starting a third title heading element. |
void |
sectionTitle4_()
Ending a 4th title heading element. |
void |
sectionTitle4()
Starting a 4th title heading element. |
void |
sectionTitle5_()
Ending a 5th title heading element. |
void |
sectionTitle5()
Starting a 5th title heading element. |
protected void |
setHeadFlag(boolean headFlag)
|
void |
table_()
Ending a table element. |
void |
table()
The default class style is bodyTable. |
void |
tableCaption_()
Ending a caption element of a table. |
void |
tableCaption()
Starting a caption element of a table. |
void |
tableCell_()
Ending a cell element. |
void |
tableCell_(boolean headerRow)
|
void |
tableCell()
Starting a cell element which defines a cell that contains data. |
void |
tableCell(boolean headerRow)
|
void |
tableCell(boolean headerRow,
java.lang.String width)
|
void |
tableCell(java.lang.String width)
Starting a cell element which defines a cell that contains data. |
void |
tableHeaderCell_()
Ending a cell header element. |
void |
tableHeaderCell()
Starting a cell element which defines a cell that contains header information. |
void |
tableHeaderCell(java.lang.String width)
Starting a cell element which defines a cell that contains header information. |
void |
tableRow_()
Ending a row element. |
void |
tableRow()
The default class style is a or b depending the row id. |
void |
tableRows_()
Ending an element contains rows of table data. |
void |
tableRows(int[] justification,
boolean grid)
Starting an element contains rows of table data. |
void |
text(java.lang.String text)
Adding a text. |
void |
title_()
Ending the title element. |
void |
title()
Starting the title element which is used to identify the document. |
void |
verbatim_()
Ending a verbatim element. |
void |
verbatim(boolean boxed)
The default class style is source. |
protected void |
verbatimContent(java.lang.String text)
|
protected void |
write(java.lang.String text)
TODO DOXIA-59 Need to uniform writing |
| Methods inherited from class org.apache.maven.doxia.sink.AbstractXmlSink |
|---|
writeEndTag, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag |
| Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
|---|
author, date, definitionListItem_, definitionListItem, pageBreak, sectionTitle_, sectionTitle |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public XhtmlSink(java.io.Writer writer)
writer -
public XhtmlSink(java.io.Writer writer,
RenderingContext renderingContext)
writer - renderingContext -
public XhtmlSink(java.io.Writer writer,
RenderingContext renderingContext,
java.util.Map directives)
writer - renderingContext - directives - | Method Detail |
|---|
protected java.lang.StringBuffer getBuffer()
protected void setHeadFlag(boolean headFlag)
headFlag - an header flagprotected void resetState()
protected void resetBuffer()
public void head()
head in interface Sinkhead in class SinkAdapterpublic void head_()
head_ in interface Sinkhead_ in class SinkAdapterpublic void title()
title in interface Sinktitle in class SinkAdapterHTML.Tag.TITLEpublic void title_()
title_ in interface Sinktitle_ in class SinkAdapterHTML.Tag.TITLEpublic void author_()
author_ in interface Sinkauthor_ in class SinkAdapterHTML.Tag.METApublic void date_()
date_ in interface Sinkdate_ in class SinkAdapterHTML.Tag.METApublic void body()
body in interface Sinkbody in class SinkAdapterpublic void body_()
body_ in interface Sinkbody_ in class SinkAdapterpublic void section1()
section.
Starting a first heading element which contains the topic of the section.
section1 in interface Sinksection1 in class SinkAdapterHTML.Tag.DIVpublic void section2()
section.
Starting a second heading element which contains the topic of the section.
section2 in interface Sinksection2 in class SinkAdapterHTML.Tag.DIVpublic void section3()
section.
Starting a third heading element which contains the topic of the section.
section3 in interface Sinksection3 in class SinkAdapterHTML.Tag.DIVpublic void section4()
section.
Starting a 4th heading element which contains the topic of the section.
section4 in interface Sinksection4 in class SinkAdapterHTML.Tag.DIVpublic void section5()
section.
Starting a 5th heading element which contains the topic of the section.
section5 in interface Sinksection5 in class SinkAdapterHTML.Tag.DIVpublic void section1_()
section1_ in interface Sinksection1_ in class SinkAdapterHTML.Tag.DIVpublic void section2_()
section2_ in interface Sinksection2_ in class SinkAdapterHTML.Tag.DIVpublic void section3_()
section3_ in interface Sinksection3_ in class SinkAdapterHTML.Tag.DIVpublic void section4_()
section4_ in interface Sinksection4_ in class SinkAdapterHTML.Tag.DIVpublic void section5_()
section5_ in interface Sinksection5_ in class SinkAdapterHTML.Tag.DIVpublic void sectionTitle1()
sectionTitle1 in interface SinksectionTitle1 in class SinkAdapterHTML.Tag.H2public void sectionTitle1_()
sectionTitle1_ in interface SinksectionTitle1_ in class SinkAdapterHTML.Tag.H2public void sectionTitle2()
sectionTitle2 in interface SinksectionTitle2 in class SinkAdapterHTML.Tag.H3public void sectionTitle2_()
sectionTitle2_ in interface SinksectionTitle2_ in class SinkAdapterHTML.Tag.H3public void sectionTitle3()
sectionTitle3 in interface SinksectionTitle3 in class SinkAdapterHTML.Tag.H4public void sectionTitle3_()
sectionTitle3_ in interface SinksectionTitle3_ in class SinkAdapterHTML.Tag.H4public void sectionTitle4()
sectionTitle4 in interface SinksectionTitle4 in class SinkAdapterHTML.Tag.H5public void sectionTitle4_()
sectionTitle4_ in interface SinksectionTitle4_ in class SinkAdapterHTML.Tag.H5public void sectionTitle5()
sectionTitle5 in interface SinksectionTitle5 in class SinkAdapterHTML.Tag.H6public void sectionTitle5_()
sectionTitle5_ in interface SinksectionTitle5_ in class SinkAdapterHTML.Tag.H6public void list()
list in interface Sinklist in class SinkAdapterHTML.Tag.ULpublic void list_()
list_ in interface Sinklist_ in class SinkAdapterHTML.Tag.ULpublic void listItem()
listItem in interface SinklistItem in class SinkAdapterHTML.Tag.LIpublic void listItem_()
listItem_ in interface SinklistItem_ in class SinkAdapterHTML.Tag.LIpublic void numberedList(int numbering)
numberedList in interface SinknumberedList in class SinkAdapternumbering - the numbering wantedHTML.Tag.OLpublic void numberedList_()
numberedList_ in interface SinknumberedList_ in class SinkAdapterHTML.Tag.OLpublic void numberedListItem()
numberedListItem in interface SinknumberedListItem in class SinkAdapterHTML.Tag.LIpublic void numberedListItem_()
numberedListItem_ in interface SinknumberedListItem_ in class SinkAdapterHTML.Tag.LIpublic void definitionList()
definitionList in interface SinkdefinitionList in class SinkAdapterHTML.Tag.DLpublic void definitionList_()
definitionList_ in interface SinkdefinitionList_ in class SinkAdapterHTML.Tag.DLpublic void definedTerm()
definedTerm in interface SinkdefinedTerm in class SinkAdapterHTML.Tag.DTpublic void definedTerm_()
definedTerm_ in interface SinkdefinedTerm_ in class SinkAdapterHTML.Tag.DTpublic void definition()
definition in interface Sinkdefinition in class SinkAdapterHTML.Tag.DDpublic void definition_()
definition_ in interface Sinkdefinition_ in class SinkAdapterHTML.Tag.DDpublic void paragraph()
paragraph in interface Sinkparagraph in class SinkAdapterHTML.Tag.Ppublic void paragraph_()
paragraph_ in interface Sinkparagraph_ in class SinkAdapterHTML.Tag.Ppublic void verbatim(boolean boxed)
source.
Starting an element which indicates that whitespace in the enclosed text has semantic relevance.
verbatim in interface Sinkverbatim in class SinkAdapterboxed - true to add a box, false otherwiseHTML.Tag.DIV,
HTML.Tag.PREpublic void verbatim_()
verbatim_ in interface Sinkverbatim_ in class SinkAdapterHTML.Tag.DIV,
HTML.Tag.PREpublic void horizontalRule()
horizontalRule in interface SinkhorizontalRule in class SinkAdapterHTML.Tag.HRpublic void table()
bodyTable.
Starting a table element for marking up tabular information in a document.
table in interface Sinktable in class SinkAdapterHTML.Tag.TABLEpublic void table_()
table_ in interface Sinktable_ in class SinkAdapterHTML.Tag.TABLE
public void tableRows(int[] justification,
boolean grid)
tableRows in interface SinktableRows in class SinkAdapterjustification - the justification wantedgrid - true to provide a grid, false otherwiseXhtmlMarkup.TBODY_TAGpublic void tableRows_()
tableRows_ in interface SinktableRows_ in class SinkAdapterXhtmlMarkup.TBODY_TAGpublic void tableRow()
a or b depending the row id.
Starting a row element which acts as a container for a row of table cells.
tableRow in interface SinktableRow in class SinkAdapterHTML.Tag.TRpublic void tableRow_()
tableRow_ in interface SinktableRow_ in class SinkAdapterHTML.Tag.TRpublic void tableCell()
tableCell in interface SinktableCell in class SinkAdapterpublic void tableHeaderCell()
tableHeaderCell in interface SinktableHeaderCell in class SinkAdapterpublic void tableCell(boolean headerRow)
headerRow - true if it is an header rowHTML.Tag.TH,
HTML.Tag.TDpublic void tableCell(java.lang.String width)
tableCell in interface SinktableCell in class SinkAdapterwidth - the size of the cellpublic void tableHeaderCell(java.lang.String width)
tableHeaderCell in interface SinktableHeaderCell in class SinkAdapterwidth - the size of the header cell
public void tableCell(boolean headerRow,
java.lang.String width)
headerRow - true if it is an header rowwidth - the cell sizeHTML.Tag.TH,
HTML.Tag.TDpublic void tableCell_()
tableCell_ in interface SinktableCell_ in class SinkAdapterpublic void tableHeaderCell_()
tableHeaderCell_ in interface SinktableHeaderCell_ in class SinkAdapterpublic void tableCell_(boolean headerRow)
headerRow - true if it is an header rowHTML.Tag.TH,
HTML.Tag.TDpublic void tableCaption()
tableCaption in interface SinktableCaption in class SinkAdapterHTML.Tag.CAPTIONpublic void tableCaption_()
tableCaption_ in interface SinktableCaption_ in class SinkAdapterHTML.Tag.CAPTIONpublic void figure()
figure in interface Sinkfigure in class SinkAdapterHTML.Tag.IMGpublic void figure_()
figure_ in interface Sinkfigure_ in class SinkAdapterpublic void figureCaption()
figureCaption in interface SinkfigureCaption in class SinkAdapterpublic void figureCaption_()
figureCaption_ in interface SinkfigureCaption_ in class SinkAdapterpublic void figureGraphics(java.lang.String name)
figureGraphics in interface SinkfigureGraphics in class SinkAdaptername - the sourcepublic void anchor(java.lang.String name)
anchor in interface Sinkanchor in class SinkAdaptername - the name of the anchorHTML.Tag.Apublic void anchor_()
anchor_ in interface Sinkanchor_ in class SinkAdapterHTML.Tag.Apublic void link(java.lang.String name)
link in interface Sinklink in class SinkAdaptername - the name of the link
public void link(java.lang.String name,
java.lang.String target)
externalLink.
name - target - HTML.Tag.Apublic void link_()
link_ in interface Sinklink_ in class SinkAdapterHTML.Tag.Apublic void italic()
italic in interface Sinkitalic in class SinkAdapterHTML.Tag.Ipublic void italic_()
italic_ in interface Sinkitalic_ in class SinkAdapterHTML.Tag.Ipublic void bold()
bold in interface Sinkbold in class SinkAdapterHTML.Tag.Bpublic void bold_()
bold_ in interface Sinkbold_ in class SinkAdapterHTML.Tag.Bpublic void monospaced()
monospaced in interface Sinkmonospaced in class SinkAdapterHTML.Tag.TTpublic void monospaced_()
monospaced_ in interface Sinkmonospaced_ in class SinkAdapterHTML.Tag.TTpublic void lineBreak()
lineBreak in interface SinklineBreak in class SinkAdapterHTML.Tag.BRpublic void nonBreakingSpace()
nonBreakingSpace in interface SinknonBreakingSpace in class SinkAdapterpublic void text(java.lang.String text)
text in interface Sinktext in class SinkAdaptertext - The text to write.public void rawText(java.lang.String text)
rawText in interface SinkrawText in class SinkAdaptertext - The text to write.public void flush()
flush in interface Sinkflush in class SinkAdapterpublic void close()
close in interface Sinkclose in class SinkAdapterprotected void write(java.lang.String text)
write in class AbstractXmlSinktext - the given text to writeprotected void content(java.lang.String text)
protected void verbatimContent(java.lang.String text)
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 encodeFragment(java.lang.String text)
text -
encodeURL(String)public static java.lang.String encodeURL(java.lang.String text)
text - the String to encode, may be null.
HtmlTools.encodeURL(String)public RenderingContext getRenderingContext()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||