Interface Sink
- All Superinterfaces:
AutoCloseable
- All Known Subinterfaces:
BufferingSinkProxyFactory.BufferingSink
- All Known Implementing Classes:
AbstractSink
,AbstractTextSink
,AbstractXhtml5Sink
,AbstractXmlSink
,AptSink
,CreateAnchorsForIndexEntries
,IndexingSink
,MarkdownSink
,RandomAccessSink
,SinkAdapter
,SinkWrapper
,UniqueAnchorNamesValidator
,XdocSink
,Xhtml5BaseSink
,Xhtml5Sink
Doxia allows you to transform any supported input document format (ie for which a Parser exists) into any supported output document format (ie for which a Sink exists).
A parser is responsible for reading an input document and emitting a sequence of Doxia events which can then be consumed by a Doxia Sink. Thus, you can parse any front- end format (eg APT, FML, Xdoc, ...) and have them all contribute to a final XHTML version of a web site. All documents being parsed result in a stream of Doxia events (eg paragraph, bold, italic, text,...), which are then fed into a XHTML Sink to produce a set of XHTML pages.
A Sink is ultimately responsible for the final format and structure of the output document. For example, you can take a collection of APT documents, let a Parser emit a series of Doxia events and have that be fed into a Sink to produce a single PDF, a book, a site, or a Word document. The Sink is fully responsible for the final output.
You can easily integrate any custom (XML, Wiki,...) format by creating a Doxia Parser which reads your input document and produces a proper sequence of Doxia events. Those can then be fed into an arbitrary Sink to produce any desired final output.
Note: All implemented sink should use UTF-8 as encoding.
- Since:
- 1.0-alpha-6
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Center alignment for table cells.static final int
Left alignment for table cells.static final int
Right alignment for table cells.static final int
A numbering to handle a number list.static final int
A numbering to handle a lower alpha list.static final int
A numbering to handle a lower roman list.static final int
A numbering to handle a upper alpha list.static final int
A numbering to handle a upper roman list.static final int
A level 1 section (section).static final int
A level 2 section (subsection).static final int
A level 3 section (sub-subsection).static final int
A level 4 section (sub-sub-subsection).static final int
A level 5 section (sub-sub-sub-subsection).static final int
A level 6 section. -
Method Summary
Modifier and TypeMethodDescriptionvoid
address()
Starts an address element.void
address
(SinkEventAttributes attributes) Starts an address element.void
address_()
Ends an address element.void
Starts an element which defines an anchor.void
anchor
(String name, SinkEventAttributes attributes) Starts an element which defines an anchor.void
anchor_()
Ends an anchor element.void
article()
Starts an article within a document.void
article
(SinkEventAttributes attributes) Starts an article within a document.void
article_()
Ends the article element.void
author()
Starts an author element.void
author
(SinkEventAttributes attributes) Starts an author element.void
author_()
Ends an author element.void
Starts a blockquote element.void
blockquote
(SinkEventAttributes attributes) Starts a blockquote element.void
Ends an blockquote element.void
body()
Starts the body of a document.void
body
(SinkEventAttributes attributes) Starts the body of a document.void
body_()
Ends the body element.void
bold()
Starts a bold element.void
bold_()
Ends a bold element.void
close()
Close the writer or the stream, if needed.void
Add a comment.void
content()
Start the main content section between the header and the footer within the sections and/or body.void
content
(SinkEventAttributes attributes) Start the main content section between the header and the footer within the sections and/or body.void
content_()
Ends a main content section.void
Starts a data element which groups together other elements representing microformats.void
data
(String value, SinkEventAttributes attributes) Starts a data element which groups together other elements representing microformats.void
data_()
Ends an data element.void
date()
Starts the date element.void
date
(SinkEventAttributes attributes) Starts the date element.void
date_()
Ends the date element.void
Starts a definition term element within a definition list.void
definedTerm
(SinkEventAttributes attributes) Starts a definition term element within a definition list.void
Ends a definition term element within a definition list.void
Starts a definition element within a definition list.void
definition
(SinkEventAttributes attributes) Starts a definition element within a definition list.void
Ends a definition element within a definition list.void
Starts a definition list element.void
definitionList
(SinkEventAttributes attributes) Starts a definition list.void
Ends a definition list element.void
Starts a list item element within a definition list.void
definitionListItem
(SinkEventAttributes attributes) Starts a list item element within a definition list.void
Ends a list item element within a definition list.void
division()
Starts a division element grouping together other elements.void
division
(SinkEventAttributes attributes) Starts a division element grouping together other elements.void
Ends a division element.void
figure()
Starts a basic image embedding element.void
figure
(SinkEventAttributes attributes) Starts a basic image embedding element.void
figure_()
Ends a basic image embedding element.void
Starts a caption of an image element.void
figureCaption
(SinkEventAttributes attributes) Starts a figure caption.void
Ends a caption of an image.void
figureGraphics
(String src) Adds a graphic element.void
figureGraphics
(String src, SinkEventAttributes attributes) Adds a graphic element.void
flush()
Flush the writer or the stream, if needed.void
footer()
Start a new footer within the section or body.void
footer
(SinkEventAttributes attributes) Start a new footer within the section or body.void
footer_()
Ends a footer element.default Locator
Returns the locator which exposes location information for a particular Sink event.void
head()
Starts the head element.void
head
(SinkEventAttributes attributes) Starts the head element.void
head_()
Ends the head element.void
header()
Start a new header within the section or body.void
header
(SinkEventAttributes attributes) Start a new header within the section or body.void
header_()
Ends a header element.void
Adding a separator of sections from a text to each other.void
horizontalRule
(SinkEventAttributes attributes) Adds a horizontal separator rule.void
inline()
Starts an inline element.void
inline
(SinkEventAttributes attributes) Starts an inline element.void
inline_()
Ends an inline element.void
italic()
Starts an italic element.void
italic_()
Ends an italic element.void
Adds a line break.void
lineBreak
(SinkEventAttributes attributes) Adds a line break.void
Adds a line break opportunity.void
lineBreakOpportunity
(SinkEventAttributes attributes) Adds a line break opportunity.void
Starts an element which defines a link.void
link
(String name, SinkEventAttributes attributes) Starts a link.void
link_()
Ends a link element.void
list()
Starts an unordered list element.void
list
(SinkEventAttributes attributes) Starts an unordered list.void
list_()
Ends an unordered list element.void
listItem()
Starts a list item element within an unordered list.void
listItem
(SinkEventAttributes attributes) Starts a list item element within an unordered list.void
Ends a list item element within an unordered list.void
Starts a monospaced element.void
Ends a monospaced element.void
Starts a navigation section within a document.void
navigation
(SinkEventAttributes attributes) Starts a navigation section within a document.void
Ends the navigation element.void
Adding a non breaking space, ie a space without any special formatting operations.void
numberedList
(int numbering) Starts an ordered list element.void
numberedList
(int numbering, SinkEventAttributes attributes) Starts an ordered list element.void
Ends an ordered list element.void
Starts a list item element within an ordered list.void
numberedListItem
(SinkEventAttributes attributes) Starts a list item element within an ordered list.void
Ends a list item element within an ordered list.void
Adding a new page separator.void
Starts an element which represents a paragraph.void
paragraph
(SinkEventAttributes attributes) Starts a paragraph.void
Ends a paragraph element.void
Adding a raw text, ie a text without any special formatting operations.void
section
(int level, SinkEventAttributes attributes) Start a new section at the given level.void
section_
(int level) Ends a section at the given level.void
section1()
Starts a first heading element which contains the topic of the section.void
Ends a first heading element.void
section2()
Starts a second heading element which contains the topic of the section.void
Ends a second heading element.void
section3()
Starts a third heading element which contains the topic of the section.void
Ends a third heading element.void
section4()
Starts a 4th heading element which contains the topic of the section.void
Ends a 4th heading element.void
section5()
Starts a 5th heading element which contains the topic of the section.void
Ends a 5th heading element.void
section6()
Starts a 6th heading element which contains the topic of the section.void
Ends a 6th heading element.void
Starts a title heading element.void
sectionTitle
(int level, SinkEventAttributes attributes) Start a new section title at the given level.void
Ends a title heading element.void
sectionTitle_
(int level) Ends a section title at the given level.void
Starts a first title heading element.void
Ends a first title heading element.void
Starts a second title heading element.void
Ends a second title heading element.void
Starts a third title heading element.void
Ends a third title heading element.void
Starts a 4th title heading element.void
Ends a 4th title heading element.void
Starts a 5th title heading element.void
Ends a 5th title heading element.void
Starts a 6th title heading element.void
Ends a 6th title heading element.default void
setDocumentLocator
(Locator locator) Sets the locator which exposes location information for a particular Sink event.void
sidebar()
Starts a sidebar section within a document.void
sidebar
(SinkEventAttributes attributes) Starts a sidebar section within a document.void
sidebar_()
Ends the sidebar element.void
table()
Starts a table element for marking up tabular information in a document.void
table
(SinkEventAttributes attributes) Starts a table.void
table_()
Ends a table element.void
Starts a caption element of a table.void
tableCaption
(SinkEventAttributes attributes) Starts a table caption.void
Ends a caption element of a table.void
Starts a cell element which defines a cell that contains data.void
tableCell
(SinkEventAttributes attributes) Starts a table cell.void
Ends a cell element.void
Starts a cell element which defines a cell that contains header information.void
tableHeaderCell
(SinkEventAttributes attributes) Starts a table header cell.void
Ends a cell header element.void
tableRow()
Starts a row element which acts as a container for a row of table cells.void
tableRow
(SinkEventAttributes attributes) Starts a table row.void
Ends a row element.void
Starts an element that contains rows of table data.void
tableRows
(int[] justification, boolean grid) Starts an element that contains rows of table data.void
Ends an element that contains rows of table data.void
Adding a text.void
text
(String text, SinkEventAttributes attributes) Adds a text.void
Starts a time element which groups together other elements representing a time.void
time
(String datetime, SinkEventAttributes attributes) Starts a time element which groups together other elements representing a time.void
time_()
Ends a time element.void
title()
Starts the title element.void
title
(SinkEventAttributes attributes) Starts the title element.void
title_()
Ends the title element.void
unknown
(String name, Object[] requiredParams, SinkEventAttributes attributes) Add an unknown event.void
verbatim()
Starts a verbatim block, ie a block where whitespace has semantic relevance.void
verbatim
(SinkEventAttributes attributes) Starts a verbatim block, ie a block where whitespace has semantic relevance.void
Ends a verbatim element.
-
Field Details
-
NUMBERING_DECIMAL
static final int NUMBERING_DECIMALA numbering to handle a number list.- See Also:
-
NUMBERING_LOWER_ALPHA
static final int NUMBERING_LOWER_ALPHAA numbering to handle a lower alpha list.- See Also:
-
NUMBERING_UPPER_ALPHA
static final int NUMBERING_UPPER_ALPHAA numbering to handle a upper alpha list.- See Also:
-
NUMBERING_LOWER_ROMAN
static final int NUMBERING_LOWER_ROMANA numbering to handle a lower roman list.- See Also:
-
NUMBERING_UPPER_ROMAN
static final int NUMBERING_UPPER_ROMANA numbering to handle a upper roman list.- See Also:
-
SECTION_LEVEL_1
static final int SECTION_LEVEL_1A level 1 section (section).- See Also:
-
SECTION_LEVEL_2
static final int SECTION_LEVEL_2A level 2 section (subsection).- See Also:
-
SECTION_LEVEL_3
static final int SECTION_LEVEL_3A level 3 section (sub-subsection).- See Also:
-
SECTION_LEVEL_4
static final int SECTION_LEVEL_4A level 4 section (sub-sub-subsection).- See Also:
-
SECTION_LEVEL_5
static final int SECTION_LEVEL_5A level 5 section (sub-sub-sub-subsection).- See Also:
-
SECTION_LEVEL_6
static final int SECTION_LEVEL_6A level 6 section.- Since:
- 2.0.0
- See Also:
-
JUSTIFY_CENTER
static final int JUSTIFY_CENTERCenter alignment for table cells.- See Also:
-
JUSTIFY_LEFT
static final int JUSTIFY_LEFTLeft alignment for table cells.- See Also:
-
JUSTIFY_RIGHT
static final int JUSTIFY_RIGHTRight alignment for table cells.- See Also:
-
-
Method Details
-
head
void head()Starts the head element. Shortcut forhead(SinkEventAttributes)
with first argument beingnull
.- See Also:
-
head
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
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
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
head_
void head_()Ends the head element. -
title
void title()Starts the title element. Shortcut fortitle(SinkEventAttributes)
with first argument beingnull
.- See Also:
-
title
Starts the title element. This is used to identify the document.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
title_
void title_()Ends the title element. -
author
void author()Starts an author element. Shortcut forauthor(SinkEventAttributes)
with first argument beingnull
.- See Also:
-
author
Starts an author element. This is used to identify the author of the document.Supported attributes are:
EMAIL
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
author_
void author_()Ends an author element. -
date
void date()Starts the date element. Shortcut fordate(SinkEventAttributes)
with first argument beingnull
.- See Also:
-
date
Starts the date element. This is used to identify the date of the document: there is no strict definition if it is creation date or last modification date, which are the 2 classical semantics. There is no formal formatting requirements either.
The date is recommended (but it is not a requirement) to be aligned to the ISO-8601 standard, i.e.:YYYY-MM-DD
whereYYYY
is the year in the Gregorian calendar,MM
is the month of the year between 01 (January) and 12 (December),- and
DD
is the day of the month between 01 and 31.
Supported attributes are: none.
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
date_
void date_()Ends the date element. -
body
void body()Starts the body of a document. Shortcut forbody(SinkEventAttributes)
with first argument beingnull
.- See Also:
-
body
Starts the body of a document. This contains the document's content.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
body_
void body_()Ends the body element. -
article
void article()Starts an article within a document. Shortcut forarticle(SinkEventAttributes)
with first argument beingnull
.- See Also:
-
article
Starts an article within a document.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
article_
void article_()Ends the article element. -
sidebar
void sidebar()Starts a sidebar section within a document. Shortcut forsidebar(SinkEventAttributes)
with first argument beingnull
.- See Also:
-
sidebar
Starts a sidebar section within a document.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
sidebar_
void sidebar_()Ends the sidebar element. -
sectionTitle
void sectionTitle()Starts a title heading element. Shortcut forsectionTitle(int, SinkEventAttributes)
with first argument being0
and second argument beingnull
. -
sectionTitle_
void sectionTitle_()Ends a title heading element. Shortcut forsectionTitle_(int)
with argument being0
. -
section1
void section1()Starts a first heading element which contains the topic of the section. Shortcut forsection(int, SinkEventAttributes)
with first argument being1
and second argument beingnull
.- See Also:
-
section1_
void section1_()Ends a first heading element. Shortcut forsection_(int)
with argument being1
. -
sectionTitle1
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 asection1()
element.Shortcut for
sectionTitle(int, SinkEventAttributes)
with first argument being1
and second argument beingnull
.- See Also:
-
sectionTitle1_
void sectionTitle1_()Ends a first title heading element. Shortcut forsectionTitle_(int)
with argument being1
. -
section2
void section2()Starts a second heading element which contains the topic of the section. This has to be contained within asection1()
element.Shortcut for
section(int, SinkEventAttributes)
with first argument being2
and second argument beingnull
.- See Also:
-
section2_
void section2_()Ends a second heading element. Shortcut forsection_(int)
with argument being2
. -
sectionTitle2
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 asection2()
element.Shortcut for
sectionTitle(int, SinkEventAttributes)
with first argument being2
and second argument beingnull
.- See Also:
-
sectionTitle2_
void sectionTitle2_()Ends a second title heading element. Shortcut forsectionTitle_(int)
with argument being2
. -
section3
void section3()Starts a third heading element which contains the topic of the section. This has to be contained within asection2()
element.Shortcut for
section(int, SinkEventAttributes)
with first argument being3
and second argument beingnull
.- See Also:
-
section3_
void section3_()Ends a third heading element. Shortcut forsection_(int)
with argument being3
. -
sectionTitle3
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 asection3()
element.Shortcut for
sectionTitle(int, SinkEventAttributes)
with first argument being3
and second argument beingnull
.- See Also:
-
sectionTitle3_
void sectionTitle3_()Ends a third title heading element. Shortcut forsectionTitle_(int)
with argument being3
. -
section4
void section4()Starts a 4th heading element which contains the topic of the section. This has to be contained within asection3()
element.Shortcut for
section(int, SinkEventAttributes)
with first argument being4
and second argument beingnull
.- See Also:
-
section4_
void section4_()Ends a 4th heading element. Shortcut forsection_(int)
with argument being4
. -
sectionTitle4
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 asection4()
element.Shortcut for
sectionTitle(int, SinkEventAttributes)
with first argument being4
and second argument beingnull
.- See Also:
-
sectionTitle4_
void sectionTitle4_()Ends a 4th title heading element. Shortcut forsectionTitle_(int)
with argument being4
. -
section5
void section5()Starts a 5th heading element which contains the topic of the section. This has to be contained within asection5()
element.Shortcut for
section(int, SinkEventAttributes)
with first argument being5
and second argument beingnull
.- See Also:
-
section5_
void section5_()Ends a 5th heading element. Shortcut forsection_(int)
with argument being5
. -
sectionTitle5
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 asection5()
element.Shortcut for
sectionTitle(int, SinkEventAttributes)
with first argument being5
and second argument beingnull
.- See Also:
-
sectionTitle5_
void sectionTitle5_()Ends a 5th title heading element. Shortcut forsectionTitle_(int)
with argument being5
.- Since:
- 2.0.0
-
section6
void section6()Starts a 6th heading element which contains the topic of the section. This has to be contained within asection6()
element.Shortcut for
section(int, SinkEventAttributes)
with first argument being6
and second argument beingnull
.- Since:
- 2.0.0
- See Also:
-
section6_
void section6_()Ends a 6th heading element. Shortcut forsection_(int)
with argument being6
.- Since:
- 2.0.0
-
sectionTitle6
void sectionTitle6()Starts a 6th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within asection5()
element.Shortcut for
sectionTitle(int, SinkEventAttributes)
with first argument being6
and second argument beingnull
.- Since:
- 2.0.0
- See Also:
-
sectionTitle6_
void sectionTitle6_()Ends a 6th title heading element. Shortcut forsectionTitle_(int)
with argument being6
.- Since:
- 2.0.0
-
section
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
.- Parameters:
level
- the section level (must be a value between 1 and 6).attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
section_
void section_(int level) Ends a section at the given level. -
sectionTitle
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
plusALIGN
.- Parameters:
level
- the section title level (must be a value between 1 and 6).attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
sectionTitle_
void sectionTitle_(int level) Ends a section title at the given level. -
header
void header()Start a new header within the section or body. Shortcut forheader(SinkEventAttributes)
with argument beingnull
. -
header
Start a new header within the section or body.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
header_
void header_()Ends a header element. -
content
void content()Start the main content section between the header and the footer within the sections and/or body. Shortcut forcontent(SinkEventAttributes)
with argument beingnull
. -
content
Start the main content section between the header and the footer within the sections and/or body.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
content_
void content_()Ends a main content section. -
list
void list()Starts an unordered list element. Shortcut forlist(SinkEventAttributes)
with argument beingnull
.- See Also:
-
list
Starts an unordered list.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
list_
void list_()Ends an unordered list element. -
listItem
void listItem()Starts a list item element within an unordered list. Shortcut forlistItem(SinkEventAttributes)
with argument beingnull
.- See Also:
-
listItem
Starts a list item element within an unordered list.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
listItem_
void listItem_()Ends a list item element within an unordered list. -
numberedList
void numberedList(int numbering) Starts an ordered list element. Shortcut fornumberedList(int, SinkEventAttributes)
with first argument beingnumbering
and second argument beingnull
.- Parameters:
numbering
- the numbering style.- See Also:
-
numberedList
Starts an ordered list element.Supported attributes are the
base attributes
.- Parameters:
numbering
- the numbering style.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
numberedList_
void numberedList_()Ends an ordered list element. -
numberedListItem
void numberedListItem()Starts a list item element within an ordered list. Shortcut fornumberedListItem(SinkEventAttributes)
with argument beingnull
.- See Also:
-
numberedListItem
Starts a list item element within an ordered list.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
numberedListItem_
void numberedListItem_()Ends a list item element within an ordered list. -
definitionList
void definitionList()Starts a definition list element. Shortcut fordefinitionList(SinkEventAttributes)
with argument beingnull
.- See Also:
-
definitionList
Starts a definition list.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
definitionList_
void definitionList_()Ends a definition list element. -
definitionListItem
void definitionListItem()Starts a list item element within a definition list. Shortcut fordefinitionListItem(SinkEventAttributes)
with argument beingnull
.- See Also:
-
definitionListItem
Starts a list item element within a definition list.Every definitionListItem has to contain exactly one
definedTerm(SinkEventAttributes)
and onedefinition(SinkEventAttributes)
, in this order.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
definitionListItem_
void definitionListItem_()Ends a list item element within a definition list. -
definition
void definition()Starts a definition element within a definition list. Shortcut fordefinition(SinkEventAttributes)
with argument beingnull
.- See Also:
-
definition
Starts a definition element within a definition list.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
definition_
void definition_()Ends a definition element within a definition list. -
definedTerm
void definedTerm()Starts a definition term element within a definition list. Shortcut fordefinedTerm(SinkEventAttributes)
with argument beingnull
.- See Also:
-
definedTerm
Starts a definition term element within a definition list.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
definedTerm_
void definedTerm_()Ends a definition term element within a definition list. -
figure
void figure()Starts a basic image embedding element. Shortcut forfigure(SinkEventAttributes)
with argument beingnull
.- See Also:
-
figure
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
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
figure_
void figure_()Ends a basic image embedding element. -
figureCaption
void figureCaption()Starts a caption of an image element. Shortcut forfigureCaption(SinkEventAttributes)
with argument beingnull
.- See Also:
-
figureCaption
Starts a figure caption.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
figureCaption_
void figureCaption_()Ends a caption of an image. -
figureGraphics
Adds a graphic element. Shortcut forfigureGraphics(String, SinkEventAttributes)
with first argument beingsrc
and second argument beingnull
.- Parameters:
src
- the source
-
figureGraphics
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 thesrc
parameter.- Parameters:
src
- the image source, a valid URL.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
table
void table()Starts a table element for marking up tabular information in a document. Shortcut fortable(SinkEventAttributes)
with argument beingnull
.- See Also:
-
table
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
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
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
table_
void table_()Ends a table element. -
tableRows
void tableRows()Starts an element that contains rows of table data. Shortcut fortableRows(int[], boolean)
with first argument beingnull
and second beingfalse
.- See Also:
-
tableRows
void tableRows(int[] justification, boolean grid) Starts an element that contains rows of table data.- 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:
-
tableRows_
void tableRows_()Ends an element that contains rows of table data. -
tableRow
void tableRow()Starts a row element which acts as a container for a row of table cells. Shortcut fortableRow(SinkEventAttributes)
with argument beingnull
.- See Also:
-
tableRow
Starts a table row.Supported attributes are the
base attributes
plus:ALIGN
,BGCOLOR
,VALIGN
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
tableRow_
void tableRow_()Ends a row element. -
tableCell
void tableCell()Starts a cell element which defines a cell that contains data. Shortcut fortableCell(SinkEventAttributes)
with argument beingnull
.- See Also:
-
tableCell
Starts a table cell.Supported attributes are the
base attributes
plus:ABBRV
,ALIGN
,AXIS
,BGCOLOR
,COLSPAN
,HEADERS
,HEIGHT
,NOWRAP
,ROWSPAN
,SCOPE
,VALIGN
,WIDTH
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
tableCell_
void tableCell_()Ends a cell element. -
tableHeaderCell
void tableHeaderCell()Starts a cell element which defines a cell that contains header information. Shortcut fortableHeaderCell(SinkEventAttributes)
with argument beingnull
.- See Also:
-
tableHeaderCell
Starts a table header cell.Supported attributes are the same as for
tableCell
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
tableHeaderCell_
void tableHeaderCell_()Ends a cell header element. -
tableCaption
void tableCaption()Starts a caption element of a table. Shortcut fortableCaption(SinkEventAttributes)
with argument beingnull
.- See Also:
-
tableCaption
Starts a table caption.Note that the order of tableCaption and
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
plusALIGN
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
tableCaption_
void tableCaption_()Ends a caption element of a table. -
paragraph
void paragraph()Starts an element which represents a paragraph. Shortcut forparagraph(SinkEventAttributes)
with argument beingnull
.- See Also:
-
paragraph
Starts a paragraph.Supported attributes are the
base attributes
plusALIGN
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
paragraph_
void paragraph_()Ends a paragraph element. -
data
Starts a data element which groups together other elements representing microformats. Shortcut fordata(String, SinkEventAttributes)
with first argument being {code value} and second argument beingnull
.- Parameters:
value
- aString
object.- See Also:
-
data
Starts a data element which groups together other elements representing microformats.Supported attributes are the
base attributes
plusVALUE
.- Parameters:
value
- the machine readable value of the data, may benull
.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
data_
void data_()Ends an data element. -
time
Starts a time element which groups together other elements representing a time. Shortcut fortime(String, SinkEventAttributes)
with first argument being {code datetime} and second argument beingnull
.- See Also:
-
time
Starts a time element which groups together other elements representing a time.Supported attributes are the
base attributes
plusDATETIME
.- Parameters:
datetime
- the machine readable value of the time, may benull
.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
time_
void time_()Ends a time element. -
address
void address()Starts an address element. Shortcut foraddress(SinkEventAttributes)
with argument beingnull
.- See Also:
-
address
Starts an address element.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
address_
void address_()Ends an address element. -
blockquote
void blockquote()Starts a blockquote element. Shortcut forblockquote(SinkEventAttributes)
with argument beingnull
.- See Also:
-
blockquote
Starts a blockquote element.Supported attributes are the
base attributes
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
blockquote_
void blockquote_()Ends an blockquote element. -
division
void division()Starts a division element grouping together other elements. Shortcut fordivision(SinkEventAttributes)
with argument beingnull
.- See Also:
-
division
Starts a division element grouping together other elements.Supported attributes are the
base attributes
plusALIGN
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
division_
void division_()Ends a division element. -
verbatim
void verbatim()Starts a verbatim block, ie a block where whitespace has semantic relevance. Shortcut forverbatim(SinkEventAttributes)
with argument beingnull
.- See Also:
-
verbatim
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
(values: "source"),ALIGN
,WIDTH
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
verbatim_
void verbatim_()Ends a verbatim element. -
horizontalRule
void horizontalRule()Adding a separator of sections from a text to each other. Shortcut forhorizontalRule(SinkEventAttributes)
with argument beingnull
.- See Also:
-
horizontalRule
Adds a horizontal separator rule.Supported attributes are the
base attributes
plus:ALIGN
,NOSHADE
,SIZE
,WIDTH
.- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
pageBreak
void pageBreak()Adding a new page separator. -
anchor
Starts an element which defines an anchor. Shortcut foranchor(String, SinkEventAttributes)
with first argument beingname
and second argument beingnull
.- Parameters:
name
- the name of the anchor.- See Also:
-
anchor
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
. IfNAME
is specified in the SinkEventAttributes, it will be overwritten by thename
parameter.- Parameters:
name
- the name of the anchor. This has to be a valid SGML NAME token.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
anchor_
void anchor_()Ends an anchor element. -
link
Starts an element which defines a link. Shortcut forlink(String, SinkEventAttributes)
with first argument beingname
and second argument beingnull
.- Parameters:
name
- the name of the link.- See Also:
-
link
Starts a link.The
name
parameter has to be a valid URI according to RFC 3986, i.e. for internal links (links to an anchor within the same source document),name
should start with the character "#". This also implies that all unsafe characters are already encoded.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 thename
parameter.- Parameters:
name
- the name of the link.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
- See Also:
-
link_
void link_()Ends a link element. -
inline
void inline()Starts an inline element. Shortcut forinline(SinkEventAttributes)
with argument beingnull
.- See Also:
-
inline
Starts an inline element.The inline method is similar to
text(String,SinkEventAttributes)
, but allows you to wrap arbitrary elements in addition to text.Supported attributes are the
base attributes
plusSEMANTICS
(values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
inline_
void inline_()Ends an inline element. -
italic
void italic()Starts an italic element. Alternatively one may usetext(String,SinkEventAttributes)
withSTYLE
instead. -
italic_
void italic_()Ends an italic element. Alternatively one may usetext(String,SinkEventAttributes)
withSTYLE
instead. -
bold
void bold()Starts a bold element. Alternatively one may usetext(String,SinkEventAttributes)
withSTYLE
instead. -
bold_
void bold_()Ends a bold element. Alternatively one may usetext(String,SinkEventAttributes)
withSTYLE
instead. -
monospaced
void monospaced()Starts a monospaced element. Alternatively one may usetext(String,SinkEventAttributes)
withSTYLE
instead. -
monospaced_
void monospaced_()Ends a monospaced element. Alternatively one may usetext(String,SinkEventAttributes)
withSTYLE
instead. -
lineBreak
void lineBreak()Adds a line break. Shortcut forlineBreak(SinkEventAttributes)
with argument beingnull
.- See Also:
-
lineBreak
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
lineBreakOpportunity
void lineBreakOpportunity()Adds a line break opportunity. Shortcut forlineBreakOpportunity(SinkEventAttributes)
with argument beingnull
.- See Also:
-
lineBreakOpportunity
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 2.0
-
nonBreakingSpace
void nonBreakingSpace()Adding a non breaking space, ie a space without any special formatting operations. -
text
Adding a text. Shortcut fortext(String, SinkEventAttributes)
with first argument beingtext
and second argument beingnull
.- Parameters:
text
- The text to write.- See Also:
-
text
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
plusSEMANTICS
(values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").The following attributes are deprecated:
VALIGN
(values "sub", "sup"),DECORATION
(values "underline", "overline", "line-through"),STYLE
(values "italic", "bold", "monospaced").- Parameters:
text
- The text to write.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
rawText
Adding a raw text, ie a text without any special formatting operations.- Parameters:
text
- The text to write.
-
comment
Add a comment.- Parameters:
comment
- The comment to write.- Since:
- 1.1
-
unknown
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.- Parameters:
name
- The name of the event.requiredParams
- An optional array of required parameters to the event. May benull
.attributes
- A set ofSinkEventAttributes
, may benull
.- Since:
- 1.1
-
flush
void flush()Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect. -
close
void close()Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.- Specified by:
close
in interfaceAutoCloseable
-
setDocumentLocator
Sets the locator which exposes location information for a particular Sink event.- Parameters:
locator
- the locator (nevernull
).- Since:
- 2.0.0
-
getDocumentLocator
Returns the locator which exposes location information for a particular Sink event.- Returns:
- the locator (never
null
). - Since:
- 2.0.0
-