org.apache.maven.doxia.module.twiki
Class TWikiSink

java.lang.Object
  extended by org.apache.maven.doxia.sink.AbstractSink
      extended by org.apache.maven.doxia.sink.SinkAdapter
          extended by org.apache.maven.doxia.sink.AbstractTextSink
              extended by org.apache.maven.doxia.module.twiki.TWikiSink
All Implemented Interfaces:
LogEnabled, Markup, TextMarkup, TWikiMarkup, Sink

public class TWikiSink
extends AbstractTextSink
implements TWikiMarkup

TWiki Sink implementation.
Note: The encoding used is UTF-8.

Since:
1.0
Version:
$Id: TWikiSink.java 1090706 2011-04-09 23:15:28Z hboutemy $
Author:
Vincent Siveton

Field Summary
 
Fields inherited from interface org.apache.maven.doxia.module.twiki.TWikiMarkup
ANCHOR_MARKUP, BOLD_END_MARKUP, BOLD_ITALIC_END_MARKUP, BOLD_ITALIC_START_MARKUP, BOLD_MONOSPACED_END_MARKUP, BOLD_MONOSPACED_START_MARKUP, BOLD_START_MARKUP, DEFINITION_LIST_DEFINITION_MARKUP, DEFINITION_LIST_ITEM_MARKUP, HORIZONTAL_RULE_MARKUP, ITALIC_END_MARKUP, ITALIC_START_MARKUP, LINK_END_MARKUP, LINK_MIDDLE_MARKUP, LINK_START_MARKUP, LIST_ITEM_MARKUP, MONOSPACED_END_MARKUP, MONOSPACED_START_MARKUP, NUMBERING_LOWER_ALPHA_MARKUP, NUMBERING_LOWER_ROMAN_MARKUP, NUMBERING_MARKUP, NUMBERING_UPPER_ALPHA_MARKUP, NUMBERING_UPPER_ROMAN_MARKUP, TABLE_CELL_HEADER_END_MARKUP, TABLE_CELL_HEADER_START_MARKUP, TABLE_CELL_MARKUP, TABLE_ROW_MARKUP, THREE_SPACES_MARKUP, VERBATIM_TAG
 
Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
PIPE
 
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 TWikiSink(Writer writer)
          Constructor, initialize the Writer and the variables.
 
Method Summary
 void anchor_()
          Not used.
 void anchor(String name)
          Starts an element which defines an anchor.
 void anchor(String name, SinkEventAttributes attributes)
          Starts an element which defines an anchor.

The name parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:

ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").

Supported attributes are the base attributes. If NAME is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

 void author_()
          Not used.
 void author()
          Not used.
 void author(SinkEventAttributes attributes)
          Starts an author element. This is used to identify the author of the document.

Supported attributes are: EMAIL.

 void body_()
          Not used.
 void body()
          Not used.
 void body(SinkEventAttributes attributes)
          Starts the body of a document. This contains the document's content.

Supported attributes are the base attributes.

 void bold_()
          Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
 void bold()
          Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
 void close()
          Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.
 void comment(String comment)
          Not used.
protected  void content(String text)
          Write HTML escaped text to output.
 void date_()
          Not used.
 void date()
          Not used.
 void date(SinkEventAttributes attributes)
          Starts the date element. This is used to identify the date of the document.

Supported attributes are: none.

 void definedTerm_()
          Not used.
 void definedTerm()
          Not used.
 void definedTerm(SinkEventAttributes attributes)
          Starts a definition term element within a definition list.

Supported attributes are the base attributes.

 void definition_()
          Ends a definition element within a definition list.
 void definition()
          Starts a definition element within a definition list.
 void definition(SinkEventAttributes attributes)
          Starts a definition element within a definition list.

Supported attributes are the base attributes.

 void definitionList_()
          Not used.
 void definitionList()
          Not used.
 void definitionList(SinkEventAttributes attributes)
          Starts a definition list.

Supported attributes are the base attributes.

 void definitionListItem_()
          Not used.
 void definitionListItem()
          Starts a list item element within a definition list.
 void definitionListItem(SinkEventAttributes attributes)
          Starts a list item element within a definition list.

Every definitionListItem has to contain exactly one Sink.definedTerm(SinkEventAttributes) and one Sink.definition(SinkEventAttributes), in this order.

Supported attributes are the base attributes.

protected static String escapeHTML(String text)
          Forward to HtmlTools.escapeHTML( text ).
 void figure_()
          Not used.
 void figure()
          Starts a basic image embedding element.
 void figure(SinkEventAttributes attributes)
          Starts a basic image embedding element.

The canonical sequence of events for the figure element is:

   sink.figure();

   sink.figureGraphics( "figure.png" );

   sink.figureCaption();
   sink.text( "Figure caption",);
   sink.figureCaption_();

   sink.figure_();
 

where the figureCaption element is optional.

However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.

NOTE also that the figureGraphics() event does not have to be embedded inside figure(), in particular for in-line images the figureGraphics() should be used stand-alone (in HTML language, figureGraphics() produces a <img> tag, while figure() opens a paragraph- or <div>- like environment).

Supported attributes are the base attributes.

 void figureCaption_()
          Not used.
 void figureCaption()
          Not used.
 void figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.

Supported attributes are the base attributes.

 void figureGraphics(String name)
          Adding a source of a graphic.
 void figureGraphics(String src, SinkEventAttributes attributes)
          Adds a graphic element.

The src parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.

Supported attributes are the base attributes plus:

SRC, ALT, WIDTH, HEIGHT, ALIGN, BORDER, HSPACE, VSPACE, ISMAP, USEMAP.

If the SRC attribute is specified in SinkEventAttributes, it will be overridden by the src parameter.

 void flush()
          Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.
 void head_()
          Ends the head element.
 void head()
          Starts the head element.
 void head(SinkEventAttributes attributes)
          Starts the head element.

This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the Sink.body(SinkEventAttributes) element.

The canonical sequence of events for the head element is:

   sink.head();

   sink.title();
   sink.text( "Title" );
   sink.title_();

   sink.author();
   sink.text( "Author" );
   sink.author_();

   sink.date();
   sink.text( "Date" );
   sink.date_();

   sink.head_();
 

but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).

Supported attributes are:

PROFILE, LANG.
 void horizontalRule()
          Adding a separator of sections from a text to each other.
 void horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.
protected  void init()
          This is called in Sink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.
 void italic_()
          Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
 void italic()
          Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
 void lineBreak()
          Not used.
 void lineBreak(SinkEventAttributes attributes)
          Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.
 void link_()
          Ends a link element.
 void link(String name)
          Starts an element which defines a link.
 void link(String name, SinkEventAttributes attributes)
          Starts a link.

The name parameter has to be a valid html href parameter, ie for internal links (links to an anchor within the same source document), name should start with the character "#".

Supported attributes are the base attributes plus:

CHARSET, COORDS, HREF, HREFLANG, REL, REV, SHAPE, TARGET, TYPE.

If HREF is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

 void list_()
          Ends an unordered list element.
 void list()
          Starts an unordered list element.
 void list(SinkEventAttributes attributes)
          Starts an unordered list.

Supported attributes are the base attributes.

 void listItem_()
          Ends a list item element within an unordered list.
 void listItem()
          Starts a list item element within an unordered list.
 void listItem(SinkEventAttributes attributes)
          Starts a list item element within an unordered list.

Supported attributes are the base attributes.

 void monospaced_()
          Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
 void monospaced()
          Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.
 void nonBreakingSpace()
          Not used.
 void numberedList_()
          Ends an ordered list element.
 void numberedList(int numbering)
          Starts an ordered list element.
 void numberedList(int numbering, SinkEventAttributes attributes)
          Starts an ordered list element.

Supported attributes are the base attributes.

 void numberedListItem_()
          Ends a list item element within an ordered list.
 void numberedListItem()
          Starts a list item element within an ordered list.
 void numberedListItem(SinkEventAttributes attributes)
          Starts a list item element within an ordered list.

Supported attributes are the base attributes.

 void pageBreak()
          Not used.
 void paragraph_()
          Ends a paragraph element.
 void paragraph()
          Not used.
 void paragraph(SinkEventAttributes attributes)
          Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

 void rawText(String text)
          Not used.
 void section_(int level)
          Not used.
 void section(int level, SinkEventAttributes attributes)
          Not used.
 void section1_()
          Not used.
 void section1()
          Not used.
 void section2_()
          Not used.
 void section2()
          Not used.
 void section3_()
          Not used.
 void section3()
          Not used.
 void section4_()
          Not used.
 void section4()
          Not used.
 void section5_()
          Not used.
 void section5()
          Not used.
 void sectionTitle_()
          Not used.
 void sectionTitle_(int level)
          Ends a section title at the given level.
 void sectionTitle()
          Not used.
 void sectionTitle(int level, SinkEventAttributes attributes)
          Start a new section title at the given level.

This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding section element of the same level.

NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).

Supported attributes are the base attributes plus ALIGN.

 void sectionTitle1_()
          Ends a first title heading element.
 void sectionTitle1()
          Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section1() element.
 void sectionTitle2_()
          Ends a second title heading element.
 void sectionTitle2()
          Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section2() element.
 void sectionTitle3_()
          Ends a third title heading element.
 void sectionTitle3()
          Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section3() element.
 void sectionTitle4_()
          Ends a 4th title heading element.
 void sectionTitle4()
          Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section4() element.
 void sectionTitle5_()
          Ends a 5th title heading element.
 void sectionTitle5()
          Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section5() element.
 void table_()
          Not used.
 void table()
          Not used.
 void table(SinkEventAttributes attributes)
          Starts a table.

The canonical sequence of events for the table element is:

   sink.table();

   sink.tableRows( justify, true );

   sink.tableRow();
   sink.tableCell();
   sink.text( "cell 1,1" );
   sink.tableCell_();
   sink.tableCell();
   sink.text( "cell 1,2" );
   sink.tableCell_();
   sink.tableRow_();

   sink.tableRows_();

   sink.tableCaption();
   sink.text( "Table caption" );
   sink.tableCaption_();

   sink.table_();

 

where the tableCaption element is optional.

However, NOTE that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, FRAME, RULES, SUMMARY, WIDTH.
 void tableCaption_()
          Not used.
 void tableCaption()
          Not used.
 void tableCaption(SinkEventAttributes attributes)
          Starts a table caption.

Note that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

Supported attributes are the base attributes plus ALIGN.

 void tableCell_()
          Ends a cell element.
 void tableCell()
          Starts a cell element which defines a cell that contains data.
 void tableCell(SinkEventAttributes attributes)
          Starts a table cell.

Supported attributes are the base attributes plus:

ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.
 void tableCell(String width)
          Starts a cell element which defines a cell that contains data.
 void tableHeaderCell_()
          Ends a cell header element.
 void tableHeaderCell()
          Starts a cell element which defines a cell that contains header information.
 void tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.

Supported attributes are the same as for tableCell.

 void tableHeaderCell(String width)
          Starts a cell element which defines a cell that contains header information.
 void tableRow_()
          Ends a row element.
 void tableRow()
          Starts a row element which acts as a container for a row of table cells.
 void tableRow(SinkEventAttributes attributes)
          Starts a table row.

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, VALIGN.
 void tableRows_()
          Not used.
 void tableRows(int[] justification, boolean grid)
          Not used.
 void text(String text)
          Adding a text.
 void text(String text, SinkEventAttributes attributes)
          Adds a text.

The text parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.

If text contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.

Supported attributes are the base attributes plus

VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").
 void title_()
          Not used.
 void title()
          Not used.
 void title(SinkEventAttributes attributes)
          Starts the title element. This is used to identify the document.

Supported attributes are the base attributes.

 void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          Not used.
 void verbatim_()
          Ends a verbatim element.
 void verbatim(boolean boxed)
          Starts an element which indicates that whitespace in the enclosed text has semantic relevance.
 void verbatim(SinkEventAttributes attributes)
          Starts a verbatim block, ie a block where whitespace has semantic relevance.

Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.

Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.

Supported attributes are the base attributes plus:

DECORATION (value: "boxed"), ALIGN, WIDTH.
 
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

TWikiSink

protected TWikiSink(Writer writer)
Constructor, initialize the Writer and the variables.

Parameters:
writer - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.
Method Detail

anchor

public void anchor(String name)
Starts 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:
Sink.anchor(String,SinkEventAttributes)

anchor

public void anchor(String name,
                   SinkEventAttributes attributes)
Starts an element which defines an anchor.

The name parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:

ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").

Supported attributes are the base attributes. If NAME is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

Specified by:
anchor in interface Sink
Overrides:
anchor in class SinkAdapter
Parameters:
name - the name of the anchor. This has to be a valid SGML NAME token.
attributes - A set of SinkEventAttributes, may be null.

anchor_

public void anchor_()
Not used. Ends an anchor element.

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

author

public void author()
Not used. Starts an author element.

Specified by:
author in interface Sink
Overrides:
author in class SinkAdapter
See Also:
Sink.author(SinkEventAttributes)

author

public void author(SinkEventAttributes attributes)
Starts an author element. This is used to identify the author of the document.

Supported attributes are: EMAIL.

Specified by:
author in interface Sink
Overrides:
author in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.head(SinkEventAttributes)

author_

public void author_()
Not used. Ends an author element.

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

body

public void body()
Not used. Starts the body of a document.

Specified by:
body in interface Sink
Overrides:
body in class SinkAdapter
See Also:
Sink.body(SinkEventAttributes)

body

public void body(SinkEventAttributes attributes)
Starts the body of a document. This contains the document's content.

Supported attributes are the base attributes.

Specified by:
body in interface Sink
Overrides:
body in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.head(SinkEventAttributes)

body_

public void body_()
Not used. Ends the body element.

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

bold

public void bold()
Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

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

bold_

public void bold_()
Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

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

comment

public void comment(String comment)
Not used. Add a comment.

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

close

public void close()
Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.

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

date

public void date()
Not used. Starts the date element.
The date is recommended (but it is not a requirement) to be align to the ISO-8601 standard, i.e.:
 YYYY-MM-DD
 
where

Specified by:
date in interface Sink
Overrides:
date in class SinkAdapter
See Also:
Sink.date(SinkEventAttributes)

date

public void date(SinkEventAttributes attributes)
Starts the date element. This is used to identify the date of the document.

Supported attributes are: none.

Specified by:
date in interface Sink
Overrides:
date in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.head(SinkEventAttributes)

date_

public void date_()
Not used. Ends the date element.

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

definedTerm

public void definedTerm()
Not used. Starts a definition term element within a definition list.

Specified by:
definedTerm in interface Sink
Overrides:
definedTerm in class SinkAdapter
See Also:
Sink.definedTerm(SinkEventAttributes)

definedTerm

public void definedTerm(SinkEventAttributes attributes)
Starts a definition term element within a definition list.

Supported attributes are the base attributes.

Specified by:
definedTerm in interface Sink
Overrides:
definedTerm in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

definedTerm_

public void definedTerm_()
Not used. Starts a definition term element within a definition list.

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

definition

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

Specified by:
definition in interface Sink
Overrides:
definition in class SinkAdapter
See Also:
Sink.definition(SinkEventAttributes)

definition

public void definition(SinkEventAttributes attributes)
Starts a definition element within a definition list.

Supported attributes are the base attributes.

Specified by:
definition in interface Sink
Overrides:
definition in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

definition_

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

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

definitionList

public void definitionList()
Not used. Starts a definition list element.

Specified by:
definitionList in interface Sink
Overrides:
definitionList in class SinkAdapter
See Also:
Sink.definitionList(SinkEventAttributes)

definitionList

public void definitionList(SinkEventAttributes attributes)
Starts a definition list.

Supported attributes are the base attributes.

Specified by:
definitionList in interface Sink
Overrides:
definitionList in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

definitionList_

public void definitionList_()
Not used. Ends a definition list element.

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

definitionListItem

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

Specified by:
definitionListItem in interface Sink
Overrides:
definitionListItem in class SinkAdapter
See Also:
Sink.definitionListItem(SinkEventAttributes)

definitionListItem

public void definitionListItem(SinkEventAttributes attributes)
Starts a list item element within a definition list.

Every definitionListItem has to contain exactly one Sink.definedTerm(SinkEventAttributes) and one Sink.definition(SinkEventAttributes), in this order.

Supported attributes are the base attributes.

Specified by:
definitionListItem in interface Sink
Overrides:
definitionListItem in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

definitionListItem_

public void definitionListItem_()
Not used. Ends a list item element within a definition list.

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

figure

public void figure()
Starts a basic image embedding element.

Specified by:
figure in interface Sink
Overrides:
figure in class SinkAdapter
See Also:
Sink.figure(SinkEventAttributes)

figure

public void figure(SinkEventAttributes attributes)
Starts a basic image embedding element.

The canonical sequence of events for the figure element is:

   sink.figure();

   sink.figureGraphics( "figure.png" );

   sink.figureCaption();
   sink.text( "Figure caption",);
   sink.figureCaption_();

   sink.figure_();
 

where the figureCaption element is optional.

However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.

NOTE also that the figureGraphics() event does not have to be embedded inside figure(), in particular for in-line images the figureGraphics() should be used stand-alone (in HTML language, figureGraphics() produces a <img> tag, while figure() opens a paragraph- or <div>- like environment).

Supported attributes are the base attributes.

Specified by:
figure in interface Sink
Overrides:
figure in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

figure_

public void figure_()
Not used. Ends a basic image embedding element.

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

figureCaption

public void figureCaption()
Not used. Starts a caption of an image element.

Specified by:
figureCaption in interface Sink
Overrides:
figureCaption in class SinkAdapter
See Also:
Sink.figureCaption(SinkEventAttributes)

figureCaption

public void figureCaption(SinkEventAttributes attributes)
Starts a figure caption.

Supported attributes are the base attributes.

Specified by:
figureCaption in interface Sink
Overrides:
figureCaption in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.figure(SinkEventAttributes)

figureCaption_

public void figureCaption_()
Not used. Ends a caption of an image.

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

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

figureGraphics

public void figureGraphics(String src,
                           SinkEventAttributes attributes)
Adds a graphic element.

The src parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.

Supported attributes are the base attributes plus:

SRC, ALT, WIDTH, HEIGHT, ALIGN, BORDER, HSPACE, VSPACE, ISMAP, USEMAP.

If the SRC attribute is specified in SinkEventAttributes, it will be overridden by the src parameter.

Specified by:
figureGraphics in interface Sink
Overrides:
figureGraphics in class SinkAdapter
Parameters:
src - the image source, a valid URL.
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.figure(SinkEventAttributes)

flush

public void flush()
Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.

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

head

public void head()
Starts the head element.

Specified by:
head in interface Sink
Overrides:
head in class SinkAdapter
See Also:
Sink.head(SinkEventAttributes)

head

public void head(SinkEventAttributes attributes)
Starts the head element.

This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the Sink.body(SinkEventAttributes) element.

The canonical sequence of events for the head element is:

   sink.head();

   sink.title();
   sink.text( "Title" );
   sink.title_();

   sink.author();
   sink.text( "Author" );
   sink.author_();

   sink.date();
   sink.text( "Date" );
   sink.date_();

   sink.head_();
 

but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).

Supported attributes are:

PROFILE, LANG.

Specified by:
head in interface Sink
Overrides:
head in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

head_

public void head_()
Ends the head element.

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

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
See Also:
Sink.horizontalRule(SinkEventAttributes)

horizontalRule

public void horizontalRule(SinkEventAttributes attributes)
Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.

Specified by:
horizontalRule in interface Sink
Overrides:
horizontalRule in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

italic

public void italic()
Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

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

italic_

public void italic_()
Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

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

lineBreak

public void lineBreak()
Not used. Adds a line break.

Specified by:
lineBreak in interface Sink
Overrides:
lineBreak in class SinkAdapter
See Also:
Sink.lineBreak(SinkEventAttributes)

lineBreak

public void lineBreak(SinkEventAttributes attributes)
Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.

Specified by:
lineBreak in interface Sink
Overrides:
lineBreak in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

link

public void link(String name)
Starts 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:
Sink.link(String,SinkEventAttributes)

link

public void link(String name,
                 SinkEventAttributes attributes)
Starts a link.

The name parameter has to be a valid html href parameter, ie for internal links (links to an anchor within the same source document), name should start with the character "#".

Supported attributes are the base attributes plus:

CHARSET, COORDS, HREF, HREFLANG, REL, REV, SHAPE, TARGET, TYPE.

If HREF is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

Specified by:
link in interface Sink
Overrides:
link in class SinkAdapter
Parameters:
name - the name of the link.
attributes - A set of SinkEventAttributes, may be null.

link_

public void link_()
Ends a link element.

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

list

public void list()
Starts an unordered list element.

Specified by:
list in interface Sink
Overrides:
list in class SinkAdapter
See Also:
Sink.list(SinkEventAttributes)

list

public void list(SinkEventAttributes attributes)
Starts an unordered list.

Supported attributes are the base attributes.

Specified by:
list in interface Sink
Overrides:
list in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

list_

public void list_()
Ends an unordered list element.

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

listItem

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

Specified by:
listItem in interface Sink
Overrides:
listItem in class SinkAdapter
See Also:
Sink.listItem(SinkEventAttributes)

listItem

public void listItem(SinkEventAttributes attributes)
Starts a list item element within an unordered list.

Supported attributes are the base attributes.

Specified by:
listItem in interface Sink
Overrides:
listItem in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

listItem_

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

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

monospaced

public void monospaced()
Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

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

monospaced_

public void monospaced_()
Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

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

nonBreakingSpace

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

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

numberedList

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

Specified by:
numberedList in interface Sink
Overrides:
numberedList in class SinkAdapter
Parameters:
numbering - the numbering style.
See Also:
Sink.numberedList(int,SinkEventAttributes)

numberedList

public void numberedList(int numbering,
                         SinkEventAttributes attributes)
Starts an ordered list element.

Supported attributes are the base attributes.

Specified by:
numberedList in interface Sink
Overrides:
numberedList in class SinkAdapter
Parameters:
numbering - the numbering style.
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.NUMBERING_DECIMAL, Sink.NUMBERING_LOWER_ALPHA, Sink.NUMBERING_LOWER_ROMAN, Sink.NUMBERING_UPPER_ALPHA, Sink.NUMBERING_UPPER_ROMAN

numberedList_

public void numberedList_()
Ends an ordered list element.

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

numberedListItem

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

Specified by:
numberedListItem in interface Sink
Overrides:
numberedListItem in class SinkAdapter
See Also:
Sink.numberedListItem(SinkEventAttributes)

numberedListItem

public void numberedListItem(SinkEventAttributes attributes)
Starts a list item element within an ordered list.

Supported attributes are the base attributes.

Specified by:
numberedListItem in interface Sink
Overrides:
numberedListItem in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

numberedListItem_

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

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

pageBreak

public void pageBreak()
Not used. Adding a new page separator.

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

paragraph

public void paragraph()
Not used. Starts an element which represents a paragraph.

Specified by:
paragraph in interface Sink
Overrides:
paragraph in class SinkAdapter
See Also:
Sink.paragraph(SinkEventAttributes)

paragraph

public void paragraph(SinkEventAttributes attributes)
Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

Specified by:
paragraph in interface Sink
Overrides:
paragraph in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

paragraph_

public void paragraph_()
Ends a paragraph element.

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

rawText

public void rawText(String text)
Not used. Adding a raw text, ie a text without any special formatting operations.

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

section

public void section(int level,
                    SinkEventAttributes attributes)
Not used. Start a new section at the given level.

Sections with higher level have to be entirely contained within sections of lower level.

Supported attributes are the base attributes.

Specified by:
section in interface Sink
Overrides:
section in class SinkAdapter
Parameters:
level - the section level.
attributes - A set of SinkEventAttributes, may be null.

section1

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

Specified by:
section1 in interface Sink
Overrides:
section1 in class SinkAdapter
See Also:
Sink.section(int,SinkEventAttributes)

section1_

public void section1_()
Not used. Ends a first heading element.

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

section2

public void section2()
Not used. Starts a second heading element which contains the topic of the section. This has to be contained within a Sink.section1() element.

Specified by:
section2 in interface Sink
Overrides:
section2 in class SinkAdapter
See Also:
Sink.section(int,SinkEventAttributes)

section2_

public void section2_()
Not used. Ends a second heading element.

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

section3

public void section3()
Not used. Starts a third heading element which contains the topic of the section. This has to be contained within a Sink.section2() element.

Specified by:
section3 in interface Sink
Overrides:
section3 in class SinkAdapter
See Also:
Sink.section(int,SinkEventAttributes)

section3_

public void section3_()
Not used. Ends a third heading element.

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

section4

public void section4()
Not used. Starts a 4th heading element which contains the topic of the section. This has to be contained within a Sink.section3() element.

Specified by:
section4 in interface Sink
Overrides:
section4 in class SinkAdapter
See Also:
Sink.section(int,SinkEventAttributes)

section4_

public void section4_()
Not used. Ends a 4th heading element.

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

section5

public void section5()
Not used. Starts a 5th heading element which contains the topic of the section. This has to be contained within a Sink.section4() element.

Specified by:
section5 in interface Sink
Overrides:
section5 in class SinkAdapter
See Also:
Sink.section(int,SinkEventAttributes)

section5_

public void section5_()
Not used. Ends a 5th heading element.

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

section_

public void section_(int level)
Not used. Ends a section at the given level.

Specified by:
section_ in interface Sink
Overrides:
section_ in class SinkAdapter
Parameters:
level - the section level.

sectionTitle

public void sectionTitle()
Not used. Starts a title heading element.

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

sectionTitle

public void sectionTitle(int level,
                         SinkEventAttributes attributes)
Start a new section title at the given level.

This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding section element of the same level.

NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).

Supported attributes are the base attributes plus ALIGN.

Specified by:
sectionTitle in interface Sink
Overrides:
sectionTitle in class SinkAdapter
Parameters:
level - the section title level.
attributes - A set of SinkEventAttributes, may be null.

sectionTitle1

public void sectionTitle1()
Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section1() element.

Specified by:
sectionTitle1 in interface Sink
Overrides:
sectionTitle1 in class SinkAdapter
See Also:
Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle1_

public void sectionTitle1_()
Ends a first title heading element.

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

sectionTitle2

public void sectionTitle2()
Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section2() element.

Specified by:
sectionTitle2 in interface Sink
Overrides:
sectionTitle2 in class SinkAdapter
See Also:
Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle2_

public void sectionTitle2_()
Ends a second title heading element.

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

sectionTitle3

public void sectionTitle3()
Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section3() element.

Specified by:
sectionTitle3 in interface Sink
Overrides:
sectionTitle3 in class SinkAdapter
See Also:
Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle3_

public void sectionTitle3_()
Ends a third title heading element.

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

sectionTitle4

public void sectionTitle4()
Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section4() element.

Specified by:
sectionTitle4 in interface Sink
Overrides:
sectionTitle4 in class SinkAdapter
See Also:
Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle4_

public void sectionTitle4_()
Ends a 4th title heading element.

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

sectionTitle5

public void sectionTitle5()
Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section5() element.

Specified by:
sectionTitle5 in interface Sink
Overrides:
sectionTitle5 in class SinkAdapter
See Also:
Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle5_

public void sectionTitle5_()
Ends a 5th title heading element.

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

sectionTitle_

public void sectionTitle_()
Not used. Ends a title heading element.

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

sectionTitle_

public void sectionTitle_(int level)
Ends a section title at the given level.

Specified by:
sectionTitle_ in interface Sink
Overrides:
sectionTitle_ in class SinkAdapter
Parameters:
level - the section title level.

table

public void table()
Not used. Starts a table element for marking up tabular information in a document.

Specified by:
table in interface Sink
Overrides:
table in class SinkAdapter
See Also:
Sink.table(SinkEventAttributes)

table

public void table(SinkEventAttributes attributes)
Starts a table.

The canonical sequence of events for the table element is:

   sink.table();

   sink.tableRows( justify, true );

   sink.tableRow();
   sink.tableCell();
   sink.text( "cell 1,1" );
   sink.tableCell_();
   sink.tableCell();
   sink.text( "cell 1,2" );
   sink.tableCell_();
   sink.tableRow_();

   sink.tableRows_();

   sink.tableCaption();
   sink.text( "Table caption" );
   sink.tableCaption_();

   sink.table_();

 

where the tableCaption element is optional.

However, NOTE that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, FRAME, RULES, SUMMARY, WIDTH.

Specified by:
table in interface Sink
Overrides:
table in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

table_

public void table_()
Not used. Ends a table element.

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

tableCaption

public void tableCaption()
Not used. Starts a caption element of a table.

Specified by:
tableCaption in interface Sink
Overrides:
tableCaption in class SinkAdapter
See Also:
Sink.tableCaption(SinkEventAttributes)

tableCaption

public void tableCaption(SinkEventAttributes attributes)
Starts a table caption.

Note that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

Supported attributes are the base attributes plus ALIGN.

Specified by:
tableCaption in interface Sink
Overrides:
tableCaption in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.table(SinkEventAttributes)

tableCaption_

public void tableCaption_()
Not used. Ends a caption element of a table.

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

tableCell

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

Specified by:
tableCell in interface Sink
Overrides:
tableCell in class SinkAdapter
See Also:
Sink.tableCell(SinkEventAttributes)

tableCell

public void tableCell(SinkEventAttributes attributes)
Starts a table cell.

Supported attributes are the base attributes plus:

ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.

Specified by:
tableCell in interface Sink
Overrides:
tableCell in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

tableCell

public void tableCell(String width)
Starts a cell element which defines a cell that contains data.

Specified by:
tableCell in interface Sink
Overrides:
tableCell in class SinkAdapter
Parameters:
width - the size of the cell.

tableCell_

public void tableCell_()
Ends a cell element.

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

tableHeaderCell

public void tableHeaderCell()
Starts a cell element which defines a cell that contains header information.

Specified by:
tableHeaderCell in interface Sink
Overrides:
tableHeaderCell in class SinkAdapter
See Also:
Sink.tableHeaderCell(SinkEventAttributes)

tableHeaderCell

public void tableHeaderCell(SinkEventAttributes attributes)
Starts a table header cell.

Supported attributes are the same as for tableCell.

Specified by:
tableHeaderCell in interface Sink
Overrides:
tableHeaderCell in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

tableHeaderCell

public void tableHeaderCell(String width)
Starts a cell element which defines a cell that contains header information.

Specified by:
tableHeaderCell in interface Sink
Overrides:
tableHeaderCell in class SinkAdapter
Parameters:
width - the size of the header cell.

tableHeaderCell_

public void tableHeaderCell_()
Ends a cell header element.

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

tableRow

public void tableRow()
Starts 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:
Sink.tableRow(SinkEventAttributes)

tableRow

public void tableRow(SinkEventAttributes attributes)
Starts a table row.

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, VALIGN.

Specified by:
tableRow in interface Sink
Overrides:
tableRow in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

tableRow_

public void tableRow_()
Ends a row element.

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

tableRows

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

Specified by:
tableRows in interface Sink
Overrides:
tableRows in class SinkAdapter
Parameters:
justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells.
grid - true to provide a grid, false otherwise.
See Also:
Sink.table(SinkEventAttributes), Sink.JUSTIFY_CENTER, Sink.JUSTIFY_LEFT, Sink.JUSTIFY_RIGHT

tableRows_

public void tableRows_()
Not used. Ends an element that contains rows of table data.

Specified by:
tableRows_ in interface Sink
Overrides:
tableRows_ 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.
See Also:
Sink.text(String,SinkEventAttributes)

text

public void text(String text,
                 SinkEventAttributes attributes)
Adds a text.

The text parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.

If text contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.

Supported attributes are the base attributes plus

VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").

Specified by:
text in interface Sink
Overrides:
text in class SinkAdapter
Parameters:
text - The text to write.
attributes - A set of SinkEventAttributes, may be null.

title

public void title()
Not used. Starts the title element.

Specified by:
title in interface Sink
Overrides:
title in class SinkAdapter
See Also:
Sink.title(SinkEventAttributes)

title

public void title(SinkEventAttributes attributes)
Starts the title element. This is used to identify the document.

Supported attributes are the base attributes.

Specified by:
title in interface Sink
Overrides:
title in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.
See Also:
Sink.head(SinkEventAttributes)

title_

public void title_()
Not used. Ends the title element.

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

unknown

public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)
Not used. Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc.

Specified by:
unknown in interface Sink
Overrides:
unknown in class SinkAdapter
Parameters:
name - The name of the event.
requiredParams - An optional array of required parameters to the event. May be null.
attributes - A set of SinkEventAttributes, may be null.

verbatim

public void verbatim(boolean boxed)
Starts 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

verbatim

public void verbatim(SinkEventAttributes attributes)
Starts a verbatim block, ie a block where whitespace has semantic relevance.

Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.

Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.

Supported attributes are the base attributes plus:

DECORATION (value: "boxed"), ALIGN, WIDTH.

Specified by:
verbatim in interface Sink
Overrides:
verbatim in class SinkAdapter
Parameters:
attributes - A set of SinkEventAttributes, may be null.

verbatim_

public void verbatim_()
Ends a verbatim element.

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

content

protected void content(String text)
Write HTML escaped text to output.

Parameters:
text - The text to write.

init

protected void init()
This is called in Sink.head() or in Sink.close(), and can be used to set the sink into a clear state so it can be re-used.

Overrides:
init in class AbstractSink

escapeHTML

protected static String escapeHTML(String text)
Forward to HtmlTools.escapeHTML( text ).

Parameters:
text - the String to escape, may be null
Returns:
the text escaped, "" if null String input
See Also:
HtmlTools.escapeHTML(String)


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.