public interface Sink extends AutoCloseable
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.
Modifier and Type | Field and Description |
---|---|
static int |
JUSTIFY_CENTER
Center alignment for table cells.
|
static int |
JUSTIFY_LEFT
Left alignment for table cells.
|
static int |
JUSTIFY_RIGHT
Right alignment for table cells.
|
static int |
NUMBERING_DECIMAL
A numbering to handle a number list.
|
static int |
NUMBERING_LOWER_ALPHA
A numbering to handle a lower alpha list.
|
static int |
NUMBERING_LOWER_ROMAN
A numbering to handle a lower roman list.
|
static int |
NUMBERING_UPPER_ALPHA
A numbering to handle a upper alpha list.
|
static int |
NUMBERING_UPPER_ROMAN
A numbering to handle a upper roman list.
|
static int |
SECTION_LEVEL_1
A level 1 section (section).
|
static int |
SECTION_LEVEL_2
A level 2 section (subsection).
|
static int |
SECTION_LEVEL_3
A level 3 section (sub-subsection).
|
static int |
SECTION_LEVEL_4
A level 4 section (sub-sub-subsection).
|
static int |
SECTION_LEVEL_5
A level 5 section (sub-sub-sub-subsection).
|
static int |
SECTION_LEVEL_6
A level 6 section.
|
Modifier and Type | Method and Description |
---|---|
void |
address_()
Ends an address element.
|
void |
address()
Starts an address element.
|
void |
address(SinkEventAttributes attributes)
Starts an address element.
|
void |
anchor_()
Ends an anchor element.
|
void |
anchor(String name)
Starts an element which defines an anchor.
|
void |
anchor(String name,
SinkEventAttributes attributes)
Starts an element which defines an anchor.
|
void |
article_()
Ends the article element.
|
void |
article()
Starts an article within a document.
|
void |
article(SinkEventAttributes attributes)
Starts an article within a document.
|
void |
author_()
Ends an author element.
|
void |
author()
Starts an author element.
|
void |
author(SinkEventAttributes attributes)
Starts an author element.
|
void |
blockquote_()
Ends an blockquote element.
|
void |
blockquote()
Starts a blockquote element.
|
void |
blockquote(SinkEventAttributes attributes)
Starts a blockquote element.
|
void |
body_()
Ends the body element.
|
void |
body()
Starts the body of a document.
|
void |
body(SinkEventAttributes attributes)
Starts the body of a document.
|
void |
bold_()
Ends a bold element.
|
void |
bold()
Starts a bold element.
|
void |
close()
Close the writer or the stream, if needed.
|
void |
comment(String comment)
Add a comment.
|
void |
content_()
Ends a main content section.
|
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 |
data_()
Ends an data element.
|
void |
data(String value)
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 |
date_()
Ends the date element.
|
void |
date()
Starts the date element.
|
void |
date(SinkEventAttributes attributes)
Starts the date element.
|
void |
definedTerm_()
Ends a definition term element within a definition list.
|
void |
definedTerm()
Starts a definition term element within a definition list.
|
void |
definedTerm(SinkEventAttributes attributes)
Starts a definition term element within a definition list.
|
void |
definition_()
Ends a definition element within a definition list.
|
void |
definition()
Starts a definition element within a definition list.
|
void |
definition(SinkEventAttributes attributes)
Starts a definition element within a definition list.
|
void |
definitionList_()
Ends a definition list element.
|
void |
definitionList()
Starts a definition list element.
|
void |
definitionList(SinkEventAttributes attributes)
Starts a definition list.
|
void |
definitionListItem_()
Ends a list item element within a definition list.
|
void |
definitionListItem()
Starts a list item element within a definition list.
|
void |
definitionListItem(SinkEventAttributes attributes)
Starts a list item element within a definition list.
|
void |
division_()
Ends a division element.
|
void |
division()
Starts a division element grouping together other elements.
|
void |
division(SinkEventAttributes attributes)
Starts a division element grouping together other elements.
|
void |
figure_()
Ends a basic image embedding element.
|
void |
figure()
Starts a basic image embedding element.
|
void |
figure(SinkEventAttributes attributes)
Starts a basic image embedding element.
|
void |
figureCaption_()
Ends a caption of an image.
|
void |
figureCaption()
Starts a caption of an image element.
|
void |
figureCaption(SinkEventAttributes attributes)
Starts a figure caption.
|
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_()
Ends a footer element.
|
void |
footer()
Start a new footer within the section or body.
|
void |
footer(SinkEventAttributes attributes)
Start a new footer within the section or body.
|
default Locator |
getDocumentLocator()
Returns the locator which exposes location information for a particular Sink event.
|
void |
head_()
Ends the head element.
|
void |
head()
Starts the head element.
|
void |
head(SinkEventAttributes attributes)
Starts the head element.
|
void |
header_()
Ends a header 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 |
horizontalRule()
Adding a separator of sections from a text to each other.
|
void |
horizontalRule(SinkEventAttributes attributes)
Adds a horizontal separator rule.
|
void |
inline_()
Ends an inline element.
|
void |
inline()
Starts an inline element.
|
void |
inline(SinkEventAttributes attributes)
Starts an inline element.
|
void |
italic_()
Ends an italic element.
|
void |
italic()
Starts an italic element.
|
void |
lineBreak()
Adds a line break.
|
void |
lineBreak(SinkEventAttributes attributes)
Adds a line break.
|
void |
lineBreakOpportunity()
Adds a line break opportunity.
|
void |
lineBreakOpportunity(SinkEventAttributes attributes)
Adds a line break opportunity.
|
void |
link_()
Ends a link element.
|
void |
link(String name)
Starts an element which defines a link.
|
void |
link(String name,
SinkEventAttributes attributes)
Starts a link.
|
void |
list_()
Ends an unordered list element.
|
void |
list()
Starts an unordered list element.
|
void |
list(SinkEventAttributes attributes)
Starts an unordered list.
|
void |
listItem_()
Ends a list item element within an unordered list.
|
void |
listItem()
Starts a list item element within an unordered list.
|
void |
listItem(SinkEventAttributes attributes)
Starts a list item element within an unordered list.
|
void |
monospaced_()
Ends a monospaced element.
|
void |
monospaced()
Starts a monospaced element.
|
void |
navigation_()
Ends the navigation element.
|
void |
navigation()
Starts a navigation section within a document.
|
void |
navigation(SinkEventAttributes attributes)
Starts a navigation section within a document.
|
void |
nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations.
|
void |
numberedList_()
Ends an ordered list element.
|
void |
numberedList(int numbering)
Starts an ordered list element.
|
void |
numberedList(int numbering,
SinkEventAttributes attributes)
Starts an ordered list element.
|
void |
numberedListItem_()
Ends a list item element within an ordered list.
|
void |
numberedListItem()
Starts a list item element within an ordered list.
|
void |
numberedListItem(SinkEventAttributes attributes)
Starts a list item element within an ordered list.
|
void |
pageBreak()
Adding a new page separator.
|
void |
paragraph_()
Ends a paragraph element.
|
void |
paragraph()
Starts an element which represents a paragraph.
|
void |
paragraph(SinkEventAttributes attributes)
Starts a paragraph.
|
void |
rawText(String text)
Adding a raw text, ie a text without any special formatting operations.
|
void |
section_(int level)
Ends a section at the given level.
|
void |
section(int level,
SinkEventAttributes attributes)
Start a new section at the given level.
|
void |
section1_()
Ends a first heading element.
|
void |
section1()
Starts a first heading element which contains the topic of the section.
|
void |
section2_()
Ends a second heading element.
|
void |
section2()
Starts a second heading element which contains the topic of the section.
|
void |
section3_()
Ends a third heading element.
|
void |
section3()
Starts a third heading element which contains the topic of the section.
|
void |
section4_()
Ends a 4th heading element.
|
void |
section4()
Starts a 4th heading element which contains the topic of the section.
|
void |
section5_()
Ends a 5th heading element.
|
void |
section5()
Starts a 5th heading element which contains the topic of the section.
|
void |
section6_()
Ends a 6th heading element.
|
void |
section6()
Starts a 6th heading element which contains the topic of the section.
|
void |
sectionTitle_()
Ends a title heading element.
|
void |
sectionTitle_(int level)
Ends a section title at the given level.
|
void |
sectionTitle()
Starts a title heading element.
|
void |
sectionTitle(int level,
SinkEventAttributes attributes)
Start a new section title at the given level.
|
void |
sectionTitle1_()
Ends a first title heading element.
|
void |
sectionTitle1()
Starts a first title heading element.
|
void |
sectionTitle2_()
Ends a second title heading element.
|
void |
sectionTitle2()
Starts a second title heading element.
|
void |
sectionTitle3_()
Ends a third title heading element.
|
void |
sectionTitle3()
Starts a third title heading element.
|
void |
sectionTitle4_()
Ends a 4th title heading element.
|
void |
sectionTitle4()
Starts a 4th title heading element.
|
void |
sectionTitle5_()
Ends a 5th title heading element.
|
void |
sectionTitle5()
Starts a 5th title heading element.
|
void |
sectionTitle6_()
Ends a 6th title heading element.
|
void |
sectionTitle6()
Starts a 6th title heading element.
|
default void |
setDocumentLocator(Locator locator)
Sets the locator which exposes location information for a particular Sink event.
|
void |
sidebar_()
Ends the sidebar element.
|
void |
sidebar()
Starts a sidebar section within a document.
|
void |
sidebar(SinkEventAttributes attributes)
Starts a sidebar section within a document.
|
void |
table_()
Ends a table element.
|
void |
table()
Starts a table element for marking up tabular information in a document.
|
void |
table(SinkEventAttributes attributes)
Starts a table.
|
void |
tableCaption_()
Ends a caption element of a table.
|
void |
tableCaption()
Starts a caption element of a table.
|
void |
tableCaption(SinkEventAttributes attributes)
Starts a table caption.
|
void |
tableCell_()
Ends a cell element.
|
void |
tableCell()
Starts a cell element which defines a cell that contains data.
|
void |
tableCell(SinkEventAttributes attributes)
Starts a table cell.
|
void |
tableHeaderCell_()
Ends a cell header element.
|
void |
tableHeaderCell()
Starts a cell element which defines a cell that contains header information.
|
void |
tableHeaderCell(SinkEventAttributes attributes)
Starts a table header cell.
|
void |
tableRow_()
Ends a row element.
|
void |
tableRow()
Starts a row element which acts as a container for a row of table cells.
|
void |
tableRow(SinkEventAttributes attributes)
Starts a table row.
|
void |
tableRows_()
Ends an element that contains rows of table data.
|
void |
tableRows()
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 |
text(String text)
Adding a text.
|
void |
text(String text,
SinkEventAttributes attributes)
Adds a text.
|
void |
time_()
Ends a time element.
|
void |
time(String datetime)
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 |
title_()
Ends the title element.
|
void |
title()
Starts the title element.
|
void |
title(SinkEventAttributes attributes)
Starts the title element.
|
void |
unknown(String name,
Object[] requiredParams,
SinkEventAttributes attributes)
Add an unknown event.
|
void |
verbatim_()
Ends a verbatim element.
|
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.
|
static final int NUMBERING_DECIMAL
static final int NUMBERING_LOWER_ALPHA
static final int NUMBERING_UPPER_ALPHA
static final int NUMBERING_LOWER_ROMAN
static final int NUMBERING_UPPER_ROMAN
static final int SECTION_LEVEL_1
static final int SECTION_LEVEL_2
static final int SECTION_LEVEL_3
static final int SECTION_LEVEL_4
static final int SECTION_LEVEL_5
static final int SECTION_LEVEL_6
section(int,SinkEventAttributes)
,
Constant Field Valuesstatic final int JUSTIFY_CENTER
tableRows(int[], boolean)
,
Constant Field Valuesstatic final int JUSTIFY_LEFT
tableRows(int[], boolean)
,
Constant Field Valuesstatic final int JUSTIFY_RIGHT
tableRows(int[], boolean)
,
Constant Field Valuesvoid head()
head(SinkEventAttributes)
with first argument being null
.head(SinkEventAttributes)
void head(SinkEventAttributes attributes)
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
.
attributes
- A set of SinkEventAttributes
, may be null
.void head_()
void title()
title(SinkEventAttributes)
with first argument being null
.title(SinkEventAttributes)
void title(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.head(SinkEventAttributes)
void title_()
void author()
author(SinkEventAttributes)
with first argument being null
.author(SinkEventAttributes)
void author(SinkEventAttributes attributes)
Supported attributes are: EMAIL
.
attributes
- A set of SinkEventAttributes
, may be null
.head(SinkEventAttributes)
void author_()
void date()
date(SinkEventAttributes)
with first argument being null
.date(SinkEventAttributes)
void date(SinkEventAttributes attributes)
YYYY-MM-DDwhere
YYYY
is the year in the Gregorian calendar,MM
is the month of the year between 01 (January) and 12 (December),DD
is the day of the month between 01 and 31.Supported attributes are: none.
attributes
- A set of SinkEventAttributes
, may be null
.head(SinkEventAttributes)
void date_()
void body()
body(SinkEventAttributes)
with first argument being null
.body(SinkEventAttributes)
void body(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.head(SinkEventAttributes)
void body_()
void article()
article(SinkEventAttributes)
with first argument being null
.article(SinkEventAttributes)
void article(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void article_()
void navigation()
navigation(SinkEventAttributes)
with first argument being null
.navigation(SinkEventAttributes)
void navigation(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.navigation(SinkEventAttributes)
void navigation_()
void sidebar()
sidebar(SinkEventAttributes)
with first argument being null
.sidebar(SinkEventAttributes)
void sidebar(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void sidebar_()
void sectionTitle()
sectionTitle(int, SinkEventAttributes)
with first argument being 0
and second argument being null
.void sectionTitle_()
sectionTitle_(int)
with argument being 0
.void section1()
section(int, SinkEventAttributes)
with first argument being 1
and second argument being null
.section(int,SinkEventAttributes)
void section1_()
section_(int)
with argument being 1
.void sectionTitle1()
section1()
element.
Shortcut for sectionTitle(int, SinkEventAttributes)
with first argument being 1
and second argument being null
.
sectionTitle(int,SinkEventAttributes)
void sectionTitle1_()
sectionTitle_(int)
with argument being 1
.void section2()
section1()
element.
Shortcut for section(int, SinkEventAttributes)
with first argument being 2
and second argument being null
.
section(int,SinkEventAttributes)
void section2_()
section_(int)
with argument being 2
.void sectionTitle2()
section2()
element.
Shortcut for sectionTitle(int, SinkEventAttributes)
with first argument being 2
and second argument being null
.
sectionTitle(int,SinkEventAttributes)
void sectionTitle2_()
sectionTitle_(int)
with argument being 2
.void section3()
section2()
element.
Shortcut for section(int, SinkEventAttributes)
with first argument being 3
and second argument being null
.
section(int,SinkEventAttributes)
void section3_()
section_(int)
with argument being 3
.void sectionTitle3()
section3()
element.
Shortcut for sectionTitle(int, SinkEventAttributes)
with first argument being 3
and second argument being null
.
sectionTitle(int,SinkEventAttributes)
void sectionTitle3_()
sectionTitle_(int)
with argument being 3
.void section4()
section3()
element.
Shortcut for section(int, SinkEventAttributes)
with first argument being 4
and second argument being null
.
section(int,SinkEventAttributes)
void section4_()
section_(int)
with argument being 4
.void sectionTitle4()
section4()
element.
Shortcut for sectionTitle(int, SinkEventAttributes)
with first argument being 4
and second argument being null
.
sectionTitle(int,SinkEventAttributes)
void sectionTitle4_()
sectionTitle_(int)
with argument being 4
.void section5()
section5()
element.
Shortcut for section(int, SinkEventAttributes)
with first argument being 5
and second argument being null
.
section(int,SinkEventAttributes)
void section5_()
section_(int)
with argument being 5
.void sectionTitle5()
section5()
element.
Shortcut for sectionTitle(int, SinkEventAttributes)
with first argument being 5
and second argument being null
.
sectionTitle(int,SinkEventAttributes)
void sectionTitle5_()
sectionTitle_(int)
with argument being 5
.void section6()
section6()
element.
Shortcut for section(int, SinkEventAttributes)
with first argument being 6
and second argument being null
.
section(int,SinkEventAttributes)
void section6_()
section_(int)
with argument being 6
.void sectionTitle6()
section5()
element.
Shortcut for sectionTitle(int, SinkEventAttributes)
with first argument being 6
and second argument being null
.
sectionTitle(int,SinkEventAttributes)
void sectionTitle6_()
sectionTitle_(int)
with argument being 6
.void section(int level, SinkEventAttributes attributes)
Sections with higher level have to be entirely contained within sections of lower level.
Supported attributes are the base attributes
.
level
- the section level (must be a value between 1 and 6).attributes
- A set of SinkEventAttributes
, may be null
.void section_(int level)
void sectionTitle(int level, SinkEventAttributes attributes)
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
.
level
- the section title level (must be a value between 1 and 6).attributes
- A set of SinkEventAttributes
, may be null
.void sectionTitle_(int level)
void header()
header(SinkEventAttributes)
with argument being null
.void header(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void header_()
void content()
content(SinkEventAttributes)
with argument being null
.void content(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void content_()
void footer()
footer(SinkEventAttributes)
with argument being null
.void footer(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void footer_()
void list()
list(SinkEventAttributes)
with argument being null
.list(SinkEventAttributes)
void list(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void list_()
void listItem()
listItem(SinkEventAttributes)
with argument being null
.listItem(SinkEventAttributes)
void listItem(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void listItem_()
void numberedList(int numbering)
numberedList(int, SinkEventAttributes)
with first argument being numbering
and second argument being null
.numbering
- the numbering style.numberedList(int,SinkEventAttributes)
void numberedList(int numbering, SinkEventAttributes attributes)
Supported attributes are the base attributes
.
numbering
- the numbering style.attributes
- A set of SinkEventAttributes
, may be null
.NUMBERING_DECIMAL
,
NUMBERING_LOWER_ALPHA
,
NUMBERING_LOWER_ROMAN
,
NUMBERING_UPPER_ALPHA
,
NUMBERING_UPPER_ROMAN
void numberedList_()
void numberedListItem()
numberedListItem(SinkEventAttributes)
with argument being null
.numberedListItem(SinkEventAttributes)
void numberedListItem(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void numberedListItem_()
void definitionList()
definitionList(SinkEventAttributes)
with argument being null
.definitionList(SinkEventAttributes)
void definitionList(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void definitionList_()
void definitionListItem()
definitionListItem(SinkEventAttributes)
with argument being null
.definitionListItem(SinkEventAttributes)
void definitionListItem(SinkEventAttributes attributes)
Every definitionListItem has to contain exactly one definedTerm(SinkEventAttributes)
and one definition(SinkEventAttributes)
, in this order.
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void definitionListItem_()
void definition()
definition(SinkEventAttributes)
with argument being null
.definition(SinkEventAttributes)
void definition(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void definition_()
void definedTerm()
definedTerm(SinkEventAttributes)
with argument being null
.definedTerm(SinkEventAttributes)
void definedTerm(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void definedTerm_()
void figure()
figure(SinkEventAttributes)
with argument being null
.figure(SinkEventAttributes)
void figure(SinkEventAttributes attributes)
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
.
attributes
- A set of SinkEventAttributes
, may be null
.void figure_()
void figureCaption()
figureCaption(SinkEventAttributes)
with argument being null
.figureCaption(SinkEventAttributes)
void figureCaption(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.figure(SinkEventAttributes)
void figureCaption_()
void figureGraphics(String src)
figureGraphics(String, SinkEventAttributes)
with first argument being src
and second argument being null
.src
- the sourcevoid figureGraphics(String src, SinkEventAttributes attributes)
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.
src
- the image source, a valid URL.attributes
- A set of SinkEventAttributes
, may be null
.figure(SinkEventAttributes)
void table()
table(SinkEventAttributes)
with argument being null
.table(SinkEventAttributes)
void table(SinkEventAttributes attributes)
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
.
attributes
- A set of SinkEventAttributes
, may be null
.void table_()
void tableRows()
tableRows(int[], boolean)
with first argument being null
and second being false
.tableRows(int[], boolean)
void tableRows(int[] justification, boolean grid)
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.table(SinkEventAttributes)
,
JUSTIFY_CENTER
,
JUSTIFY_LEFT
,
JUSTIFY_RIGHT
void tableRows_()
void tableRow()
tableRow(SinkEventAttributes)
with argument being null
.tableRow(SinkEventAttributes)
void tableRow(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus:
ALIGN
,BGCOLOR
,VALIGN
.
attributes
- A set of SinkEventAttributes
, may be null
.void tableRow_()
void tableCell()
tableCell(SinkEventAttributes)
with argument being null
.tableCell(SinkEventAttributes)
void tableCell(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus:
ABBRV
,ALIGN
,AXIS
,BGCOLOR
,COLSPAN
,HEADERS
,HEIGHT
,NOWRAP
,ROWSPAN
,SCOPE
,VALIGN
,WIDTH
.
attributes
- A set of SinkEventAttributes
, may be null
.void tableCell_()
void tableHeaderCell()
tableHeaderCell(SinkEventAttributes)
with argument being null
.tableHeaderCell(SinkEventAttributes)
void tableHeaderCell(SinkEventAttributes attributes)
Supported attributes are the same as for tableCell
.
attributes
- A set of SinkEventAttributes
, may be null
.void tableHeaderCell_()
void tableCaption()
tableCaption(SinkEventAttributes)
with argument being null
.tableCaption(SinkEventAttributes)
void tableCaption(SinkEventAttributes attributes)
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
.
attributes
- A set of SinkEventAttributes
, may be null
.table(SinkEventAttributes)
void tableCaption_()
void paragraph()
paragraph(SinkEventAttributes)
with argument being null
.paragraph(SinkEventAttributes)
void paragraph(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus ALIGN
.
attributes
- A set of SinkEventAttributes
, may be null
.void paragraph_()
void data(String value)
data(String, SinkEventAttributes)
with first argument being {code value} and second argument being null
.value
- a String
object.data(String, SinkEventAttributes)
void data(String value, SinkEventAttributes attributes)
Supported attributes are the base attributes
plus VALUE
.
value
- the machine readable value of the data, may be null
.attributes
- A set of SinkEventAttributes
, may be null
.void data_()
void time(String datetime)
time(String, SinkEventAttributes)
with first argument being {code datetime} and second argument being null
.time(String, SinkEventAttributes)
void time(String datetime, SinkEventAttributes attributes)
Supported attributes are the base attributes
plus DATETIME
.
datetime
- the machine readable value of the time, may be null
.attributes
- A set of SinkEventAttributes
, may be null
.void time_()
void address()
address(SinkEventAttributes)
with argument being null
.address(SinkEventAttributes)
void address(SinkEventAttributes attributes)
attributes
- A set of SinkEventAttributes
, may be null
.void address_()
void blockquote()
blockquote(SinkEventAttributes)
with argument being null
.blockquote(SinkEventAttributes)
void blockquote(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
attributes
- A set of SinkEventAttributes
, may be null
.void blockquote_()
void division()
division(SinkEventAttributes)
with argument being null
.division(SinkEventAttributes)
void division(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus ALIGN
.
attributes
- A set of SinkEventAttributes
, may be null
.void division_()
void verbatim()
verbatim(SinkEventAttributes)
with argument being null
.verbatim(SinkEventAttributes)
void verbatim(SinkEventAttributes attributes)
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
.
attributes
- A set of SinkEventAttributes
, may be null
.void verbatim_()
void horizontalRule()
horizontalRule(SinkEventAttributes)
with argument being null
.horizontalRule(SinkEventAttributes)
void horizontalRule(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus:
ALIGN
,NOSHADE
,SIZE
,WIDTH
.
attributes
- A set of SinkEventAttributes
, may be null
.void pageBreak()
void anchor(String name)
anchor(String, SinkEventAttributes)
with first argument being name
and second argument being null
.name
- the name of the anchor.anchor(String,SinkEventAttributes)
void anchor(String name, SinkEventAttributes attributes)
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.
name
- the name of the anchor. This has to be a valid SGML NAME token.attributes
- A set of SinkEventAttributes
, may be null
.void anchor_()
void link(String name)
link(String, SinkEventAttributes)
with first argument being name
and second argument being null
.name
- the name of the link.link(String,SinkEventAttributes)
void link(String name, SinkEventAttributes attributes)
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 the name
parameter.
name
- the name of the link.attributes
- A set of SinkEventAttributes
, may be null
.URI.toASCIIString()
void link_()
void inline()
inline(SinkEventAttributes)
with argument being null
.inline(SinkEventAttributes)
void inline(SinkEventAttributes attributes)
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
plus
SEMANTICS
(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").
attributes
- A set of SinkEventAttributes
, may be null
.void inline_()
void italic()
text(String,SinkEventAttributes)
with
STYLE
instead.void italic_()
text(String,SinkEventAttributes)
with
STYLE
instead.void bold()
text(String,SinkEventAttributes)
with
STYLE
instead.void bold_()
text(String,SinkEventAttributes)
with
STYLE
instead.void monospaced()
text(String,SinkEventAttributes)
with
STYLE
instead.void monospaced_()
text(String,SinkEventAttributes)
with
STYLE
instead.void lineBreak()
lineBreak(SinkEventAttributes)
with argument being null
.lineBreak(SinkEventAttributes)
void lineBreak(SinkEventAttributes attributes)
attributes
- A set of SinkEventAttributes
, may be null
.void lineBreakOpportunity()
lineBreakOpportunity(SinkEventAttributes)
with argument being null
.lineBreak(SinkEventAttributes)
void lineBreakOpportunity(SinkEventAttributes attributes)
attributes
- A set of SinkEventAttributes
, may be null
.void nonBreakingSpace()
void text(String text)
text(String, SinkEventAttributes)
with first argument being text
and second argument being null
.text
- The text to write.text(String,SinkEventAttributes)
void text(String text, SinkEventAttributes attributes)
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
SEMANTICS
(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").
text
- The text to write.attributes
- A set of SinkEventAttributes
, may be null
.void rawText(String text)
text
- The text to write.void comment(String comment)
comment
- The comment to write.void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
name
- The name of the event.requiredParams
- An optional array of required parameters to the event.
May be null
.attributes
- A set of SinkEventAttributes
, may be null
.void flush()
void close()
close
in interface AutoCloseable
default void setDocumentLocator(Locator locator)
locator
- the locator (never null
).default Locator getDocumentLocator()
null
).Copyright © 2005–2024 The Apache Software Foundation. All rights reserved.