Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
 PREV   NEXT FRAMES    NO FRAMES    

Uses of Interface
org.apache.maven.doxia.sink.SinkEventAttributes

Packages that use SinkEventAttributes
org.apache.maven.doxia.macro   
org.apache.maven.doxia.module.apt   
org.apache.maven.doxia.module.confluence   
org.apache.maven.doxia.module.docbook   
org.apache.maven.doxia.module.fo   
org.apache.maven.doxia.module.itext   
org.apache.maven.doxia.module.latex   
org.apache.maven.doxia.module.rtf   
org.apache.maven.doxia.module.twiki   
org.apache.maven.doxia.module.xdoc   
org.apache.maven.doxia.sink Maven Doxia API. 
 

Uses of SinkEventAttributes in org.apache.maven.doxia.macro
 

Methods in org.apache.maven.doxia.macro that return SinkEventAttributes
protected static SinkEventAttributes AbstractMacro.getAttributesFromMap(Map<?,?> parameters)
          Convert the Map of macro parameters to an AttributeSet.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.apt
 

Methods in org.apache.maven.doxia.module.apt with parameters of type SinkEventAttributes
 void AptSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          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. Unkown events just log a warning message but are ignored otherwise.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.confluence
 

Methods in org.apache.maven.doxia.module.confluence with parameters of type SinkEventAttributes
 void ConfluenceSink.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 ConfluenceSink.author(SinkEventAttributes attributes)
          Starts an author element. This is used to identify the author of the document.

Supported attributes are: EMAIL.

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

Supported attributes are the base attributes.

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

Supported attributes are: none.

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

Supported attributes are the base attributes.

 void ConfluenceSink.definition(SinkEventAttributes attributes)
          Not used.
 void ConfluenceSink.definitionList(SinkEventAttributes attributes)
          Not used.
 void ConfluenceSink.definitionListItem(SinkEventAttributes attributes)
          Not used.
 void ConfluenceSink.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 ConfluenceSink.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.

Supported attributes are the base attributes.

 void ConfluenceSink.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 ConfluenceSink.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 ConfluenceSink.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.
 void ConfluenceSink.lineBreak(SinkEventAttributes attributes)
          Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.
 void ConfluenceSink.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 ConfluenceSink.list(SinkEventAttributes attributes)
          Starts an unordered list.

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void ConfluenceSink.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

 void ConfluenceSink.section(int level, SinkEventAttributes attributes)
          Not used.
 void ConfluenceSink.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 ConfluenceSink.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 ConfluenceSink.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 ConfluenceSink.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 ConfluenceSink.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.

Supported attributes are the same as for tableCell.

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

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, VALIGN.
 void ConfluenceSink.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 ConfluenceSink.title(SinkEventAttributes attributes)
          Starts the title element. This is used to identify the document.

Supported attributes are the base attributes.

 void ConfluenceSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          Not used.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.docbook
 

Methods in org.apache.maven.doxia.module.docbook with parameters of type SinkEventAttributes
 void DocBookSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          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. Unknown events just log a warning message but are ignored otherwise.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.fo
 

Methods in org.apache.maven.doxia.module.fo with parameters of type SinkEventAttributes
 void FoSink.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 FoAggregateSink.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 FoSink.author(SinkEventAttributes attributes)
          Starts an author element. This is used to identify the author of the document.

Supported attributes are: EMAIL.

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

Supported attributes are: EMAIL.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are: none.

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

Supported attributes are: none.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void FoSink.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.

 void FoSink.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 FoSink.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.

Supported attributes are the base attributes.

 void FoSink.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 FoAggregateSink.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 FoSink.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 FoAggregateSink.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 FoSink.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.
 void FoSink.lineBreak(SinkEventAttributes attributes)
          Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.
 void FoSink.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 FoAggregateSink.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 FoSink.list(SinkEventAttributes attributes)
          Starts an unordered list.

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void FoSink.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

 void FoSink.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 FoSink.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 FoSink.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 FoSink.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 FoSink.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 FoSink.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.

Supported attributes are the same as for tableCell.

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

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, VALIGN.
 void FoSink.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 FoSink.title(SinkEventAttributes attributes)
          Starts the title element. This is used to identify the document.

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void FoSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          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. Unkown events just log a warning message but are ignored otherwise.
 void FoSink.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.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.itext
 

Methods in org.apache.maven.doxia.module.itext with parameters of type SinkEventAttributes
 void ITextSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          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. Unkown events just log a warning message but are ignored otherwise.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.latex
 

Methods in org.apache.maven.doxia.module.latex with parameters of type SinkEventAttributes
 void LatexSink.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 LatexSink.author(SinkEventAttributes attributes)
          Starts an author element. This is used to identify the author of the document.

Supported attributes are: EMAIL.

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

Supported attributes are the base attributes.

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

Supported attributes are: none.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void LatexSink.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.

 void LatexSink.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 LatexSink.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.

Supported attributes are the base attributes.

 void LatexSink.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 LatexSink.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 LatexSink.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.
 void LatexSink.lineBreak(SinkEventAttributes attributes)
          Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.
 void LatexSink.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 LatexSink.list(SinkEventAttributes attributes)
          Starts an unordered list.

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void LatexSink.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

 void LatexSink.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 LatexSink.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 LatexSink.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 LatexSink.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 LatexSink.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.

Supported attributes are the same as for tableCell.

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

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, VALIGN.
 void LatexSink.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 LatexSink.title(SinkEventAttributes attributes)
          Starts the title element. This is used to identify the document.

Supported attributes are the base attributes.

 void LatexSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          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. Unkown events just log a warning message but are ignored otherwise.
 void LatexSink.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.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.rtf
 

Methods in org.apache.maven.doxia.module.rtf with parameters of type SinkEventAttributes
 void RtfSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          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. Unkown events just log a warning message but are ignored otherwise.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.twiki
 

Methods in org.apache.maven.doxia.module.twiki with parameters of type SinkEventAttributes
 void TWikiSink.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 TWikiSink.author(SinkEventAttributes attributes)
          Starts an author element. This is used to identify the author of the document.

Supported attributes are: EMAIL.

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

Supported attributes are the base attributes.

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

Supported attributes are: none.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void TWikiSink.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.

 void TWikiSink.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 TWikiSink.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.

Supported attributes are the base attributes.

 void TWikiSink.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 TWikiSink.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 TWikiSink.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.
 void TWikiSink.lineBreak(SinkEventAttributes attributes)
          Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.
 void TWikiSink.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 TWikiSink.list(SinkEventAttributes attributes)
          Starts an unordered list.

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

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

Supported attributes are the base attributes.

 void TWikiSink.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

 void TWikiSink.section(int level, SinkEventAttributes attributes)
          Not used.
 void TWikiSink.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 TWikiSink.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 TWikiSink.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 TWikiSink.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 TWikiSink.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.

Supported attributes are the same as for tableCell.

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

Supported attributes are the base attributes plus:

ALIGN, BGCOLOR, VALIGN.
 void TWikiSink.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 TWikiSink.title(SinkEventAttributes attributes)
          Starts the title element. This is used to identify the document.

Supported attributes are the base attributes.

 void TWikiSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          Not used.
 void TWikiSink.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.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.module.xdoc
 

Methods in org.apache.maven.doxia.module.xdoc with parameters of type SinkEventAttributes
 void XdocSink.body(SinkEventAttributes attributes)
          Starts the body of a document. This contains the document's content.

Supported attributes are the base attributes.

 void XdocSink.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.
protected  void XdocSink.onSection(int depth, SinkEventAttributes attributes)
          Starts a section. Starts a section.
protected  void XdocSink.onSectionTitle(int depth, SinkEventAttributes attributes)
          Starts a section title. Starts a section title.
 void XdocSink.verbatim(SinkEventAttributes attributes)
          The default class style for boxed is source.
 

Uses of SinkEventAttributes in org.apache.maven.doxia.sink
 

Classes in org.apache.maven.doxia.sink that implement SinkEventAttributes
 class SinkEventAttributeSet
          Implementation of MutableAttributeSet using a LinkedHashMap.
 

Fields in org.apache.maven.doxia.sink declared as SinkEventAttributes
static SinkEventAttributes SinkEventAttributeSet.BOLD
          An unmodifiable attribute set containing only a bold attribute.
static SinkEventAttributes SinkEventAttributeSet.BOXED
          An unmodifiable attribute set containing only a boxed attribute.
static SinkEventAttributes SinkEventAttributeSet.CENTER
          An unmodifiable attribute set containing only a center attribute.
static SinkEventAttributes SinkEventAttributeSet.ITALIC
          An unmodifiable attribute set containing only an italic attribute.
static SinkEventAttributes SinkEventAttributeSet.JUSTIFY
          An unmodifiable attribute set containing only a justify attribute.
static SinkEventAttributes SinkEventAttributeSet.LEFT
          An unmodifiable attribute set containing only a left attribute.
static SinkEventAttributes SinkEventAttributeSet.LINETHROUGH
          An unmodifiable attribute set containing only a linethrough attribute.
static SinkEventAttributes SinkEventAttributeSet.MONOSPACED
          An unmodifiable attribute set containing only a monospaced attribute.
static SinkEventAttributes SinkEventAttributeSet.OVERLINE
          An unmodifiable attribute set containing only an overline attribute.
static SinkEventAttributes SinkEventAttributeSet.RIGHT
          An unmodifiable attribute set containing only a right attribute.
static SinkEventAttributes SinkEventAttributeSet.UNDERLINE
          An unmodifiable attribute set containing only an underline attribute.
 

Methods in org.apache.maven.doxia.sink with parameters of type SinkEventAttributes
 void XhtmlBaseSink.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 SinkAdapter.anchor(String name, SinkEventAttributes attributes)
          Starts an element which defines an anchor.
 void RandomAccessSink.anchor(String name, SinkEventAttributes attributes)
          Starts an element which defines an anchor.
 void Sink.anchor(String name, SinkEventAttributes attributes)
          Starts an element which defines an anchor.
 void SinkAdapter.author(SinkEventAttributes attributes)
          Starts an author element.
 void RandomAccessSink.author(SinkEventAttributes attributes)
          Starts an author element.
 void Sink.author(SinkEventAttributes attributes)
          Starts an author element.
 void SinkAdapter.body(SinkEventAttributes attributes)
          Starts the body of a document.
 void RandomAccessSink.body(SinkEventAttributes attributes)
          Starts the body of a document.
 void Sink.body(SinkEventAttributes attributes)
          Starts the body of a document.
 void SinkAdapter.date(SinkEventAttributes attributes)
          Starts the date element.
 void RandomAccessSink.date(SinkEventAttributes attributes)
          Starts the date element.
 void Sink.date(SinkEventAttributes attributes)
          Starts the date element.
 void XhtmlBaseSink.definedTerm(SinkEventAttributes attributes)
          Starts a definition term element within a definition list.

Supported attributes are the base attributes.

 void SinkAdapter.definedTerm(SinkEventAttributes attributes)
          Starts a definition term element within a definition list.
 void RandomAccessSink.definedTerm(SinkEventAttributes attributes)
          Starts a definition term element within a definition list.
 void Sink.definedTerm(SinkEventAttributes attributes)
          Starts a definition term element within a definition list.
 void XhtmlBaseSink.definition(SinkEventAttributes attributes)
          Starts a definition element within a definition list.

Supported attributes are the base attributes.

 void SinkAdapter.definition(SinkEventAttributes attributes)
          Starts a definition element within a definition list.
 void RandomAccessSink.definition(SinkEventAttributes attributes)
          Starts a definition element within a definition list.
 void Sink.definition(SinkEventAttributes attributes)
          Starts a definition element within a definition list.
 void XhtmlBaseSink.definitionList(SinkEventAttributes attributes)
          Starts a definition list.

Supported attributes are the base attributes.

 void SinkAdapter.definitionList(SinkEventAttributes attributes)
          Starts a definition list.
 void RandomAccessSink.definitionList(SinkEventAttributes attributes)
          Starts a definition list.
 void Sink.definitionList(SinkEventAttributes attributes)
          Starts a definition list.
 void SinkAdapter.definitionListItem(SinkEventAttributes attributes)
          Starts a list item element within a definition list.
 void RandomAccessSink.definitionListItem(SinkEventAttributes attributes)
          Starts a list item element within a definition list.
 void Sink.definitionListItem(SinkEventAttributes attributes)
          Starts a list item element within a definition list.
 void XhtmlBaseSink.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 SinkAdapter.figure(SinkEventAttributes attributes)
          Starts a basic image embedding element.
 void RandomAccessSink.figure(SinkEventAttributes attributes)
          Starts a basic image embedding element.
 void Sink.figure(SinkEventAttributes attributes)
          Starts a basic image embedding element.
 void XhtmlBaseSink.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.

Supported attributes are the base attributes.

 void SinkAdapter.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.
 void RandomAccessSink.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.
 void Sink.figureCaption(SinkEventAttributes attributes)
          Starts a figure caption.
 void XhtmlBaseSink.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 SinkAdapter.figureGraphics(String src, SinkEventAttributes attributes)
          Adds a graphic element.
 void RandomAccessSink.figureGraphics(String src, SinkEventAttributes attributes)
          Adds a graphic element.
 void Sink.figureGraphics(String src, SinkEventAttributes attributes)
          Adds a graphic element.
 void SinkAdapter.head(SinkEventAttributes attributes)
          Starts the head element.
 void RandomAccessSink.head(SinkEventAttributes attributes)
          Starts the head element.
 void Sink.head(SinkEventAttributes attributes)
          Starts the head element.
 void XhtmlBaseSink.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.

Supported attributes are the base attributes plus:

ALIGN, NOSHADE, SIZE, WIDTH.
 void SinkAdapter.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.
 void RandomAccessSink.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.
 void Sink.horizontalRule(SinkEventAttributes attributes)
          Adds a horizontal separator rule.
 void XhtmlBaseSink.lineBreak(SinkEventAttributes attributes)
          Adds a line break.

Supported attributes are:

ID, CLASS, TITLE, STYLE.
 void SinkAdapter.lineBreak(SinkEventAttributes attributes)
          Adds a line break.
 void RandomAccessSink.lineBreak(SinkEventAttributes attributes)
          Adds a line break.
 void Sink.lineBreak(SinkEventAttributes attributes)
          Adds a line break.
 void XhtmlBaseSink.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 SinkAdapter.link(String name, SinkEventAttributes attributes)
          Starts a link.
 void RandomAccessSink.link(String name, SinkEventAttributes attributes)
          Starts a link.
 void Sink.link(String name, SinkEventAttributes attributes)
          Starts a link.
 void XhtmlBaseSink.list(SinkEventAttributes attributes)
          Starts an unordered list.

Supported attributes are the base attributes.

 void SinkAdapter.list(SinkEventAttributes attributes)
          Starts an unordered list.
 void RandomAccessSink.list(SinkEventAttributes attributes)
          Starts an unordered list.
 void Sink.list(SinkEventAttributes attributes)
          Starts an unordered list.
 void XhtmlBaseSink.listItem(SinkEventAttributes attributes)
          Starts a list item element within an unordered list.

Supported attributes are the base attributes.

 void SinkAdapter.listItem(SinkEventAttributes attributes)
          Starts a list item element within an unordered list.
 void RandomAccessSink.listItem(SinkEventAttributes attributes)
          Starts a list item element within an unordered list.
 void Sink.listItem(SinkEventAttributes attributes)
          Starts a list item element within an unordered list.
 void XhtmlBaseSink.numberedList(int numbering, SinkEventAttributes attributes)
          The default list style depends on the numbering.
 void SinkAdapter.numberedList(int numbering, SinkEventAttributes attributes)
          Starts an ordered list element.
 void RandomAccessSink.numberedList(int numbering, SinkEventAttributes attributes)
          Starts an ordered list element.
 void Sink.numberedList(int numbering, SinkEventAttributes attributes)
          Starts an ordered list element.
 void XhtmlBaseSink.numberedListItem(SinkEventAttributes attributes)
          Starts a list item element within an ordered list.

Supported attributes are the base attributes.

 void SinkAdapter.numberedListItem(SinkEventAttributes attributes)
          Starts a list item element within an ordered list.
 void RandomAccessSink.numberedListItem(SinkEventAttributes attributes)
          Starts a list item element within an ordered list.
 void Sink.numberedListItem(SinkEventAttributes attributes)
          Starts a list item element within an ordered list.
protected  void XhtmlBaseSink.onSection(int depth, SinkEventAttributes attributes)
          Starts a section.
protected  void XhtmlBaseSink.onSectionTitle(int depth, SinkEventAttributes attributes)
          Starts a section title.
 void XhtmlBaseSink.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.

Supported attributes are the base attributes plus ALIGN.

 void SinkAdapter.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.
 void RandomAccessSink.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.
 void Sink.paragraph(SinkEventAttributes attributes)
          Starts a paragraph.
 void XhtmlBaseSink.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 SinkAdapter.section(int level, SinkEventAttributes attributes)
          Start a new section at the given level.
 void RandomAccessSink.section(int level, SinkEventAttributes attributes)
          Start a new section at the given level.
 void Sink.section(int level, SinkEventAttributes attributes)
          Start a new section at the given level.
 void XhtmlBaseSink.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 SinkAdapter.sectionTitle(int level, SinkEventAttributes attributes)
          Start a new section title at the given level.
 void RandomAccessSink.sectionTitle(int level, SinkEventAttributes attributes)
          Start a new section title at the given level.
 void Sink.sectionTitle(int level, SinkEventAttributes attributes)
          Start a new section title at the given level.
 void XhtmlBaseSink.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 SinkAdapter.table(SinkEventAttributes attributes)
          Starts a table.
 void RandomAccessSink.table(SinkEventAttributes attributes)
          Starts a table.
 void Sink.table(SinkEventAttributes attributes)
          Starts a table.
 void XhtmlBaseSink.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 SinkAdapter.tableCaption(SinkEventAttributes attributes)
          Starts a table caption.
 void RandomAccessSink.tableCaption(SinkEventAttributes attributes)
          Starts a table caption.
 void Sink.tableCaption(SinkEventAttributes attributes)
          Starts a table caption.
 void XhtmlBaseSink.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 SinkAdapter.tableCell(SinkEventAttributes attributes)
          Starts a table cell.
 void RandomAccessSink.tableCell(SinkEventAttributes attributes)
          Starts a table cell.
 void Sink.tableCell(SinkEventAttributes attributes)
          Starts a table cell.
 void XhtmlBaseSink.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.

Supported attributes are the same as for tableCell.

 void SinkAdapter.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.
 void RandomAccessSink.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.
 void Sink.tableHeaderCell(SinkEventAttributes attributes)
          Starts a table header cell.
 void XhtmlBaseSink.tableRow(SinkEventAttributes attributes)
          The default class style is a or b depending the row id.
 void SinkAdapter.tableRow(SinkEventAttributes attributes)
          Starts a table row.
 void RandomAccessSink.tableRow(SinkEventAttributes attributes)
          Starts a table row.
 void Sink.tableRow(SinkEventAttributes attributes)
          Starts a table row.
 void XhtmlBaseSink.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 SinkAdapter.text(String text, SinkEventAttributes attributes)
          Adds a text.
 void RandomAccessSink.text(String text, SinkEventAttributes attributes)
          Adds a text.
 void Sink.text(String text, SinkEventAttributes attributes)
          Adds a text.
 void SinkAdapter.title(SinkEventAttributes attributes)
          Starts the title element.
 void RandomAccessSink.title(SinkEventAttributes attributes)
          Starts the title element.
 void Sink.title(SinkEventAttributes attributes)
          Starts the title element.
 void XhtmlBaseSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          Add an unknown event.
 void SinkAdapter.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          Add an unknown event.
 void RandomAccessSink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          Add an unknown event.
 void Sink.unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
          Add an unknown event.
 void XhtmlBaseSink.verbatim(SinkEventAttributes attributes)
          The default class style for boxed is source.
 void SinkAdapter.verbatim(SinkEventAttributes attributes)
          Starts a verbatim block, ie a block where whitespace has semantic relevance.
 void RandomAccessSink.verbatim(SinkEventAttributes attributes)
          Starts a verbatim block, ie a block where whitespace has semantic relevance.
 void Sink.verbatim(SinkEventAttributes attributes)
          Starts a verbatim block, ie a block where whitespace has semantic relevance.
 

Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
 PREV   NEXT FRAMES    NO FRAMES    
Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.