|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.doxia.sink.AbstractSink org.apache.maven.doxia.sink.SinkAdapter org.apache.maven.doxia.sink.AbstractXmlSink org.apache.maven.doxia.sink.XhtmlBaseSink org.apache.maven.doxia.module.xdoc.XdocSink
public class XdocSink
Xdoc Sink implementation.
It uses the Xdoc XSD
http://maven.apache.org/xsd/xdoc-2.0.xsd.
Field Summary |
---|
Fields inherited from class org.apache.maven.doxia.sink.XhtmlBaseSink |
---|
tableAttributes, tableRows |
Fields inherited from interface org.apache.maven.doxia.module.xdoc.XdocMarkup |
---|
AUTHOR_TAG, DATE_TAG, DOCUMENT_TAG, MACRO_TAG, PROPERTIES_TAG, SECTION_TAG, SOURCE_TAG, SUBSECTION_TAG, XDOC_NAMESPACE, XDOC_SYSTEM_ID |
Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup |
---|
A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, B, BASE, BASEFONT, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, DD, DEL, DFN, DIR, DIV, DL, DT, EM, ENTITY_TYPE, FIELDSET, FONT, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, MAP, MENU, META, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, P, PARAM, PRE, Q, S, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, STRONG, STYLE, SUB, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TT, U, UL, VAR |
Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup |
---|
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE |
Fields inherited from interface org.apache.maven.doxia.markup.Markup |
---|
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR |
Fields inherited from interface org.apache.maven.doxia.sink.Sink |
---|
JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, 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 | |
---|---|
protected |
XdocSink(Writer writer)
Constructor, initialize the Writer. |
protected |
XdocSink(Writer writer,
String encoding)
Constructor, initialize the Writer and tells which encoding is used. |
protected |
XdocSink(Writer writer,
String encoding,
String languageId)
Constructor, initialize the Writer and tells which encoding and languageId are used. |
Method Summary | |
---|---|
void |
author_()
|
void |
body_()
|
void |
body()
|
void |
body(SinkEventAttributes attributes)
|
void |
close()
|
void |
date_()
|
void |
head_()
|
void |
head()
|
void |
head(SinkEventAttributes attributes)
|
protected void |
init()
|
void |
link(String name,
String target)
Adds a link with an optional target. |
protected void |
markup(String text)
Deprecated. use write(String) |
protected void |
onSection_(int depth)
Ends a section. |
protected void |
onSection(int depth,
SinkEventAttributes attributes)
Starts a section. |
protected void |
onSectionTitle_(int depth)
Ends a section title. |
protected void |
onSectionTitle(int depth,
SinkEventAttributes attributes)
Starts a section title. |
void |
tableRow()
The default valign is top . |
void |
tableRows(int[] justification,
boolean grid)
The default align is center . |
void |
title_()
|
void |
title()
|
void |
verbatim_()
|
void |
verbatim(SinkEventAttributes attributes)
|
Methods inherited from class org.apache.maven.doxia.sink.AbstractXmlSink |
---|
getNameSpace, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag |
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
---|
author, author, date, date, definitionListItem_, definitionListItem, definitionListItem, sectionTitle_, sectionTitle, title |
Methods inherited from class org.apache.maven.doxia.sink.AbstractSink |
---|
enableLogging, getLog, unifyEOLs |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected XdocSink(Writer writer)
writer
- not null writer to write the result. Should be an UTF-8 Writer.
You could use newXmlWriter
methods from WriterFactory
.protected XdocSink(Writer writer, String encoding)
writer
- not null writer to write the result.encoding
- the encoding used, that should be written to the generated HTML content
if not null
.protected XdocSink(Writer writer, String encoding, String languageId)
writer
- not null writer to write the result.encoding
- the encoding used, that should be written to the generated HTML content
if not null
.languageId
- language identifier for the root element as defined by
IETF BCP 47, Tags for the Identification of Languages;
in addition, the empty string may be specified.Method Detail |
---|
protected void init()
init
in class XhtmlBaseSink
public void head()
head
in interface Sink
head
in class SinkAdapter
head(org.apache.maven.doxia.sink.SinkEventAttributes)
public void head(SinkEventAttributes attributes)
head
in interface Sink
head
in class SinkAdapter
XdocMarkup.DOCUMENT_TAG
,
XdocMarkup.PROPERTIES_TAG
public void head_()
head_
in interface Sink
head_
in class SinkAdapter
XdocMarkup.DOCUMENT_TAG
,
XdocMarkup.PROPERTIES_TAG
public void title()
title
in interface Sink
title
in class SinkAdapter
HTML.Tag.TITLE
public void title_()
title_
in interface Sink
title_
in class SinkAdapter
HTML.Tag.TITLE
public void author_()
author_
in interface Sink
author_
in class SinkAdapter
XdocMarkup.AUTHOR_TAG
public void date_()
date_
in interface Sink
date_
in class SinkAdapter
XdocMarkup.DATE_TAG
public void body()
body
in interface Sink
body
in class SinkAdapter
body(org.apache.maven.doxia.sink.SinkEventAttributes)
public void body(SinkEventAttributes attributes)
body
in interface Sink
body
in class SinkAdapter
HTML.Tag.BODY
public void body_()
body_
in interface Sink
body_
in class SinkAdapter
HTML.Tag.BODY
,
XdocMarkup.DOCUMENT_TAG
protected void onSection(int depth, SinkEventAttributes attributes)
onSection
in class XhtmlBaseSink
XdocMarkup.SECTION_TAG
,
XdocMarkup.SUBSECTION_TAG
protected void onSection_(int depth)
onSection_
in class XhtmlBaseSink
XdocMarkup.SECTION_TAG
,
XdocMarkup.SUBSECTION_TAG
protected void onSectionTitle(int depth, SinkEventAttributes attributes)
onSectionTitle
in class XhtmlBaseSink
HTML.Tag.H4
,
HTML.Tag.H5
,
HTML.Tag.H6
protected void onSectionTitle_(int depth)
onSectionTitle_
in class XhtmlBaseSink
HTML.Tag.H4
,
HTML.Tag.H5
,
HTML.Tag.H6
public void verbatim(SinkEventAttributes attributes)
verbatim
in interface Sink
verbatim
in class XhtmlBaseSink
XdocMarkup.SOURCE_TAG
,
HTML.Tag.PRE
public void verbatim_()
verbatim_
in interface Sink
verbatim_
in class XhtmlBaseSink
XdocMarkup.SOURCE_TAG
,
HTML.Tag.PRE
public void tableRows(int[] justification, boolean grid)
center
.
tableRows
in interface Sink
tableRows
in class XhtmlBaseSink
HTML.Tag.TABLE
public void tableRow()
top
.
tableRow
in interface Sink
tableRow
in class XhtmlBaseSink
HTML.Tag.TR
public void close()
close
in interface Sink
close
in class XhtmlBaseSink
public void link(String name, String target)
name
- the link name.target
- the link target, may be null.protected void markup(String text)
text
- The text to write.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |