org.apache.maven.doxia.module.docbook
Class DocBookSink

java.lang.Object
  extended by org.apache.maven.doxia.sink.SinkAdapter
      extended by org.apache.maven.doxia.sink.AbstractXmlSink
          extended by org.apache.maven.doxia.module.docbook.DocBookSink
All Implemented Interfaces:
Markup, XmlMarkup, DocbookMarkup, Sink

public class DocBookSink
extends AbstractXmlSink
implements DocbookMarkup

A doxia Sink which produces a Docbook model.

Since:
1.0
Version:
$Id: DocBookSink.java 599204 2007-11-28 23:49:33Z hboutemy $

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_()
          Ending an anchor element.
 void anchor(String name)
          Starting an element which defines an anchor.
 void author_()
          Ending the author element.
 void author()
          Starting the author element which is used to identify the author of the document.
 void body_()
          Ending the body element.
 void bold_()
          Ending a bold element.
 void bold()
          Starting a bold element.
 void book_()
          
 void book()
          
 void close()
          Close the writer or the stream, if needed.
protected  void content(String text)
          Write SGML escaped text to output, not preserving white space.
 void date_()
          Ending the date element.
 void date()
          Starting the date element which is used to identify the date of the document.
 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.
 void definitionListItem_()
          Ending a list item element within a definition list.
 void definitionListItem()
          Starting a list item element within a definition list.
static String escapeSGML(String text, boolean xmlMode)
           
 void figure_()
          Ending a basic image embedding element.
 void figureCaption_()
          Ending a caption of an image.
 void figureCaption()
          Starting a caption of an image element.
 void figureGraphics(String name)
          Adding a source of a graphic.
 void flush()
          Flush the writer or the stream, if needed.
 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_()
          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.
 boolean isXMLMode()
          Returns the current xmlMode.
 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(String name)
          Starting an element which defines a link.
 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.
protected  void markup(String text)
          Write text to output, preserving white space.
 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 pageBreak()
          Adding a new page separator.
 void paragraph_()
          Ending a paragraph element.
 void paragraph()
          Starting an element which represents a paragraph.
 void section1_()
          Ending a first heading element.
 void section1()
          Starting a first heading element which contains the topic of the section.
 void section2_()
          Ending a second heading element.
 void section2()
          Starting a second heading element which contains the topic of the section.
 void section3_()
          Ending a third heading element.
 void section3()
          Starting a third heading element which contains the topic of the section.
 void section4_()
          Ending a 4th heading element.
 void section4()
          Starting a 4th heading element which contains the topic of the section.
 void section5_()
          Ending a 5th heading element.
 void section5()
          Starting a 5th heading element which contains the topic of the section.
 void sectionTitle_()
          Ending a title heading element.
 void sectionTitle()
          Starting a title heading element.
 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_()
          Ending a table element.
 void table()
          Starting a table element for marking up tabular information in a document.
 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()
          Starting a cell element which defines a cell that contains data.
 void tableRow_()
          Ending a row element.
 void tableRow()
          Starting a row element which acts as a container for a row of table cells.
 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(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)
          Starting an element which indicates that whitespace in the enclosed text has semantic relevance.
protected  void verbatimContent(String text)
          Write SGML escaped text to output, preserving white space.
protected  void write(String text)
          TODO DOXIA-59 Need to uniform writing
 
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

DEFAULT_SGML_PUBLIC_ID

public static final String DEFAULT_SGML_PUBLIC_ID
DocBook V4.1 SGML public id: "-//OASIS//DTD DocBook V4.1//EN"

See Also:
Constant Field Values

DEFAULT_XML_PUBLIC_ID

public static final String DEFAULT_XML_PUBLIC_ID
DocBook XML V4.1.2 XML public id: "-//OASIS//DTD DocBook XML V4.1.2//EN"

See Also:
Constant Field Values

DEFAULT_XML_SYSTEM_ID

public static final String DEFAULT_XML_SYSTEM_ID
DocBook XML V4.0 XML system id: "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"

See Also:
Constant Field Values
Constructor Detail

DocBookSink

public DocBookSink(Writer out,
                   boolean isBook)

DocBookSink

public DocBookSink(Writer writer)
Parameters:
writer - the default writer.
Method Detail

escapeSGML

public static final String escapeSGML(String text,
                                      boolean xmlMode)
Parameters:
text - The text to escape.
xmlMode - xmlMode.
Returns:
The escaped text.

setXMLMode

public void setXMLMode(boolean mode)
Sets the xml mode.

Parameters:
mode - the mode to set.

isXMLMode

public boolean isXMLMode()
Returns the current xmlMode.

Returns:
the current xmlMode.

setEncoding

public void setEncoding(String enc)
Sets the encoding.

Parameters:
enc - the encoding to set.

getEncoding

public String getEncoding()
Returns the current encoding.

Returns:
the current encoding.

setStyleSheet

public void setStyleSheet(String sheet)
Sets the styleSheet.

Parameters:
sheet - the styleSheet to set.

getStyleSheet

public String getStyleSheet()
Returns the current styleSheet.

Returns:
the current styleSheet.

setPublicId

public void setPublicId(String id)
Sets the publicId.

Parameters:
id - the publicId to set.

getPublicId

public String getPublicId()
Returns the current publicId.

Returns:
the current publicId.

setSystemId

public void setSystemId(String id)
Sets the systemId.

Parameters:
id - the systemId to set.

getSystemId

public String getSystemId()
Returns the current systemId.

Returns:
the current systemId.

setLanguage

public void setLanguage(String language)
Sets the language.

Parameters:
language - the language to set.

getLanguage

public String getLanguage()
Returns the current language.

Returns:
the current language.

setItalicElement

public void setItalicElement(String tag)
Sets the current italicBeginTag and constructs the corresponding end tag from it.

Parameters:
tag - the tag to set. If tag is null, the empty string is used.

getItalicElement

public String getItalicElement()
Returns the current italicBeginTag.

Returns:
the current italicBeginTag. Defaults to "".

setBoldElement

public void setBoldElement(String tag)
Sets the current boldBeginTag and constructs the corresponding end tag from it.

Parameters:
tag - the tag to set. If tag is null, the empty string is used.

getBoldElement

public String getBoldElement()
Returns the current boldBeginTag.

Returns:
the current boldBeginTag. Defaults to "".

setMonospacedElement

public void setMonospacedElement(String tag)
Sets the current monospacedBeginTag and constructs the corresponding end tag from it.

Parameters:
tag - the tag to set. If tag is null, the empty string is used.

getMonospacedElement

public String getMonospacedElement()
Returns the current monospacedBeginTag.

Returns:
the current monospacedBeginTag. Defaults to ">".

setHorizontalRuleElement

public void setHorizontalRuleElement(String element)
Sets the current horizontalRuleElement.

Parameters:
element - the element to set.

getHorizontalRuleElement

public String getHorizontalRuleElement()
Returns the current horizontalRuleElement.

Returns:
the current horizontalRuleElement. Defaults to "".

setPageBreakElement

public void setPageBreakElement(String element)
Sets the current pageBreakElement.

Parameters:
element - the element to set.

getPageBreakElement

public String getPageBreakElement()
Returns the current pageBreakElement.

Returns:
the current pageBreakElement. Defaults to "".

setLineBreakElement

public void setLineBreakElement(String element)
Sets the current lineBreakElement.

Parameters:
element - the element to set.

getLineBreakElement

public String getLineBreakElement()
Returns the current lineBreakElement.

Returns:
the current lineBreakElement. Defaults to "".

head

public void head()
Starting the head element which contains information about the current document, such as its title, that is not considered document content.

Specified by:
head in interface Sink
Overrides:
head in class SinkAdapter
See Also:
DEFAULT_XML_PUBLIC_ID, DEFAULT_SGML_PUBLIC_ID, DEFAULT_XML_SYSTEM_ID, DocbookMarkup.ARTICLE_TAG

head_

public void head_()
Ending the head element.

Specified by:
head_ in interface Sink
Overrides:
head_ in class SinkAdapter
See Also:
DocbookMarkup.ARTICLEINFO_TAG

title

public void title()
Starting the title element which is used to identify the document.

Specified by:
title in interface Sink
Overrides:
title in class SinkAdapter
See Also:
DocbookMarkup.ARTICLEINFO_TAG, HTML.Tag.TITLE

title_

public void title_()
Ending the title element.

Specified by:
title_ in interface Sink
Overrides:
title_ in class SinkAdapter
See Also:
HTML.Tag.TITLE

author

public void author()
Starting the author element which is used to identify the author of the document.

Specified by:
author in interface Sink
Overrides:
author in class SinkAdapter
See Also:
DocbookMarkup.CORPAUTHOR_TAG

author_

public void author_()
Ending the author element.

Specified by:
author_ in interface Sink
Overrides:
author_ in class SinkAdapter
See Also:
DocbookMarkup.CORPAUTHOR_TAG

date

public void date()
Starting the date element which is used to identify the date of the document.

Specified by:
date in interface Sink
Overrides:
date in class SinkAdapter
See Also:
DocbookMarkup.DATE_TAG

date_

public void date_()
Ending the date element.

Specified by:
date_ in interface Sink
Overrides:
date_ in class SinkAdapter
See Also:
DocbookMarkup.DATE_TAG

body_

public void body_()
Ending the body element.

Specified by:
body_ in interface Sink
Overrides:
body_ in class SinkAdapter
See Also:
DocbookMarkup.ARTICLE_TAG

book

public void book()

See Also:
DocbookMarkup.BOOK_TAG

book_

public void book_()

See Also:
DocbookMarkup.BOOK_TAG

section1

public void section1()
Starting a first heading element which contains the topic of the section.

Specified by:
section1 in interface Sink
Overrides:
section1 in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section1_

public void section1_()
Ending a first heading element.

Specified by:
section1_ in interface Sink
Overrides:
section1_ in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section2

public void section2()
Starting a second heading element which contains the topic of the section.

Specified by:
section2 in interface Sink
Overrides:
section2 in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section2_

public void section2_()
Ending a second heading element.

Specified by:
section2_ in interface Sink
Overrides:
section2_ in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section3

public void section3()
Starting a third heading element which contains the topic of the section.

Specified by:
section3 in interface Sink
Overrides:
section3 in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section3_

public void section3_()
Ending a third heading element.

Specified by:
section3_ in interface Sink
Overrides:
section3_ in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section4

public void section4()
Starting a 4th heading element which contains the topic of the section.

Specified by:
section4 in interface Sink
Overrides:
section4 in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section4_

public void section4_()
Ending a 4th heading element.

Specified by:
section4_ in interface Sink
Overrides:
section4_ in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section5

public void section5()
Starting a 5th heading element which contains the topic of the section.

Specified by:
section5 in interface Sink
Overrides:
section5 in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

section5_

public void section5_()
Ending a 5th heading element.

Specified by:
section5_ in interface Sink
Overrides:
section5_ in class SinkAdapter
See Also:
DocbookMarkup.SECTION_TAG

sectionTitle

public void sectionTitle()
Starting a title heading element.

Specified by:
sectionTitle in interface Sink
Overrides:
sectionTitle in class SinkAdapter
See Also:
HTML.Tag.TITLE

sectionTitle_

public void sectionTitle_()
Ending a title heading element.

Specified by:
sectionTitle_ in interface Sink
Overrides:
sectionTitle_ in class SinkAdapter
See Also:
HTML.Tag.TITLE

list

public void list()
Starting an unordered list element.

Specified by:
list in interface Sink
Overrides:
list in class SinkAdapter
See Also:
DocbookMarkup.ITEMIZEDLIST_TAG

list_

public void list_()
Ending an unordered list element.

Specified by:
list_ in interface Sink
Overrides:
list_ in class SinkAdapter
See Also:
DocbookMarkup.ITEMIZEDLIST_TAG

listItem

public void listItem()
Starting a list item element within an unordered list.

Specified by:
listItem in interface Sink
Overrides:
listItem in class SinkAdapter
See Also:
DocbookMarkup.LISTITEM_TAG

listItem_

public void listItem_()
Ending a list item element within an unordered list.

Specified by:
listItem_ in interface Sink
Overrides:
listItem_ in class SinkAdapter
See Also:
DocbookMarkup.LISTITEM_TAG

numberedList

public void numberedList(int numbering)
Starting an ordered list element.

Specified by:
numberedList in interface Sink
Overrides:
numberedList in class SinkAdapter
Parameters:
numbering - the numbering wanted
See Also:
DocbookMarkup.ORDEREDLIST_TAG, DocbookMarkup.NUMERATION_ATTRIBUTE

numberedList_

public void numberedList_()
Ending an ordered list element.

Specified by:
numberedList_ in interface Sink
Overrides:
numberedList_ in class SinkAdapter
See Also:
DocbookMarkup.ORDEREDLIST_TAG

numberedListItem

public void numberedListItem()
Starting a list item element within an ordered list.

Specified by:
numberedListItem in interface Sink
Overrides:
numberedListItem in class SinkAdapter
See Also:
DocbookMarkup.LISTITEM_TAG

numberedListItem_

public void numberedListItem_()
Ending a list item element within an ordered list.

Specified by:
numberedListItem_ in interface Sink
Overrides:
numberedListItem_ in class SinkAdapter
See Also:
DocbookMarkup.LISTITEM_TAG

definitionList

public void definitionList()
Starting a definition list element.

Specified by:
definitionList in interface Sink
Overrides:
definitionList in class SinkAdapter
See Also:
DocbookMarkup.VARIABLELIST_TAG

definitionList_

public void definitionList_()
Ending a definition list element.

Specified by:
definitionList_ in interface Sink
Overrides:
definitionList_ in class SinkAdapter
See Also:
DocbookMarkup.VARIABLELIST_TAG

definitionListItem

public void definitionListItem()
Starting a list item element within a definition list.

Specified by:
definitionListItem in interface Sink
Overrides:
definitionListItem in class SinkAdapter
See Also:
DocbookMarkup.VARLISTENTRY_TAG

definitionListItem_

public void definitionListItem_()
Ending a list item element within a definition list.

Specified by:
definitionListItem_ in interface Sink
Overrides:
definitionListItem_ in class SinkAdapter
See Also:
DocbookMarkup.VARLISTENTRY_TAG

definedTerm

public void definedTerm()
Starting a definition term element within a definition list.

Specified by:
definedTerm in interface Sink
Overrides:
definedTerm in class SinkAdapter
See Also:
DocbookMarkup.TERM_TAG

definedTerm_

public void definedTerm_()
Starting a definition term element within a definition list.

Specified by:
definedTerm_ in interface Sink
Overrides:
definedTerm_ in class SinkAdapter
See Also:
DocbookMarkup.TERM_TAG

definition

public void definition()
Starting a definition element within a definition list.

Specified by:
definition in interface Sink
Overrides:
definition in class SinkAdapter
See Also:
DocbookMarkup.LISTITEM_TAG

definition_

public void definition_()
Ending a definition element within a definition list.

Specified by:
definition_ in interface Sink
Overrides:
definition_ in class SinkAdapter
See Also:
DocbookMarkup.LISTITEM_TAG

paragraph

public void paragraph()
Starting an element which represents a paragraph.

Specified by:
paragraph in interface Sink
Overrides:
paragraph in class SinkAdapter
See Also:
DocbookMarkup.PARA_TAG

paragraph_

public void paragraph_()
Ending a paragraph element.

Specified by:
paragraph_ in interface Sink
Overrides:
paragraph_ in class SinkAdapter
See Also:
DocbookMarkup.PARA_TAG

verbatim

public void verbatim(boolean boxed)
Starting an element which indicates that whitespace in the enclosed text has semantic relevance.

Specified by:
verbatim in interface Sink
Overrides:
verbatim in class SinkAdapter
Parameters:
boxed - true to add a box, false otherwise
See Also:
DocbookMarkup.PROGRAMLISTING_TAG

verbatim_

public void verbatim_()
Ending a verbatim element.

Specified by:
verbatim_ in interface Sink
Overrides:
verbatim_ in class SinkAdapter
See Also:
DocbookMarkup.PROGRAMLISTING_TAG

horizontalRule

public void horizontalRule()
Adding a separator of sections from a text to each other.

Specified by:
horizontalRule in interface Sink
Overrides:
horizontalRule in class SinkAdapter

pageBreak

public void pageBreak()
Adding a new page separator.

Specified by:
pageBreak in interface Sink
Overrides:
pageBreak in class SinkAdapter

figure_

public void figure_()
Ending a basic image embedding element.

Specified by:
figure_ in interface Sink
Overrides:
figure_ in class SinkAdapter

graphicElement

protected void graphicElement()
See Also:
DocbookMarkup.MEDIAOBJECT_TAG, DocbookMarkup.IMAGEOBJECT_TAG, DocbookMarkup.IMAGEDATA_TAG, DocbookMarkup.FORMAT_ATTRIBUTE, DocbookMarkup.FILEREF_ATTRIBUTE

figureGraphics

public void figureGraphics(String name)
Adding a source of a graphic.

Specified by:
figureGraphics in interface Sink
Overrides:
figureGraphics in class SinkAdapter
Parameters:
name - the source

figureCaption

public void figureCaption()
Starting a caption of an image element.

Specified by:
figureCaption in interface Sink
Overrides:
figureCaption in class SinkAdapter
See Also:
DocbookMarkup.FIGURE_TAG, HTML.Tag.TITLE

figureCaption_

public void figureCaption_()
Ending a caption of an image.

Specified by:
figureCaption_ in interface Sink
Overrides:
figureCaption_ in class SinkAdapter
See Also:
DocbookMarkup.FIGURE_TAG, HTML.Tag.TITLE

table

public void table()
Starting a table element for marking up tabular information in a document.

Specified by:
table in interface Sink
Overrides:
table in class SinkAdapter

table_

public void table_()
Ending a table element.

Specified by:
table_ in interface Sink
Overrides:
table_ in class SinkAdapter
See Also:
DocbookMarkup.INFORMALTABLE_TAG, DocbookMarkup.FRAME_ATTRIBUTE, DocbookMarkup.ROWSEP_ATTRIBUTE, DocbookMarkup.COLSEP_ATTRIBUTE, HTML.Tag.TABLE

tableRows

public void tableRows(int[] justification,
                      boolean grid)
Starting an element contains rows of table data.

Specified by:
tableRows in interface Sink
Overrides:
tableRows in class SinkAdapter
Parameters:
justification - the justification wanted
grid - true to provide a grid, false otherwise
See Also:
DocbookMarkup.TGROUP_TAG, DocbookMarkup.COLS_ATTRIBUTE, DocbookMarkup.COLSPEC_TAG

tableRows_

public void tableRows_()
Ending an element contains rows of table data.

Specified by:
tableRows_ in interface Sink
Overrides:
tableRows_ in class SinkAdapter
See Also:
DocbookMarkup.TGROUP_TAG, DocbookMarkup.TBODY_TAG

tableRow

public void tableRow()
Starting a row element which acts as a container for a row of table cells.

Specified by:
tableRow in interface Sink
Overrides:
tableRow in class SinkAdapter
See Also:
DocbookMarkup.ROW_TAG

tableRow_

public void tableRow_()
Ending a row element.

Specified by:
tableRow_ in interface Sink
Overrides:
tableRow_ in class SinkAdapter
See Also:
DocbookMarkup.ROW_TAG

tableCell

public void tableCell()
Starting a cell element which defines a cell that contains data.

Specified by:
tableCell in interface Sink
Overrides:
tableCell in class SinkAdapter
See Also:
DocbookMarkup.ENTRY_TAG, DocbookMarkup.PARA_TAG

tableCell_

public void tableCell_()
Ending a cell element.

Specified by:
tableCell_ in interface Sink
Overrides:
tableCell_ in class SinkAdapter
See Also:
DocbookMarkup.ENTRY_TAG, DocbookMarkup.PARA_TAG

tableCaption

public void tableCaption()
Starting a caption element of a table.

Specified by:
tableCaption in interface Sink
Overrides:
tableCaption in class SinkAdapter
See Also:
HTML.Tag.TABLE, DocbookMarkup.FRAME_ATTRIBUTE, DocbookMarkup.ROWSEP_ATTRIBUTE, DocbookMarkup.COLSEP_ATTRIBUTE, HTML.Tag.TITLE

tableCaption_

public void tableCaption_()
Ending a caption element of a table.

Specified by:
tableCaption_ in interface Sink
Overrides:
tableCaption_ in class SinkAdapter
See Also:
HTML.Tag.TITLE

anchor

public void anchor(String name)
Starting an element which defines an anchor.

Specified by:
anchor in interface Sink
Overrides:
anchor in class SinkAdapter
Parameters:
name - the name of the anchor
See Also:
DocbookMarkup.ANCHOR_TAG

anchor_

public void anchor_()
Ending an anchor element.

Specified by:
anchor_ in interface Sink
Overrides:
anchor_ in class SinkAdapter
See Also:
DocbookMarkup.ANCHOR_TAG

link

public void link(String name)
Starting an element which defines a link.

Specified by:
link in interface Sink
Overrides:
link in class SinkAdapter
Parameters:
name - the name of the link
See Also:
DocbookMarkup.ULINK_TAG, DocbookMarkup.URL_ATTRIBUTE, DocbookMarkup.LINK_TAG, DocbookMarkup.LINKEND_ATTRIBUTE

link_

public void link_()
Ending a link element.

Specified by:
link_ in interface Sink
Overrides:
link_ in class SinkAdapter
See Also:
DocbookMarkup.ULINK_TAG, DocbookMarkup.LINK_TAG

italic

public void italic()
Starting an italic element.

Specified by:
italic in interface Sink
Overrides:
italic in class SinkAdapter

italic_

public void italic_()
Ending an italic element.

Specified by:
italic_ in interface Sink
Overrides:
italic_ in class SinkAdapter

bold

public void bold()
Starting a bold element.

Specified by:
bold in interface Sink
Overrides:
bold in class SinkAdapter

bold_

public void bold_()
Ending a bold element.

Specified by:
bold_ in interface Sink
Overrides:
bold_ in class SinkAdapter

monospaced

public void monospaced()
Starting a monospaced element.

Specified by:
monospaced in interface Sink
Overrides:
monospaced in class SinkAdapter

monospaced_

public void monospaced_()
Ending a monospaced element.

Specified by:
monospaced_ in interface Sink
Overrides:
monospaced_ in class SinkAdapter

lineBreak

public void lineBreak()
Adding a line breaks.

Specified by:
lineBreak in interface Sink
Overrides:
lineBreak in class SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations.

Specified by:
nonBreakingSpace in interface Sink
Overrides:
nonBreakingSpace in class SinkAdapter

text

public void text(String text)
Adding a text.

Specified by:
text in interface Sink
Overrides:
text in class SinkAdapter
Parameters:
text - The text to write.

markup

protected void markup(String text)
Write text to output, preserving white space.

Parameters:
text - The text to write.

content

protected void content(String text)
Write SGML escaped text to output, not preserving white space.

Parameters:
text - The text to write.

verbatimContent

protected void verbatimContent(String text)
Write SGML escaped text to output, preserving white space.

Parameters:
text - The text to write.

flush

public void flush()
Flush the writer or the stream, if needed.

Specified by:
flush in interface Sink
Overrides:
flush in class SinkAdapter

close

public void close()
Close the writer or the stream, if needed.

Specified by:
close in interface Sink
Overrides:
close in class SinkAdapter

write

protected void write(String text)
TODO DOXIA-59 Need to uniform writing

Specified by:
write in class AbstractXmlSink
Parameters:
text - the given text to write


Copyright © 2005-2011 Apache Software Foundation. All Rights Reserved.