XhtmlBaseSink (Doxia 1.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.doxia.sink
Class XhtmlBaseSink

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

All Implemented Interfaces:: LogEnabled, HtmlMarkup, Markup, XmlMarkup, Sink

Direct Known Subclasses:: XdocSink, XhtmlSink

public class XhtmlBaseSink
extends AbstractXmlSink
implements HtmlMarkup
extends AbstractXmlSink
implements HtmlMarkup

Abstract base xhtml sink implementation.

Since:: 1.1
Version:: $Id: XhtmlBaseSink.java 1185529 2011-10-18 08:27:44Z ltheussl $
Author:: Jason van Zyl, ltheussl

Field Summary
`protected MutableAttributeSet`	`tableAttributes` used to store attributes passed to table().
`protected boolean`	`tableRows` Flag to know if `tableRows(int[], boolean)` is called or not.

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.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
`XhtmlBaseSink(Writer out)` Constructor, initialize the PrintWriter.

Method Summary
`void`	`anchor_()` Ends an anchor element.
`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`	`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)` Add a comment.
`protected void`	`content(String text)` Write HTML escaped text to output.
`void`	`definedTerm_()` Starts a definition term element within a definition list.
`void`	`definedTerm()` Starts a definition term element within a definition list.
`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_()` Ends a definition list element.
`void`	`definitionList()` Starts a definition list element.
`void`	`definitionList(SinkEventAttributes attributes)` Starts a definition list. Supported attributes are the `base attributes`.
`protected static String`	`encodeURL(String text)` Forward to HtmlTools.encodeURL( text ).
`protected static String`	`escapeHTML(String text)` Forward to HtmlTools.escapeHTML( text ).
`void`	`figure_()` Ends a basic image embedding element.
`void`	`figure()` Deprecated. Use `figure(SinkEventAttributes)`, this method is only kept for backward compatibility. Note that the behavior is different though, as this method writes an img tag, while correctly the img tag should be written by figureGraphics().
`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_()` Ends a caption of an image.
`void`	`figureCaption()` Deprecated. Use `figureCaption(SinkEventAttributes)`, this method is only kept for backward compatibility. Note that the behavior is different though, as this method only writes an alt attribute.
`void`	`figureCaption(SinkEventAttributes attributes)` Starts a figure caption. Supported attributes are the `base attributes`.
`void`	`figureGraphics(String name)` Deprecated. Use `figureGraphics(String,SinkEventAttributes)`, this method is only kept for backward compatibility. Note that the behavior is different though, as this method does not write the img tag, only the src attribute.
`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.
`protected int`	`getCellCount()` Getter for the field `cellCount`.
`protected int[]`	`getCellJustif()` Getter for the field `cellJustif`.
`protected StringBuffer`	`getTextBuffer()` To use mainly when playing with the head events.
`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.
`protected boolean`	`isHeadFlag()` isHeadFlag.
`protected boolean`	`isVerbatimFlag()` isVerbatimFlag.
`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()` Adds a line break.
`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()` Adding a non breaking space, ie a space without any special formatting operations.
`void`	`numberedList_()` Ends an ordered list element.
`void`	`numberedList(int numbering)` The default list style depends on the numbering.
`void`	`numberedList(int numbering, SinkEventAttributes attributes)` The default list style depends on the numbering.
`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`.
`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`	`pageBreak()` Adding a new page separator.
`void`	`paragraph_()` Ends a paragraph element.
`void`	`paragraph()` Starts an element which represents a paragraph.
`void`	`paragraph(SinkEventAttributes attributes)` Starts a paragraph. Supported attributes are the `base attributes` plus `ALIGN`.
`void`	`rawText(String text)` Adding a raw text, ie a text without any special formatting operations.
`protected void`	`resetState()` Deprecated. since 1.1.2, use `init()` instead of.
`protected void`	`resetTextBuffer()` Reset the text buffer.
`void`	`section_(int level)` Ends a section at the given level.
`void`	`section(int level, SinkEventAttributes attributes)` 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`.
`void`	`section1_()` Ends a first heading element.
`void`	`section1()` Starts a first heading element which contains the topic of the section.
`void`	`section2_()` Ends a second heading element.
`void`	`section2()` Starts a second heading element which contains the topic of the section. This has to be contained within a `Sink.section1()` element.
`void`	`section3_()` Ends a third heading element.
`void`	`section3()` Starts a third heading element which contains the topic of the section. This has to be contained within a `Sink.section2()` element.
`void`	`section4_()` Ends a 4th heading element.
`void`	`section4()` Starts a 4th heading element which contains the topic of the section. This has to be contained within a `Sink.section3()` element.
`void`	`section5_()` Ends a 5th heading element.
`void`	`section5()` Starts a 5th heading element which contains the topic of the section. This has to be contained within a `Sink.section4()` element.
`void`	`sectionTitle_(int level)` Ends a section title at the given level.
`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.
`protected void`	`setCellCount(int count)` Setter for the field `cellCount`.
`protected void`	`setCellJustif(int[] justif)` Setter for the field `cellJustif`.
`protected void`	`setHeadFlag(boolean headFlag)` Setter for the field `headFlag`.
`protected void`	`setVerbatimFlag(boolean verb)` Setter for the field `verbatimFlag`.
`void`	`table_()` Ends a table element.
`void`	`table()` Starts a table element for marking up tabular information in a document.
`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_()` Ends a caption element of a table.
`void`	`tableCaption()` Starts a caption element of a table.
`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()` The default class style is `a` or `b` depending the row id.
`void`	`tableRow(SinkEventAttributes attributes)` The default class style is `a` or `b` depending the row id.
`void`	`tableRows_()` Ends an element that contains rows of table data.
`void`	`tableRows(int[] justification, boolean grid)` The default class style is `bodyTable`.
`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`	`unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)` Add an unknown event.
`void`	`verbatim_()` Ends a verbatim element.
`void`	`verbatim(boolean boxed)` The default class style for boxed is `source`.
`void`	`verbatim(SinkEventAttributes attributes)` The default class style for boxed is `source`.
`protected void`	`verbatimContent(String text)` Write HTML escaped text to output.
`protected void`	`write(String text)` Write a text to the sink.
`protected void`	`writeEndTag(HTML.Tag t)` Ends a Tag without writing an EOL.
`protected void`	`writeStartTag(HTML.Tag t, MutableAttributeSet att, boolean isSimpleTag)` Starts a Tag with 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, author, body_, body, body, date_, date, date, definitionListItem_, definitionListItem, definitionListItem, head_, head, head, sectionTitle_, sectionTitle, title_, title, 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`

Field Detail

tableAttributes

protected MutableAttributeSet tableAttributes

used to store attributes passed to table().

tableRows

protected boolean tableRows

Flag to know if tableRows(int[], boolean) is called or not. It is mainly to be backward compatible with some plugins (like checkstyle) which uses:

 sink.table();
 sink.tableRow();

instead of

 sink.table();
 sink.tableRows( justify, true );
 sink.tableRow();

Constructor Detail

XhtmlBaseSink

public XhtmlBaseSink(Writer out)

Constructor, initialize the PrintWriter.

Parameters:: out - The writer to write the result.

Method Detail

getTextBuffer

protected StringBuffer getTextBuffer()

To use mainly when playing with the head events.

Returns:: the current buffer of text events.

setHeadFlag

protected void setHeadFlag(boolean headFlag)

Setter for the field headFlag.

Parameters:: headFlag - an header flag.

isHeadFlag

protected boolean isHeadFlag()

isHeadFlag.

Returns:: the current headFlag.

setVerbatimFlag

protected void setVerbatimFlag(boolean verb)

Setter for the field verbatimFlag.

Parameters:: verb - a verbatim flag.

isVerbatimFlag

protected boolean isVerbatimFlag()

isVerbatimFlag.

Returns:: the current verbatim flag.

setCellJustif

protected void setCellJustif(int[] justif)

Setter for the field cellJustif.

Parameters:: justif - the new cell justification array.

getCellJustif

protected int[] getCellJustif()

Getter for the field cellJustif.

Returns:: the current cell justification array.

setCellCount

protected void setCellCount(int count)

Setter for the field cellCount.

Parameters:: count - the new cell count.

getCellCount

protected int getCellCount()

Getter for the field cellCount.

Returns:: the current cell count.

resetState

protected void resetState()

Deprecated. since 1.1.2, use init() instead of.

Reset all variables.

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

resetTextBuffer

protected void resetTextBuffer()

Reset the text buffer.

section

public void section(int level,
                    SinkEventAttributes attributes)

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.

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.

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.

section_

public void section_(int level)

Ends a section at the given level.

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

Parameters:: level - the section level.

section1

public void section1()

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)

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

section1_

public void section1_()

Ends a first heading element.

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

section2

public void section2()

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)

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

section2_

public void section2_()

Ends a second heading element.

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

section3

public void section3()

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)

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

section3_

public void section3_()

Ends a third heading element.

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

section4

public void section4()

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)

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

section4_

public void section4_()

Ends a 4th heading element.

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

section5

public void section5()

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)

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

section5_

public void section5_()

Ends a 5th heading element.

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

onSection

protected void onSection(int depth,
                         SinkEventAttributes attributes)

Starts a section. The default class style is section.

Parameters:: depth - The level of the section.; attributes - some attributes. May be null.
See Also:: HTML.Tag.DIV

onSection_

protected void onSection_(int depth)

Ends a section.

Parameters:: depth - The level of the section.
See Also:: HTML.Tag.DIV

onSectionTitle

protected void onSectionTitle(int depth,
                              SinkEventAttributes attributes)

Starts a section title.

Parameters:: depth - The level of the section title.; attributes - some attributes. May be null.
See Also:: HTML.Tag.H2, HTML.Tag.H3, HTML.Tag.H4, HTML.Tag.H5, HTML.Tag.H6

onSectionTitle_

protected void onSectionTitle_(int depth)

Ends a section title.

Parameters:: depth - The level of the section title.
See Also:: HTML.Tag.H2, HTML.Tag.H3, HTML.Tag.H4, HTML.Tag.H5, HTML.Tag.H6

list

public void list()

Starts an unordered list element.

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

See Also:: HTML.Tag.UL

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.
See Also:: HTML.Tag.UL

list_

public void list_()

Ends an unordered list element.

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

See Also:: HTML.Tag.UL

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:: HTML.Tag.LI

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.
See Also:: HTML.Tag.LI

listItem_

public void listItem_()

Ends a list item element within an unordered list.

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

See Also:: HTML.Tag.LI

numberedList

public void numberedList(int numbering)

The default list style depends on the numbering. Starts an ordered list element.

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

Parameters:: numbering - the numbering style.
See Also:: HTML.Tag.OL

numberedList

public void numberedList(int numbering,
                         SinkEventAttributes attributes)

The default list style depends on the numbering. 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:: HTML.Tag.OL

numberedList_

public void numberedList_()

Ends an ordered list element.

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

See Also:: HTML.Tag.OL

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:: HTML.Tag.LI

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.
See Also:: HTML.Tag.LI

numberedListItem_

public void numberedListItem_()

Ends a list item element within an ordered list.

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

See Also:: HTML.Tag.LI

definitionList

public void definitionList()

Starts a definition list element.

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

See Also:: HTML.Tag.DL

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.
See Also:: HTML.Tag.DL

definitionList_

public void definitionList_()

Ends a definition list element.

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

See Also:: HTML.Tag.DL

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.
See Also:: HTML.Tag.DT

definedTerm

public void definedTerm()

Starts a definition term element within a definition list.

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

See Also:: HTML.Tag.DT

definedTerm_

public void definedTerm_()

Starts a definition term element within a definition list.

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

See Also:: HTML.Tag.DT

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:: HTML.Tag.DD

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.
See Also:: HTML.Tag.DD

definition_

public void definition_()

Ends a definition element within a definition list.

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

See Also:: HTML.Tag.DD

figure

public void figure()

Deprecated. Use figure(SinkEventAttributes), this method is only kept for backward compatibility. Note that the behavior is different though, as this method writes an img tag, while correctly the img tag should be written by figureGraphics().

Starts a basic image embedding element.

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

See Also:: HTML.Tag.IMG

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.
See Also:: HTML.Tag.IMG

figure_

public void figure_()

Ends a basic image embedding element.

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

figureGraphics

public void figureGraphics(String name)

Deprecated. Use figureGraphics(String,SinkEventAttributes), this method is only kept for backward compatibility. Note that the behavior is different though, as this method does not write the img tag, only the src attribute.

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)

figureCaption

public void figureCaption()

Deprecated. Use figureCaption(SinkEventAttributes), this method is only kept for backward compatibility. Note that the behavior is different though, as this method only writes an alt attribute.

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_()

Ends a caption of an image.

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

paragraph

public void paragraph()

Starts an element which represents a paragraph.

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

See Also:: HTML.Tag.P

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.
See Also:: HTML.Tag.P

paragraph_

public void paragraph_()

Ends a paragraph element.

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

See Also:: HTML.Tag.P

verbatim

public void verbatim(boolean boxed)

The default class style for boxed is source. 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
See Also:: HTML.Tag.DIV, HTML.Tag.PRE

verbatim

public void verbatim(SinkEventAttributes attributes)

The default class style for boxed is source. 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.
See Also:: HTML.Tag.DIV, HTML.Tag.PRE

verbatim_

public void verbatim_()

Ends a verbatim element.

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

See Also:: HTML.Tag.DIV, HTML.Tag.PRE

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:: HTML.Tag.HR

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.
See Also:: HTML.Tag.HR

table

public void table()

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_()

Ends a table element.

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

See Also:: HTML.Tag.TABLE

tableRows

public void tableRows(int[] justification,
                      boolean grid)

The default class style is bodyTable. The default align is center. 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:: HTML.Tag.TABLE

tableRows_

public void tableRows_()

Ends an element that contains rows of table data.

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

tableRow

public void tableRow()

The default class style is a or b depending the row id. 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:: HTML.Tag.TR

tableRow

public void tableRow(SinkEventAttributes attributes)

The default class style is a or b depending the row id. 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.
See Also:: HTML.Tag.TR

tableRow_

public void tableRow_()

Ends a row element.

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

See Also:: HTML.Tag.TR

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)

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)

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.

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.

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.

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.

tableCell_

public void tableCell_()

Ends a cell element.

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

tableHeaderCell_

public void tableHeaderCell_()

Ends a cell header element.

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

tableCaption

public void tableCaption()

Starts a caption element of a table.

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

See Also:: HTML.Tag.CAPTION

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:: HTML.Tag.CAPTION

tableCaption_

public void tableCaption_()

Ends a caption element of a table.

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

See Also:: HTML.Tag.CAPTION

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:: HTML.Tag.A

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.
See Also:: HTML.Tag.A

anchor_

public void anchor_()

Ends an anchor element.

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

See Also:: HTML.Tag.A

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

See Also:: HTML.Tag.A

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

See Also:: HTML.Tag.I

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

See Also:: HTML.Tag.I

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

See Also:: HTML.Tag.B

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

See Also:: HTML.Tag.B

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

See Also:: HTML.Tag.TT

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

See Also:: HTML.Tag.TT

lineBreak

public void lineBreak()

Adds a line break.

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

See Also:: HTML.Tag.BR

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.
See Also:: HTML.Tag.BR

pageBreak

public void pageBreak()

Adding a new page separator.

Specified by:: pageBreak in interface Sink
Overrides:: pageBreak 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.
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.

rawText

public void rawText(String text)

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.

comment

public void comment(String comment)

Add a comment.

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

Parameters:: comment - The comment to write.

unknown

public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)

Add an unknown event. This can be used to generate html tags for which no corresponding sink event exists.

If HtmlTools.getHtmlTag( name ) does not return null, the corresponding tag will be written.

For example, the div block

  <div class="detail" style="display:inline">text</div>

can be generated via the following event sequence:

  SinkEventAttributeSet atts = new SinkEventAttributeSet();
  atts.addAttribute( SinkEventAttributes.CLASS, "detail" );
  atts.addAttribute( SinkEventAttributes.STYLE, "display:inline" );
  sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_START )}, atts );
  sink.text( "text" );
  sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );

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

Parameters:: name - the name of the event. If this is not a valid xhtml tag name as defined in HtmlMarkup then the event is ignored.; requiredParams - If this is null or the first argument is not an Integer then the event is ignored. The first argument should indicate the type of the unknown event, its integer value should be one of TAG_TYPE_START, TAG_TYPE_END, TAG_TYPE_SIMPLE, ENTITY_TYPE, or CDATA_TYPE, otherwise the event will be ignored.; attributes - a set of attributes for the event. May be null. The attributes will always be written, no validity check is performed.

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

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

content

protected void content(String text)

Write HTML escaped text to output.

Parameters:: text - The text to write.

verbatimContent

protected void verbatimContent(String text)

Write HTML escaped text to output.

Parameters:: text - The text to write.

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)

encodeURL

protected static String encodeURL(String text)

Forward to HtmlTools.encodeURL( text ).

Parameters:: text - the String to encode, may be null.
Returns:: the text encoded, null if null String input.
See Also:: HtmlTools.encodeURL(String)

write

protected void write(String text)

Write a text to the sink.

Specified by:: write in class AbstractXmlSink

Parameters:: text - the given text to write

writeStartTag

protected void writeStartTag(HTML.Tag t,
                             MutableAttributeSet att,
                             boolean isSimpleTag)

Starts a Tag with attributes. For instance:

 <tag attName="attValue">

Overrides:: writeStartTag in class AbstractXmlSink

Parameters:: t - a non null tag.; att - a set of attributes. May be null.; isSimpleTag - boolean to write as a simple tag.

writeEndTag

protected void writeEndTag(HTML.Tag t)

Ends a Tag without writing an EOL. For instance:

</tag>

Overrides:: writeEndTag in class AbstractXmlSink

Parameters:: t - a tag.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.doxia.sink Class XhtmlBaseSink

tableAttributes

tableRows

XhtmlBaseSink

getTextBuffer

setHeadFlag

isHeadFlag

setVerbatimFlag

isVerbatimFlag

setCellJustif

getCellJustif

setCellCount

getCellCount

resetState

init

resetTextBuffer

section

sectionTitle

sectionTitle_

section_

section1

sectionTitle1

sectionTitle1_

section1_

section2

sectionTitle2

sectionTitle2_

section2_

section3

sectionTitle3

sectionTitle3_

section3_

section4

sectionTitle4

sectionTitle4_

section4_

section5

sectionTitle5

sectionTitle5_

section5_

onSection

onSection_

onSectionTitle

onSectionTitle_

list

list

list_

listItem

listItem

listItem_

numberedList

numberedList

numberedList_

numberedListItem

numberedListItem

numberedListItem_

definitionList

definitionList

definitionList_

definedTerm

definedTerm

definedTerm_

definition

definition

definition_

figure

figure

figure_

figureGraphics

figureGraphics

figureCaption

figureCaption

figureCaption_

paragraph

paragraph

paragraph_

verbatim

verbatim

verbatim_

horizontalRule

org.apache.maven.doxia.sink
Class XhtmlBaseSink