public class RandomAccessSink extends Object implements Sink
Sink with hooks.
A page can be prepared by first creating its structure and specifying the positions of these hooks.
After specifying the structure, the page can be filled with content from one or more models.
These hooks can prevent you to have to loop over the model multiple times to build the page as desired.JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5, SECTION_LEVEL_6| Constructor and Description |
|---|
RandomAccessSink(SinkFactory sinkFactory,
File outputDirectory,
String outputName) |
RandomAccessSink(SinkFactory sinkFactory,
File outputDirectory,
String outputName,
String encoding) |
RandomAccessSink(SinkFactory sinkFactory,
OutputStream stream) |
RandomAccessSink(SinkFactory sinkFactory,
OutputStream stream,
String encoding) |
| Modifier and Type | Method and Description |
|---|---|
Sink |
addSinkHook()
By calling this method a sink reference is added at the current position.
|
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 |
author_()
Ends an author element.
|
void |
author()
Starts an author element.
|
void |
author(SinkEventAttributes attributes)
Starts an author 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 all sinks
|
void |
comment(String comment)
Add a comment.
|
void |
date_()
Ends the date element.
|
void |
date()
Starts the date element.
|
void |
date(SinkEventAttributes attributes)
Starts the date element.
|
void |
definedTerm_()
Starts a definition term element within a definition list.
|
void |
definedTerm()
Starts a definition term element within a definition list.
|
void |
definedTerm(SinkEventAttributes attributes)
Starts a definition term element within a definition list.
|
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 |
enableLogging(Log log)
Enable a
Doxia logger for this Doxia component. |
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 name)
Adding a source of a graphic.
|
void |
figureGraphics(String src,
SinkEventAttributes attributes)
Adds a graphic element.
|
void |
flush()
Flush all sinks
|
void |
head_()
Ends the head element.
|
void |
head()
Starts the head element.
|
void |
head(SinkEventAttributes attributes)
Starts the head element.
|
void |
horizontalRule()
Adding a separator of sections from a text to each other.
|
void |
horizontalRule(SinkEventAttributes attributes)
Adds a horizontal separator rule.
|
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 |
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 |
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.
|
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 |
tableCell(String width)
Starts a cell element which defines a cell that contains data.
|
void |
tableHeaderCell_()
Ends a cell header element.
|
void |
tableHeaderCell()
Starts a cell element which defines a cell that contains header information.
|
void |
tableHeaderCell(SinkEventAttributes attributes)
Starts a table header cell.
|
void |
tableHeaderCell(String width)
Starts a cell element which defines a cell that contains header information.
|
void |
tableRow_()
Ends a row element.
|
void |
tableRow()
Starts a row element which acts as a container for a row of table cells.
|
void |
tableRow(SinkEventAttributes attributes)
Starts a table row.
|
void |
tableRows_()
Ends 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 |
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(boolean boxed)
Starts an element which indicates that whitespace in the enclosed text has semantic relevance.
|
void |
verbatim(SinkEventAttributes attributes)
Starts a verbatim block, ie a block where whitespace has semantic relevance.
|
public RandomAccessSink(SinkFactory sinkFactory, OutputStream stream) throws IOException
IOExceptionpublic RandomAccessSink(SinkFactory sinkFactory, OutputStream stream, String encoding) throws IOException
IOExceptionpublic RandomAccessSink(SinkFactory sinkFactory, File outputDirectory, String outputName) throws IOException
IOExceptionpublic RandomAccessSink(SinkFactory sinkFactory, File outputDirectory, String outputName, String encoding) throws IOException
IOExceptionpublic Sink addSinkHook()
public void anchor(String name)
Sinkanchor in interface Sinkname - the name of the anchor.Sink.anchor(String,SinkEventAttributes)public void anchor(String name, SinkEventAttributes attributes)
Sink
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.
anchor in interface Sinkname - the name of the anchor. This has to be a valid SGML NAME token.attributes - A set of SinkEventAttributes, may be null.public void author()
Sinkauthor in interface SinkSink.author(SinkEventAttributes)public void author(SinkEventAttributes attributes)
Sink
Supported attributes are: EMAIL.
author in interface Sinkattributes - A set of SinkEventAttributes, may be null.Sink.head(SinkEventAttributes)public void body()
Sinkbody in interface SinkSink.body(SinkEventAttributes)public void body(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
body in interface Sinkattributes - A set of SinkEventAttributes, may be null.Sink.head(SinkEventAttributes)public void bold()
SinkSink.text(String,SinkEventAttributes) with
STYLE instead.public void bold_()
SinkSink.text(String,SinkEventAttributes) with
STYLE instead.public void date()
Sinkdate in interface SinkSink.date(SinkEventAttributes)public void date(SinkEventAttributes attributes)
SinkYYYY-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.
date in interface Sinkattributes - A set of SinkEventAttributes, may be null.Sink.head(SinkEventAttributes)public void definedTerm()
SinkdefinedTerm in interface SinkSink.definedTerm(SinkEventAttributes)public void definedTerm(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
definedTerm in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void definedTerm_()
SinkdefinedTerm_ in interface Sinkpublic void definition()
Sinkdefinition in interface SinkSink.definition(SinkEventAttributes)public void definition(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
definition in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void definitionList()
SinkdefinitionList in interface SinkSink.definitionList(SinkEventAttributes)public void definitionList(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
definitionList in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void definitionListItem()
SinkdefinitionListItem in interface SinkSink.definitionListItem(SinkEventAttributes)public void definitionListItem(SinkEventAttributes attributes)
Sink
Every definitionListItem has to contain exactly one Sink.definedTerm(SinkEventAttributes)
and one Sink.definition(SinkEventAttributes), in this order.
Supported attributes are the base attributes.
definitionListItem in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void definitionListItem_()
SinkdefinitionListItem_ in interface Sinkpublic void definitionList_()
SinkdefinitionList_ in interface Sinkpublic void definition_()
Sinkdefinition_ in interface Sinkpublic void figure()
Sinkfigure in interface SinkSink.figure(SinkEventAttributes)public void figure(SinkEventAttributes attributes)
SinkThe 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.
figure in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void figureCaption()
SinkfigureCaption in interface SinkSink.figureCaption(SinkEventAttributes)public void figureCaption(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
figureCaption in interface Sinkattributes - A set of SinkEventAttributes, may be null.Sink.figure(SinkEventAttributes)public void figureCaption_()
SinkfigureCaption_ in interface Sinkpublic void figureGraphics(String name)
SinkfigureGraphics in interface Sinkname - the sourcepublic void figureGraphics(String src, SinkEventAttributes attributes)
Sink
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.
figureGraphics in interface Sinksrc - the image source, a valid URL.attributes - A set of SinkEventAttributes, may be null.Sink.figure(SinkEventAttributes)public void figure_()
Sinkpublic void head()
Sinkhead in interface SinkSink.head(SinkEventAttributes)public void head(SinkEventAttributes attributes)
Sink
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.
head in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void horizontalRule()
SinkhorizontalRule in interface SinkSink.horizontalRule(SinkEventAttributes)public void horizontalRule(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes plus:
ALIGN,NOSHADE,SIZE,WIDTH.
horizontalRule in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void italic()
SinkSink.text(String,SinkEventAttributes) with
STYLE instead.public void italic_()
SinkSink.text(String,SinkEventAttributes) with
STYLE instead.public void lineBreak()
SinklineBreak in interface SinkSink.lineBreak(SinkEventAttributes)public void lineBreak(SinkEventAttributes attributes)
SinklineBreak in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void link(String name)
Sinklink in interface Sinkname - the name of the link.Sink.link(String,SinkEventAttributes)public void link(String name, SinkEventAttributes attributes)
Sink
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.
link in interface Sinkname - the name of the link.attributes - A set of SinkEventAttributes, may be null.public void list()
Sinklist in interface SinkSink.list(SinkEventAttributes)public void list(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
list in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void listItem()
SinklistItem in interface SinkSink.listItem(SinkEventAttributes)public void listItem(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
listItem in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void listItem_()
Sinkpublic void monospaced()
SinkSink.text(String,SinkEventAttributes) with
STYLE instead.monospaced in interface Sinkpublic void monospaced_()
SinkSink.text(String,SinkEventAttributes) with
STYLE instead.monospaced_ in interface Sinkpublic void nonBreakingSpace()
SinknonBreakingSpace in interface Sinkpublic void numberedList(int numbering)
SinknumberedList in interface Sinknumbering - the numbering style.Sink.numberedList(int,SinkEventAttributes)public void numberedList(int numbering, SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
numberedList in interface Sinknumbering - the numbering style.attributes - A set of SinkEventAttributes, may be null.Sink.NUMBERING_DECIMAL,
Sink.NUMBERING_LOWER_ALPHA,
Sink.NUMBERING_LOWER_ROMAN,
Sink.NUMBERING_UPPER_ALPHA,
Sink.NUMBERING_UPPER_ROMANpublic void numberedListItem()
SinknumberedListItem in interface SinkSink.numberedListItem(SinkEventAttributes)public void numberedListItem(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
numberedListItem in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void numberedListItem_()
SinknumberedListItem_ in interface Sinkpublic void numberedList_()
SinknumberedList_ in interface Sinkpublic void pageBreak()
Sinkpublic void paragraph()
Sinkparagraph in interface SinkSink.paragraph(SinkEventAttributes)public void paragraph(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes
plus ALIGN.
paragraph in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void paragraph_()
Sinkparagraph_ in interface Sinkpublic void rawText(String text)
Sinkpublic void section(int level, SinkEventAttributes attributes)
SinkSections with higher level have to be entirely contained within sections of lower level.
Supported attributes are the base attributes.
section in interface Sinklevel - the section level.attributes - A set of SinkEventAttributes, may be null.public void section1()
Sinksection1 in interface SinkSink.section(int,SinkEventAttributes)public void section1_()
Sinkpublic void section2()
SinkSink.section1() element.section2 in interface SinkSink.section(int,SinkEventAttributes)public void section2_()
Sinkpublic void section3()
SinkSink.section2() element.section3 in interface SinkSink.section(int,SinkEventAttributes)public void section3_()
Sinkpublic void section4()
SinkSink.section3() element.section4 in interface SinkSink.section(int,SinkEventAttributes)public void section4_()
Sinkpublic void section5()
SinkSink.section4() element.section5 in interface SinkSink.section(int,SinkEventAttributes)public void section5_()
Sinkpublic void section6()
SinkSink.section5() element.section6 in interface SinkSink.section(int,SinkEventAttributes)public void section6_()
Sinkpublic void sectionTitle()
SinksectionTitle in interface Sinkpublic void sectionTitle(int level, SinkEventAttributes attributes)
Sink
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.
sectionTitle in interface Sinklevel - the section title level.attributes - A set of SinkEventAttributes, may be null.public void sectionTitle1()
SinkSink.section1() element.sectionTitle1 in interface SinkSink.sectionTitle(int,SinkEventAttributes)public void sectionTitle1_()
SinksectionTitle1_ in interface Sinkpublic void sectionTitle2()
SinkSink.section2() element.sectionTitle2 in interface SinkSink.sectionTitle(int,SinkEventAttributes)public void sectionTitle2_()
SinksectionTitle2_ in interface Sinkpublic void sectionTitle3()
SinkSink.section3() element.sectionTitle3 in interface SinkSink.sectionTitle(int,SinkEventAttributes)public void sectionTitle3_()
SinksectionTitle3_ in interface Sinkpublic void sectionTitle4()
SinkSink.section4() element.sectionTitle4 in interface SinkSink.sectionTitle(int,SinkEventAttributes)public void sectionTitle4_()
SinksectionTitle4_ in interface Sinkpublic void sectionTitle5()
SinkSink.section5() element.sectionTitle5 in interface SinkSink.sectionTitle(int,SinkEventAttributes)public void sectionTitle5_()
SinksectionTitle5_ in interface Sinkpublic void sectionTitle6()
SinkSink.section6() element.sectionTitle6 in interface SinkSink.sectionTitle(int,SinkEventAttributes)public void sectionTitle6_()
SinksectionTitle6_ in interface Sinkpublic void sectionTitle_()
SinksectionTitle_ in interface Sinkpublic void sectionTitle_(int level)
SinksectionTitle_ in interface Sinklevel - the section title level.public void section_(int level)
Sinkpublic void table()
Sinktable in interface SinkSink.table(SinkEventAttributes)public void table(SinkEventAttributes attributes)
SinkThe 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.
table in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void tableCaption()
SinktableCaption in interface SinkSink.tableCaption(SinkEventAttributes)public void tableCaption(SinkEventAttributes attributes)
Sink
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.
tableCaption in interface Sinkattributes - A set of SinkEventAttributes, may be null.Sink.table(SinkEventAttributes)public void tableCaption_()
SinktableCaption_ in interface Sinkpublic void tableCell()
SinktableCell in interface SinkSink.tableCell(SinkEventAttributes)public void tableCell(String width)
Sinkpublic void tableCell(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes plus:
ABBRV,ALIGN,AXIS,BGCOLOR,COLSPAN,HEADERS,HEIGHT,NOWRAP,ROWSPAN,SCOPE,VALIGN,WIDTH.
tableCell in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void tableCell_()
SinktableCell_ in interface Sinkpublic void tableHeaderCell()
SinktableHeaderCell in interface SinkSink.tableHeaderCell(SinkEventAttributes)public void tableHeaderCell(String width)
SinktableHeaderCell in interface Sinkwidth - the size of the header cell.public void tableHeaderCell(SinkEventAttributes attributes)
Sink
Supported attributes are the same as for tableCell.
tableHeaderCell in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void tableHeaderCell_()
SinktableHeaderCell_ in interface Sinkpublic void tableRow()
SinktableRow in interface SinkSink.tableRow(SinkEventAttributes)public void tableRow(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes plus:
ALIGN,BGCOLOR,VALIGN.
tableRow in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void tableRows(int[] justification, boolean grid)
SinktableRows in interface Sinkjustification - 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.Sink.table(SinkEventAttributes),
Sink.JUSTIFY_CENTER,
Sink.JUSTIFY_LEFT,
Sink.JUSTIFY_RIGHTpublic void tableRows_()
SinktableRows_ in interface Sinkpublic void text(String text)
Sinktext in interface Sinktext - The text to write.Sink.text(String,SinkEventAttributes)public void text(String text, SinkEventAttributes attributes)
Sink
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").
text in interface Sinktext - The text to write.attributes - A set of SinkEventAttributes, may be null.public void title()
Sinktitle in interface SinkSink.title(SinkEventAttributes)public void title(SinkEventAttributes attributes)
Sink
Supported attributes are the base attributes.
title in interface Sinkattributes - A set of SinkEventAttributes, may be null.Sink.head(SinkEventAttributes)public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
Sinkunknown in interface Sinkname - 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.public void verbatim(boolean boxed)
Sinkpublic void verbatim(SinkEventAttributes attributes)
SinkText 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.
verbatim in interface Sinkattributes - A set of SinkEventAttributes, may be null.public void enableLogging(Log log)
LogEnabledDoxia logger for this Doxia component.enableLogging in interface LogEnabledlog - a Log.Copyright © 2005–2017 The Apache Software Foundation. All rights reserved.