|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.doxia.sink.AbstractSink org.apache.maven.doxia.sink.SinkAdapter org.apache.maven.doxia.sink.AbstractTextSink org.apache.maven.doxia.module.twiki.TWikiSink
public class TWikiSink
TWiki Sink implementation.
Note: The encoding used is UTF-8.
Field Summary |
---|
Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup |
---|
PIPE |
Fields inherited from interface org.apache.maven.doxia.markup.Markup |
---|
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR |
Fields inherited from interface org.apache.maven.doxia.sink.Sink |
---|
JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5 |
Constructor Summary | |
---|---|
protected |
TWikiSink(Writer writer)
Constructor, initialize the Writer and the variables. |
Method Summary | |
---|---|
void |
anchor_()
Not used. |
void |
anchor(String name)
Starts an element which defines an anchor. |
void |
anchor(String name,
SinkEventAttributes attributes)
Starts an element which defines an anchor.
The 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 |
void |
author_()
Not used. |
void |
author()
Not used. |
void |
author(SinkEventAttributes attributes)
Starts an author element. This is used to identify the author of the document.
Supported attributes are: |
void |
body_()
Not used. |
void |
body()
Not used. |
void |
body(SinkEventAttributes attributes)
Starts the body of a document. This contains the document's content.
Supported attributes are the |
void |
bold_()
Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with
STYLE instead. |
void |
bold()
Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with
STYLE instead. |
void |
close()
Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect. |
void |
comment(String comment)
Not used. |
protected void |
content(String text)
Write HTML escaped text to output. |
void |
date_()
Not used. |
void |
date()
Not used. |
void |
date(SinkEventAttributes attributes)
Starts the date element. This is used to identify the date of the document. Supported attributes are: none. |
void |
definedTerm_()
Not used. |
void |
definedTerm()
Not used. |
void |
definedTerm(SinkEventAttributes attributes)
Starts a definition term element within a definition list.
Supported attributes are the |
void |
definition_()
Ends a definition element within a definition list. |
void |
definition()
Starts a definition element within a definition list. |
void |
definition(SinkEventAttributes attributes)
Starts a definition element within a definition list.
Supported attributes are the |
void |
definitionList_()
Not used. |
void |
definitionList()
Not used. |
void |
definitionList(SinkEventAttributes attributes)
Starts a definition list.
Supported attributes are the |
void |
definitionListItem_()
Not used. |
void |
definitionListItem()
Starts a list item element within a definition list. |
void |
definitionListItem(SinkEventAttributes attributes)
Starts a list item element within a definition list.
Every definitionListItem has to contain exactly one
Supported attributes are the |
protected static String |
escapeHTML(String text)
Forward to HtmlTools.escapeHTML( text ). |
void |
figure_()
Not used. |
void |
figure()
Starts a basic image embedding element. |
void |
figure(SinkEventAttributes attributes)
Starts a basic image embedding element. The canonical sequence of events for the figure element is: sink.figure(); sink.figureGraphics( "figure.png" ); sink.figureCaption(); sink.text( "Figure caption",); sink.figureCaption_(); sink.figure_(); where the figureCaption element is optional. However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.
NOTE also that the figureGraphics() event does not have to be embedded
inside figure(), in particular for in-line images the figureGraphics() should be used
stand-alone (in HTML language, figureGraphics() produces a
Supported attributes are the |
void |
figureCaption_()
Not used. |
void |
figureCaption()
Not used. |
void |
figureCaption(SinkEventAttributes attributes)
Starts a figure caption.
Supported attributes are the |
void |
figureGraphics(String name)
Adding a source of a graphic. |
void |
figureGraphics(String src,
SinkEventAttributes attributes)
Adds a graphic element.
The
Supported attributes are the
If the |
void |
flush()
Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect. |
void |
head_()
Ends the head element. |
void |
head()
Starts the head element. |
void |
head(SinkEventAttributes attributes)
Starts the head element.
This contains information about the current document, (eg its title) that is not
considered document content. The head element is optional but if it exists, it has to be
unique within a sequence of Sink events that produces one output document, and it has
to come before the 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:
|
void |
horizontalRule()
Adding a separator of sections from a text to each other. |
void |
horizontalRule(SinkEventAttributes attributes)
Adds a horizontal separator rule.
Supported attributes are the
|
protected void |
init()
This is called in Sink.head() or in Sink.close() , and can be used
to set the sink into a clear state so it can be re-used. |
void |
italic_()
Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with
STYLE instead. |
void |
italic()
Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with
STYLE instead. |
void |
lineBreak()
Not used. |
void |
lineBreak(SinkEventAttributes attributes)
Adds a line break. Supported attributes are:
|
void |
link_()
Ends a link element. |
void |
link(String name)
Starts an element which defines a link. |
void |
link(String name,
SinkEventAttributes attributes)
Starts a link.
The
Supported attributes are the
If |
void |
list_()
Ends an unordered list element. |
void |
list()
Starts an unordered list element. |
void |
list(SinkEventAttributes attributes)
Starts an unordered list.
Supported attributes are the |
void |
listItem_()
Ends a list item element within an unordered list. |
void |
listItem()
Starts a list item element within an unordered list. |
void |
listItem(SinkEventAttributes attributes)
Starts a list item element within an unordered list.
Supported attributes are the |
void |
monospaced_()
Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with
STYLE instead. |
void |
monospaced()
Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with
STYLE instead. |
void |
nonBreakingSpace()
Not used. |
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.
Supported attributes are the |
void |
numberedListItem_()
Ends a list item element within an ordered list. |
void |
numberedListItem()
Starts a list item element within an ordered list. |
void |
numberedListItem(SinkEventAttributes attributes)
Starts a list item element within an ordered list.
Supported attributes are the |
void |
pageBreak()
Not used. |
void |
paragraph_()
Ends a paragraph element. |
void |
paragraph()
Not used. |
void |
paragraph(SinkEventAttributes attributes)
Starts a paragraph.
Supported attributes are the |
void |
rawText(String text)
Not used. |
void |
section_(int level)
Not used. |
void |
section(int level,
SinkEventAttributes attributes)
Not used. |
void |
section1_()
Not used. |
void |
section1()
Not used. |
void |
section2_()
Not used. |
void |
section2()
Not used. |
void |
section3_()
Not used. |
void |
section3()
Not used. |
void |
section4_()
Not used. |
void |
section4()
Not used. |
void |
section5_()
Not used. |
void |
section5()
Not used. |
void |
sectionTitle_()
Not used. |
void |
sectionTitle_(int level)
Ends a section title at the given level. |
void |
sectionTitle()
Not used. |
void |
sectionTitle(int level,
SinkEventAttributes attributes)
Start a new section title at the given level.
This element is optional, but if it exists, it has to be contained, and be the first
element, within a corresponding 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 |
void |
sectionTitle1_()
Ends a first title heading element. |
void |
sectionTitle1()
Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section1() element. |
void |
sectionTitle2_()
Ends a second title heading element. |
void |
sectionTitle2()
Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section2() element. |
void |
sectionTitle3_()
Ends a third title heading element. |
void |
sectionTitle3()
Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section3() element. |
void |
sectionTitle4_()
Ends a 4th title heading element. |
void |
sectionTitle4()
Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section4() element. |
void |
sectionTitle5_()
Ends a 5th title heading element. |
void |
sectionTitle5()
Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within a Sink.section5() element. |
void |
table_()
Not used. |
void |
table()
Not used. |
void |
table(SinkEventAttributes attributes)
Starts a table. The canonical sequence of events for the table element is: sink.table(); sink.tableRows( justify, true ); sink.tableRow(); sink.tableCell(); sink.text( "cell 1,1" ); sink.tableCell_(); sink.tableCell(); sink.text( "cell 1,2" ); sink.tableCell_(); sink.tableRow_(); sink.tableRows_(); sink.tableCaption(); sink.text( "Table caption" ); sink.tableCaption_(); sink.table_(); where the tableCaption element is optional.
However, NOTE that the order of tableCaption and
Supported attributes are the
|
void |
tableCaption_()
Not used. |
void |
tableCaption()
Not used. |
void |
tableCaption(SinkEventAttributes attributes)
Starts a table caption.
Note that the order of tableCaption and
Supported attributes are the |
void |
tableCell_()
Ends a cell element. |
void |
tableCell()
Starts a cell element which defines a cell that contains data. |
void |
tableCell(SinkEventAttributes attributes)
Starts a table cell.
Supported attributes are the
|
void |
tableCell(String width)
Starts a cell element which defines a cell that contains data. |
void |
tableHeaderCell_()
Ends a cell header element. |
void |
tableHeaderCell()
Starts a cell element which defines a cell that contains header information. |
void |
tableHeaderCell(SinkEventAttributes attributes)
Starts a table header cell.
Supported attributes are the same as for |
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.
Supported attributes are the
|
void |
tableRows_()
Not used. |
void |
tableRows(int[] justification,
boolean grid)
Not used. |
void |
text(String text)
Adding a text. |
void |
text(String text,
SinkEventAttributes attributes)
Adds a text.
The
If
Supported attributes are the
|
void |
title_()
Not used. |
void |
title()
Not used. |
void |
title(SinkEventAttributes attributes)
Starts the title element. This is used to identify the document.
Supported attributes are the |
void |
unknown(String name,
Object[] requiredParams,
SinkEventAttributes attributes)
Not used. |
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. 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
|
Methods inherited from class org.apache.maven.doxia.sink.AbstractSink |
---|
enableLogging, getLog, unifyEOLs |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TWikiSink(Writer writer)
writer
- not null writer to write the result. Should be an UTF-8 Writer.
You could use newWriter
methods from WriterFactory
.Method Detail |
---|
public void anchor(String name)
anchor
in interface Sink
anchor
in class SinkAdapter
name
- the name of the anchor.Sink.anchor(String,SinkEventAttributes)
public 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.
anchor
in interface Sink
anchor
in class SinkAdapter
name
- the name of the anchor. This has to be a valid SGML NAME token.attributes
- A set of SinkEventAttributes
, may be null
.public void anchor_()
anchor_
in interface Sink
anchor_
in class SinkAdapter
public void author()
author
in interface Sink
author
in class SinkAdapter
Sink.author(SinkEventAttributes)
public void author(SinkEventAttributes attributes)
Supported attributes are: EMAIL
.
author
in interface Sink
author
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.Sink.head(SinkEventAttributes)
public void author_()
author_
in interface Sink
author_
in class SinkAdapter
public void body()
body
in interface Sink
body
in class SinkAdapter
Sink.body(SinkEventAttributes)
public void body(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
body
in interface Sink
body
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.Sink.head(SinkEventAttributes)
public void body_()
body_
in interface Sink
body_
in class SinkAdapter
public void bold()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
bold
in interface Sink
bold
in class SinkAdapter
public void bold_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
bold_
in interface Sink
bold_
in class SinkAdapter
public void comment(String comment)
comment
in interface Sink
comment
in class SinkAdapter
comment
- The comment to write.public void close()
close
in interface Sink
close
in class SinkAdapter
public void date()
YYYY-MM-DDwhere
date
in interface Sink
date
in class SinkAdapter
Sink.date(SinkEventAttributes)
public void date(SinkEventAttributes attributes)
Supported attributes are: none.
date
in interface Sink
date
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.Sink.head(SinkEventAttributes)
public void date_()
date_
in interface Sink
date_
in class SinkAdapter
public void definedTerm()
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
Sink.definedTerm(SinkEventAttributes)
public void definedTerm(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void definedTerm_()
definedTerm_
in interface Sink
definedTerm_
in class SinkAdapter
public void definition()
definition
in interface Sink
definition
in class SinkAdapter
Sink.definition(SinkEventAttributes)
public void definition(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
definition
in interface Sink
definition
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void definition_()
definition_
in interface Sink
definition_
in class SinkAdapter
public void definitionList()
definitionList
in interface Sink
definitionList
in class SinkAdapter
Sink.definitionList(SinkEventAttributes)
public void definitionList(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
definitionList
in interface Sink
definitionList
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void definitionList_()
definitionList_
in interface Sink
definitionList_
in class SinkAdapter
public void definitionListItem()
definitionListItem
in interface Sink
definitionListItem
in class SinkAdapter
Sink.definitionListItem(SinkEventAttributes)
public void definitionListItem(SinkEventAttributes attributes)
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 Sink
definitionListItem
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void definitionListItem_()
definitionListItem_
in interface Sink
definitionListItem_
in class SinkAdapter
public void figure()
figure
in interface Sink
figure
in class SinkAdapter
Sink.figure(SinkEventAttributes)
public 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
.
figure
in interface Sink
figure
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void figure_()
figure_
in interface Sink
figure_
in class SinkAdapter
public void figureCaption()
figureCaption
in interface Sink
figureCaption
in class SinkAdapter
Sink.figureCaption(SinkEventAttributes)
public void figureCaption(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
figureCaption
in interface Sink
figureCaption
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.Sink.figure(SinkEventAttributes)
public void figureCaption_()
figureCaption_
in interface Sink
figureCaption_
in class SinkAdapter
public void figureGraphics(String name)
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
name
- the sourcepublic void 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.
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
src
- the image source, a valid URL.attributes
- A set of SinkEventAttributes
, may be null
.Sink.figure(SinkEventAttributes)
public void flush()
flush
in interface Sink
flush
in class SinkAdapter
public void head()
head
in interface Sink
head
in class SinkAdapter
Sink.head(SinkEventAttributes)
public 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 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 Sink
head
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void head_()
head_
in interface Sink
head_
in class SinkAdapter
public void horizontalRule()
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
Sink.horizontalRule(SinkEventAttributes)
public void horizontalRule(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus:
ALIGN
,NOSHADE
,SIZE
,WIDTH
.
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void italic()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
italic
in interface Sink
italic
in class SinkAdapter
public void italic_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
italic_
in interface Sink
italic_
in class SinkAdapter
public void lineBreak()
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
Sink.lineBreak(SinkEventAttributes)
public void lineBreak(SinkEventAttributes attributes)
Supported attributes are:
ID
,CLASS
,TITLE
,STYLE
.
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void link(String name)
link
in interface Sink
link
in class SinkAdapter
name
- the name of the link.Sink.link(String,SinkEventAttributes)
public void link(String name, SinkEventAttributes attributes)
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 Sink
link
in class SinkAdapter
name
- the name of the link.attributes
- A set of SinkEventAttributes
, may be null
.public void link_()
link_
in interface Sink
link_
in class SinkAdapter
public void list()
list
in interface Sink
list
in class SinkAdapter
Sink.list(SinkEventAttributes)
public void list(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
list
in interface Sink
list
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void list_()
list_
in interface Sink
list_
in class SinkAdapter
public void listItem()
listItem
in interface Sink
listItem
in class SinkAdapter
Sink.listItem(SinkEventAttributes)
public void listItem(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
listItem
in interface Sink
listItem
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void listItem_()
listItem_
in interface Sink
listItem_
in class SinkAdapter
public void monospaced()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
monospaced
in interface Sink
monospaced
in class SinkAdapter
public void monospaced_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.
monospaced_
in interface Sink
monospaced_
in class SinkAdapter
public void nonBreakingSpace()
nonBreakingSpace
in interface Sink
nonBreakingSpace
in class SinkAdapter
public void numberedList(int numbering)
numberedList
in interface Sink
numberedList
in class SinkAdapter
numbering
- the numbering style.Sink.numberedList(int,SinkEventAttributes)
public void numberedList(int numbering, SinkEventAttributes attributes)
Supported attributes are the base attributes
.
numberedList
in interface Sink
numberedList
in class SinkAdapter
numbering
- 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_ROMAN
public void numberedList_()
numberedList_
in interface Sink
numberedList_
in class SinkAdapter
public void numberedListItem()
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
Sink.numberedListItem(SinkEventAttributes)
public void numberedListItem(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void numberedListItem_()
numberedListItem_
in interface Sink
numberedListItem_
in class SinkAdapter
public void pageBreak()
pageBreak
in interface Sink
pageBreak
in class SinkAdapter
public void paragraph()
paragraph
in interface Sink
paragraph
in class SinkAdapter
Sink.paragraph(SinkEventAttributes)
public void paragraph(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus ALIGN
.
paragraph
in interface Sink
paragraph
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void paragraph_()
paragraph_
in interface Sink
paragraph_
in class SinkAdapter
public void rawText(String text)
rawText
in interface Sink
rawText
in class SinkAdapter
text
- The text to write.public 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
.
section
in interface Sink
section
in class SinkAdapter
level
- the section level.attributes
- A set of SinkEventAttributes
, may be null
.public void section1()
section1
in interface Sink
section1
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section1_()
section1_
in interface Sink
section1_
in class SinkAdapter
public void section2()
Sink.section1()
element.
section2
in interface Sink
section2
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section2_()
section2_
in interface Sink
section2_
in class SinkAdapter
public void section3()
Sink.section2()
element.
section3
in interface Sink
section3
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section3_()
section3_
in interface Sink
section3_
in class SinkAdapter
public void section4()
Sink.section3()
element.
section4
in interface Sink
section4
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section4_()
section4_
in interface Sink
section4_
in class SinkAdapter
public void section5()
Sink.section4()
element.
section5
in interface Sink
section5
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section5_()
section5_
in interface Sink
section5_
in class SinkAdapter
public void section_(int level)
section_
in interface Sink
section_
in class SinkAdapter
level
- the section level.public void sectionTitle()
sectionTitle
in interface Sink
sectionTitle
in class SinkAdapter
public 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
.
sectionTitle
in interface Sink
sectionTitle
in class SinkAdapter
level
- the section title level.attributes
- A set of SinkEventAttributes
, may be null
.public void sectionTitle1()
Sink.section1()
element.
sectionTitle1
in interface Sink
sectionTitle1
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle1_()
sectionTitle1_
in interface Sink
sectionTitle1_
in class SinkAdapter
public void sectionTitle2()
Sink.section2()
element.
sectionTitle2
in interface Sink
sectionTitle2
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle2_()
sectionTitle2_
in interface Sink
sectionTitle2_
in class SinkAdapter
public void sectionTitle3()
Sink.section3()
element.
sectionTitle3
in interface Sink
sectionTitle3
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle3_()
sectionTitle3_
in interface Sink
sectionTitle3_
in class SinkAdapter
public void sectionTitle4()
Sink.section4()
element.
sectionTitle4
in interface Sink
sectionTitle4
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle4_()
sectionTitle4_
in interface Sink
sectionTitle4_
in class SinkAdapter
public void sectionTitle5()
Sink.section5()
element.
sectionTitle5
in interface Sink
sectionTitle5
in class SinkAdapter
Sink.sectionTitle(int,SinkEventAttributes)
public void sectionTitle5_()
sectionTitle5_
in interface Sink
sectionTitle5_
in class SinkAdapter
public void sectionTitle_()
sectionTitle_
in interface Sink
sectionTitle_
in class SinkAdapter
public void sectionTitle_(int level)
sectionTitle_
in interface Sink
sectionTitle_
in class SinkAdapter
level
- the section title level.public void table()
table
in interface Sink
table
in class SinkAdapter
Sink.table(SinkEventAttributes)
public 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
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 Sink
table
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void table_()
table_
in interface Sink
table_
in class SinkAdapter
public void tableCaption()
tableCaption
in interface Sink
tableCaption
in class SinkAdapter
Sink.tableCaption(SinkEventAttributes)
public void tableCaption(SinkEventAttributes attributes)
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 Sink
tableCaption
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.Sink.table(SinkEventAttributes)
public void tableCaption_()
tableCaption_
in interface Sink
tableCaption_
in class SinkAdapter
public void tableCell()
tableCell
in interface Sink
tableCell
in class SinkAdapter
Sink.tableCell(SinkEventAttributes)
public void tableCell(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus:
ABBRV
,ALIGN
,AXIS
,BGCOLOR
,COLSPAN
,HEADERS
,HEIGHT
,NOWRAP
,ROWSPAN
,SCOPE
,VALIGN
,WIDTH
.
tableCell
in interface Sink
tableCell
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void tableCell(String width)
tableCell
in interface Sink
tableCell
in class SinkAdapter
width
- the size of the cell.public void tableCell_()
tableCell_
in interface Sink
tableCell_
in class SinkAdapter
public void tableHeaderCell()
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
Sink.tableHeaderCell(SinkEventAttributes)
public void tableHeaderCell(SinkEventAttributes attributes)
Supported attributes are the same as for tableCell
.
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void tableHeaderCell(String width)
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
width
- the size of the header cell.public void tableHeaderCell_()
tableHeaderCell_
in interface Sink
tableHeaderCell_
in class SinkAdapter
public void tableRow()
tableRow
in interface Sink
tableRow
in class SinkAdapter
Sink.tableRow(SinkEventAttributes)
public void tableRow(SinkEventAttributes attributes)
Supported attributes are the base attributes
plus:
ALIGN
,BGCOLOR
,VALIGN
.
tableRow
in interface Sink
tableRow
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void tableRow_()
tableRow_
in interface Sink
tableRow_
in class SinkAdapter
public void tableRows(int[] justification, boolean grid)
tableRows
in interface Sink
tableRows
in class SinkAdapter
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.Sink.table(SinkEventAttributes)
,
Sink.JUSTIFY_CENTER
,
Sink.JUSTIFY_LEFT
,
Sink.JUSTIFY_RIGHT
public void tableRows_()
tableRows_
in interface Sink
tableRows_
in class SinkAdapter
public void text(String text)
text
in interface Sink
text
in class SinkAdapter
text
- The text to write.Sink.text(String,SinkEventAttributes)
public 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
VALIGN
(values "sub", "sup"),DECORATION
(values "underline", "overline", "line-through"),STYLE
(values "italic", "bold", "monospaced").
text
in interface Sink
text
in class SinkAdapter
text
- The text to write.attributes
- A set of SinkEventAttributes
, may be null
.public void title()
title
in interface Sink
title
in class SinkAdapter
Sink.title(SinkEventAttributes)
public void title(SinkEventAttributes attributes)
Supported attributes are the base attributes
.
title
in interface Sink
title
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.Sink.head(SinkEventAttributes)
public void title_()
title_
in interface Sink
title_
in class SinkAdapter
public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
unknown
in interface Sink
unknown
in class SinkAdapter
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
.public void verbatim(boolean boxed)
verbatim
in interface Sink
verbatim
in class SinkAdapter
boxed
- true to add a box, false otherwisepublic 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
(value: "boxed"),ALIGN
,WIDTH
.
verbatim
in interface Sink
verbatim
in class SinkAdapter
attributes
- A set of SinkEventAttributes
, may be null
.public void verbatim_()
verbatim_
in interface Sink
verbatim_
in class SinkAdapter
protected void content(String text)
text
- The text to write.protected void init()
Sink.head()
or in Sink.close()
, and can be used
to set the sink into a clear state so it can be re-used.
init
in class AbstractSink
protected static String escapeHTML(String text)
text
- the String to escape, may be null
HtmlTools.escapeHTML(String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |