Class Xhtml5BaseSink
- All Implemented Interfaces:
LogEnabled
,HtmlMarkup
,Markup
,XmlMarkup
,Sink
- Direct Known Subclasses:
Xhtml5Sink
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final LinkedList<Integer>
Stack of current table cell.private final LinkedList<int[]>
Stack of alignment int[] of table cells.Keep track of the main and div tags for content events.private boolean
Used to style successive table rows differently.private boolean
An indication on if we're inside a head.Keep track of the closing tags for inline events.private final LinkedList<Boolean>
Stack of justification of table cells.private boolean
An indication on if we're inside a paragraph flag.protected MutableAttributeSet
used to store attributes passed to table().private final LinkedList<String>
The stack of table captionprivate final LinkedList<StringWriter>
private final LinkedList<org.codehaus.plexus.util.xml.PrettyPrintXMLWriter>
private final LinkedList<StringWriter>
The stack of StringWriter to write the table result temporary, so we could play with the output DOXIA-177.protected boolean
Flag to know iftableRows(int[], boolean)
is called or not.private StringBuffer
Used to collect text events mainly for the head events.private boolean
An indication on if we're in verbatim mode.Map of warn messages with a String as key to describe the error type and a Set as value.private final PrintWriter
The PrintWriter to write the result.Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup
A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BASEFONT, BDI, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIR, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FONT, FOOTER, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, KEYGEN, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, META, METER, NAV, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, OUTPUT, P, PARAM, PICTURE, PRE, PROGRESS, Q, RB, RP, RT, RTC, RUBY, S, SAMP, SCRIPT, SECTION, SELECT, SMALL, SOURCE, SPAN, STRIKE, STRONG, STYLE, SUB, SUMMARY, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, TT, U, UL, VAR, VIDEO, WBR
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, SECTION_LEVEL_6
Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
address()
Starts an address element.void
address
(SinkEventAttributes attributes) Starts an address element.void
address_()
Ends an address element.void
Starts an element which defines an anchor.void
anchor
(String name, SinkEventAttributes attributes) Starts an element which defines an anchor.void
anchor_()
Ends an anchor element.void
article()
Starts an article within a document.void
article
(SinkEventAttributes attributes) Starts an article within a document.void
article_()
Ends the article element.void
Starts a blockquote element.void
blockquote
(SinkEventAttributes attributes) Starts a blockquote element.void
Ends an blockquote element.void
bold()
Starts a bold element.void
bold_()
Ends a bold element.void
close()
Close the writer or the stream, if needed.void
Add a comment.void
content()
Start the main content section between the header and the footer within the sections and/or body.protected void
Write HTML escaped text to output.void
content
(SinkEventAttributes attributes) Start the main content section between the header and the footer within the sections and/or body.void
content_()
Ends a main content section.void
Starts a data element which groups together other elements representing microformats.void
data
(String value, SinkEventAttributes attributes) Starts a data element which groups together other elements representing microformats.void
data_()
Ends an data element.void
Starts a definition term element within a definition list.void
definedTerm
(SinkEventAttributes attributes) Starts a definition term element within a definition list.void
Ends a definition term element within a definition list.void
Starts a definition element within a definition list.void
definition
(SinkEventAttributes attributes) Starts a definition element within a definition list.void
Ends a definition element within a definition list.void
Starts a definition list element.void
definitionList
(SinkEventAttributes attributes) Starts a definition list.void
Ends a definition list element.void
division()
Starts a division element grouping together other elements.void
division
(SinkEventAttributes attributes) Starts a division element grouping together other elements.void
Ends a division element.protected static String
Forward to HtmlTools.encodeURL( text ).private SinkEventAttributes
escapeAttributeValues
(SinkEventAttributes attributes) protected static String
escapeHTML
(String text) Forward to HtmlTools.escapeHTML( text ).void
figure()
Starts a basic image embedding element.void
figure
(SinkEventAttributes attributes) Starts a basic image embedding element.void
figure_()
Ends a basic image embedding element.void
Starts a caption of an image element.void
figureCaption
(SinkEventAttributes attributes) Starts a figure caption.void
Ends a caption of an image.void
figureGraphics
(String name) Adding a source of a graphic.void
figureGraphics
(String src, SinkEventAttributes attributes) Adds a graphic element.void
flush()
Flush the writer or the stream, if needed.void
footer()
Start a new footer within the section or body.void
footer
(SinkEventAttributes attributes) Start a new footer within the section or body.void
footer_()
Ends a footer element.protected int
Getter for the fieldcellCount
.protected int[]
Getter for the fieldcellJustif
.protected StringBuffer
To use mainly when playing with the head events.void
header()
Start a new header within the section or body.void
header
(SinkEventAttributes attributes) Start a new header within the section or body.void
header_()
Ends a header element.void
Adding a separator of sections from a text to each other.void
horizontalRule
(SinkEventAttributes attributes) Adds a horizontal separator rule.protected void
init()
This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.void
inline()
Starts an inline element.void
inline
(SinkEventAttributes attributes) Starts an inline element.void
inline_()
Ends an inline element.private void
inlineSemantics
(SinkEventAttributes attributes, String semantic, List<HTML.Tag> tags, HTML.Tag tag) protected boolean
isHeadFlag.protected boolean
isVerbatimFlag.void
italic()
Starts an italic element.void
italic_()
Ends an italic element.void
Adds a line break.void
lineBreak
(SinkEventAttributes attributes) Adds a line break.void
Adds a line break opportunity.void
lineBreakOpportunity
(SinkEventAttributes attributes) Adds a line break opportunity.void
Starts an element which defines a link.private void
link
(String href, String target, MutableAttributeSet attributes) Adds a link with an optional target.void
link
(String name, SinkEventAttributes attributes) Starts a link.void
link_()
Ends a link element.void
list()
Starts an unordered list element.void
list
(SinkEventAttributes attributes) Starts an unordered list.void
list_()
Ends an unordered list element.void
listItem()
Starts a list item element within an unordered list.void
listItem
(SinkEventAttributes attributes) Starts a list item element within an unordered list.void
Ends a list item element within an unordered list.private void
logMessage
(String key, String msg) If debug mode is enabled, log themsg
as is, otherwise add unique msg inwarnMessages
.void
Starts a monospaced element.void
Ends a monospaced element.void
Starts a navigation section within a document.void
navigation
(SinkEventAttributes attributes) Starts a navigation section within a document.void
Ends the navigation element.void
Adding a non breaking space, ie a space without any special formatting operations.void
numberedList
(int numbering) The default list style depends on the numbering.void
numberedList
(int numbering, SinkEventAttributes attributes) The default list style depends on the numbering.void
Ends an ordered list element.void
Starts a list item element within an ordered list.void
numberedListItem
(SinkEventAttributes attributes) Starts a list item element within an ordered list.void
Ends a list item element within an ordered list.protected void
onSection
(int depth, SinkEventAttributes attributes) Starts a section.protected void
onSection_
(int depth) Ends a section.protected void
onSectionTitle
(int depth, SinkEventAttributes attributes) Starts a section title.protected void
onSectionTitle_
(int depth) Ends a section title.void
Adding a new page separator.void
Starts an element which represents a paragraph.void
paragraph
(SinkEventAttributes attributes) Starts a paragraph.void
Ends a paragraph element.void
Adding a raw text, ie a text without any special formatting operations.protected void
Deprecated.protected void
Reset the text buffer.void
section
(int level, SinkEventAttributes attributes) Start a new section at the given level.void
section_
(int level) Ends a section at the given level.void
section1()
Starts a first heading element which contains the topic of the section.void
Ends a first heading element.void
section2()
Starts a second heading element which contains the topic of the section.void
Ends a second heading element.void
section3()
Starts a third heading element which contains the topic of the section.void
Ends a third heading element.void
section4()
Starts a 4th heading element which contains the topic of the section.void
Ends a 4th heading element.void
section5()
Starts a 5th heading element which contains the topic of the section.void
Ends a 5th heading element.void
sectionTitle
(int level, SinkEventAttributes attributes) Start a new section title at the given level.void
sectionTitle_
(int level) Ends a section title at the given level.void
Starts a first title heading element.void
Ends a first title heading element.void
Starts a second title heading element.void
Ends a second title heading element.void
Starts a third title heading element.void
Ends a third title heading element.void
Starts a 4th title heading element.void
Ends a 4th title heading element.void
Starts a 5th title heading element.void
Ends a 5th title heading element.protected void
setCellCount
(int count) Setter for the fieldcellCount
.protected void
setCellJustif
(int[] justif) Setter for the fieldcellJustif
.protected void
setHeadFlag
(boolean headFlag) Setter for the fieldheadFlag
.protected void
setVerbatimFlag
(boolean verb) Setter for the fieldverbatimFlag
.void
sidebar()
Starts a sidebar section within a document.void
sidebar
(SinkEventAttributes attributes) Starts a sidebar section within a document.void
sidebar_()
Ends the sidebar element.void
table()
Starts a table element for marking up tabular information in a document.void
table
(SinkEventAttributes attributes) Starts a table.void
table_()
Ends a table element.void
Starts a caption element of a table.void
tableCaption
(SinkEventAttributes attributes) Starts a table caption.void
Ends a caption element of a table.void
Starts a cell element which defines a cell that contains data.private void
tableCell
(boolean headerRow, MutableAttributeSet attributes) void
Starts a cell element which defines a cell that contains data.void
tableCell
(SinkEventAttributes attributes) Starts a table cell.void
Ends a cell element.private void
tableCell_
(boolean headerRow) Ends a table cell.void
Starts a cell element which defines a cell that contains header information.void
tableHeaderCell
(String width) Starts a cell element which defines a cell that contains header information.void
tableHeaderCell
(SinkEventAttributes attributes) Starts a table header cell.void
Ends a cell header element.void
tableRow()
The default class style isa
orb
depending the row id.void
tableRow
(SinkEventAttributes attributes) The default class style isa
orb
depending the row id.void
Ends a row element.void
tableRows
(int[] justification, boolean grid) The default class style isbodyTable
.void
Ends an element that contains rows of table data.void
Adding a text.void
text
(String text, SinkEventAttributes attributes) Adds a text.void
Starts a time element which groups together other elements representing a time.void
time
(String datetime, SinkEventAttributes attributes) Starts a time element which groups together other elements representing a time.void
time_()
Ends a time element.void
unknown
(String name, Object[] requiredParams, SinkEventAttributes attributes) Add an unknown event.void
verbatim
(boolean boxed) The default class style for boxed issource
.void
verbatim
(SinkEventAttributes attributes) The default class style for boxed issource
.void
Ends a verbatim element.protected void
verbatimContent
(String text) Write HTML escaped text to output.protected void
Write a text to the sink.protected void
Ends a Tag without writing an EOL.protected void
writeStartTag
(HTML.Tag t, MutableAttributeSet att, boolean isSimpleTag) Starts a Tag with attributes.Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag
Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
author, author, author_, body, body, body_, date, date, date_, definitionListItem, definitionListItem, definitionListItem_, head, head, head_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, title, title, title_
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
Field Details
-
writer
The PrintWriter to write the result. -
textBuffer
Used to collect text events mainly for the head events. -
headFlag
private boolean headFlagAn indication on if we're inside a head. -
contentStack
Keep track of the main and div tags for content events. -
inlineStack
Keep track of the closing tags for inline events. -
paragraphFlag
private boolean paragraphFlagAn indication on if we're inside a paragraph flag. -
verbatimFlag
private boolean verbatimFlagAn indication on if we're in verbatim mode. -
cellJustifStack
Stack of alignment int[] of table cells. -
isCellJustifStack
Stack of justification of table cells. -
cellCountStack
Stack of current table cell. -
evenTableRow
private boolean evenTableRowUsed to style successive table rows differently. -
tableContentWriterStack
The stack of StringWriter to write the table result temporary, so we could play with the output DOXIA-177. -
tableCaptionWriterStack
-
tableCaptionXMLWriterStack
private final LinkedList<org.codehaus.plexus.util.xml.PrettyPrintXMLWriter> tableCaptionXMLWriterStack -
tableCaptionStack
The stack of table caption -
tableAttributes
used to store attributes passed to table(). -
tableRows
protected boolean tableRowsFlag to know iftableRows(int[], boolean)
is called or not. It is mainly to be backward compatible with some plugins (like checkstyle) which uses:sink.table(); sink.tableRow();
instead ofsink.table(); sink.tableRows( justify, true ); sink.tableRow();
-
warnMessages
Map of warn messages with a String as key to describe the error type and a Set as value. Using to reduce warn messages.
-
-
Constructor Details
-
Xhtml5BaseSink
Constructor, initialize the PrintWriter.- Parameters:
out
- The writer to write the result.
-
-
Method Details
-
getTextBuffer
To use mainly when playing with the head events.- Returns:
- the current buffer of text events.
-
setHeadFlag
protected void setHeadFlag(boolean headFlag) Setter for the field
headFlag
.- Parameters:
headFlag
- an header flag.
-
isHeadFlag
protected boolean isHeadFlag()isHeadFlag.
- Returns:
- the current headFlag.
-
setVerbatimFlag
protected void setVerbatimFlag(boolean verb) Setter for the field
verbatimFlag
.- Parameters:
verb
- a verbatim flag.
-
isVerbatimFlag
protected boolean isVerbatimFlag()isVerbatimFlag.
- Returns:
- the current verbatim flag.
-
setCellJustif
protected void setCellJustif(int[] justif) Setter for the field
cellJustif
.- Parameters:
justif
- the new cell justification array.
-
getCellJustif
protected int[] getCellJustif()Getter for the field
cellJustif
.- Returns:
- the current cell justification array.
-
setCellCount
protected void setCellCount(int count) Setter for the field
cellCount
.- Parameters:
count
- the new cell count.
-
getCellCount
protected int getCellCount()Getter for the field
cellCount
.- Returns:
- the current cell count.
-
resetState
protected void resetState()Deprecated.since 1.1.2, useinit()
instead of.Reset all variables. -
init
protected void init()This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.- Overrides:
init
in classAbstractSink
-
resetTextBuffer
protected void resetTextBuffer()Reset the text buffer. -
article
public void article()Starts an article within a document.- Specified by:
article
in interfaceSink
- Overrides:
article
in classSinkAdapter
- See Also:
-
article
Starts an article within a document.Supported attributes are the
base attributes
.- Specified by:
article
in interfaceSink
- Overrides:
article
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
article_
public void article_()Ends the article element.- Specified by:
article_
in interfaceSink
- Overrides:
article_
in classSinkAdapter
-
sidebar
public void sidebar()Starts a sidebar section within a document.- Specified by:
sidebar
in interfaceSink
- Overrides:
sidebar
in classSinkAdapter
- See Also:
-
sidebar
Starts a sidebar section within a document.Supported attributes are the
base attributes
.- Specified by:
sidebar
in interfaceSink
- Overrides:
sidebar
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
sidebar_
public void sidebar_()Ends the sidebar element.- Specified by:
sidebar_
in interfaceSink
- Overrides:
sidebar_
in classSinkAdapter
-
section
Start a new section at the given level.Sections with higher level have to be entirely contained within sections of lower level.
Supported attributes are the
base attributes
.- Specified by:
section
in interfaceSink
- Overrides:
section
in classSinkAdapter
- Parameters:
level
- the section level.attributes
- A set ofSinkEventAttributes
, may benull
.
-
sectionTitle
Start a new section title at the given level.This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding
section
element of the same level.NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).
Supported attributes are the
base attributes
plusALIGN
.- Specified by:
sectionTitle
in interfaceSink
- Overrides:
sectionTitle
in classSinkAdapter
- Parameters:
level
- the section title level.attributes
- A set ofSinkEventAttributes
, may benull
.
-
sectionTitle_
public void sectionTitle_(int level) Ends a section title at the given level.- Specified by:
sectionTitle_
in interfaceSink
- Overrides:
sectionTitle_
in classSinkAdapter
- Parameters:
level
- the section title level.
-
section_
public void section_(int level) Ends a section at the given level.- Specified by:
section_
in interfaceSink
- Overrides:
section_
in classSinkAdapter
- Parameters:
level
- the section level.
-
section1
public void section1()Starts a first heading element which contains the topic of the section.- Specified by:
section1
in interfaceSink
- Overrides:
section1
in classSinkAdapter
- See Also:
-
sectionTitle1
public 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 aSink.section1()
element.- Specified by:
sectionTitle1
in interfaceSink
- Overrides:
sectionTitle1
in classSinkAdapter
- See Also:
-
sectionTitle1_
public void sectionTitle1_()Ends a first title heading element.- Specified by:
sectionTitle1_
in interfaceSink
- Overrides:
sectionTitle1_
in classSinkAdapter
-
section1_
public void section1_()Ends a first heading element.- Specified by:
section1_
in interfaceSink
- Overrides:
section1_
in classSinkAdapter
-
section2
public void section2()Starts a second heading element which contains the topic of the section. This has to be contained within aSink.section1()
element.- Specified by:
section2
in interfaceSink
- Overrides:
section2
in classSinkAdapter
- See Also:
-
sectionTitle2
public 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 aSink.section2()
element.- Specified by:
sectionTitle2
in interfaceSink
- Overrides:
sectionTitle2
in classSinkAdapter
- See Also:
-
sectionTitle2_
public void sectionTitle2_()Ends a second title heading element.- Specified by:
sectionTitle2_
in interfaceSink
- Overrides:
sectionTitle2_
in classSinkAdapter
-
section2_
public void section2_()Ends a second heading element.- Specified by:
section2_
in interfaceSink
- Overrides:
section2_
in classSinkAdapter
-
section3
public void section3()Starts a third heading element which contains the topic of the section. This has to be contained within aSink.section2()
element.- Specified by:
section3
in interfaceSink
- Overrides:
section3
in classSinkAdapter
- See Also:
-
sectionTitle3
public 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 aSink.section3()
element.- Specified by:
sectionTitle3
in interfaceSink
- Overrides:
sectionTitle3
in classSinkAdapter
- See Also:
-
sectionTitle3_
public void sectionTitle3_()Ends a third title heading element.- Specified by:
sectionTitle3_
in interfaceSink
- Overrides:
sectionTitle3_
in classSinkAdapter
-
section3_
public void section3_()Ends a third heading element.- Specified by:
section3_
in interfaceSink
- Overrides:
section3_
in classSinkAdapter
-
section4
public void section4()Starts a 4th heading element which contains the topic of the section. This has to be contained within aSink.section3()
element.- Specified by:
section4
in interfaceSink
- Overrides:
section4
in classSinkAdapter
- See Also:
-
sectionTitle4
public 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 aSink.section4()
element.- Specified by:
sectionTitle4
in interfaceSink
- Overrides:
sectionTitle4
in classSinkAdapter
- See Also:
-
sectionTitle4_
public void sectionTitle4_()Ends a 4th title heading element.- Specified by:
sectionTitle4_
in interfaceSink
- Overrides:
sectionTitle4_
in classSinkAdapter
-
section4_
public void section4_()Ends a 4th heading element.- Specified by:
section4_
in interfaceSink
- Overrides:
section4_
in classSinkAdapter
-
section5
public void section5()Starts a 5th heading element which contains the topic of the section. This has to be contained within aSink.section4()
element.- Specified by:
section5
in interfaceSink
- Overrides:
section5
in classSinkAdapter
- See Also:
-
sectionTitle5
public 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 aSink.section5()
element.- Specified by:
sectionTitle5
in interfaceSink
- Overrides:
sectionTitle5
in classSinkAdapter
- See Also:
-
sectionTitle5_
public void sectionTitle5_()Ends a 5th title heading element.- Specified by:
sectionTitle5_
in interfaceSink
- Overrides:
sectionTitle5_
in classSinkAdapter
-
section5_
public void section5_()Ends a 5th heading element.- Specified by:
section5_
in interfaceSink
- Overrides:
section5_
in classSinkAdapter
-
onSection
Starts a section. The default class style issection
.- Parameters:
depth
- The level of the section.attributes
- some attributes. May be null.
-
onSection_
protected void onSection_(int depth) Ends a section.- Parameters:
depth
- The level of the section.- See Also:
-
onSectionTitle
Starts a section title.- Parameters:
depth
- The level of the section title.attributes
- some attributes. May be null.- See Also:
-
onSectionTitle_
protected void onSectionTitle_(int depth) Ends a section title.- Parameters:
depth
- The level of the section title.- See Also:
-
header
public void header()Start a new header within the section or body.- Specified by:
header
in interfaceSink
- Overrides:
header
in classSinkAdapter
-
header
Start a new header within the section or body.Supported attributes are the
base attributes
.- Specified by:
header
in interfaceSink
- Overrides:
header
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
header_
public void header_()Ends a header element.- Specified by:
header_
in interfaceSink
- Overrides:
header_
in classSinkAdapter
-
content
public void content()Start the main content section between the header and the footer within the sections and/or body.- Specified by:
content
in interfaceSink
- Overrides:
content
in classSinkAdapter
-
content
Start the main content section between the header and the footer within the sections and/or body.Supported attributes are the
base attributes
.- Specified by:
content
in interfaceSink
- Overrides:
content
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
content_
public void content_()Ends a main content section.- Specified by:
content_
in interfaceSink
- Overrides:
content_
in classSinkAdapter
-
list
public void list()Starts an unordered list element.- Specified by:
list
in interfaceSink
- Overrides:
list
in classSinkAdapter
- See Also:
-
list
Starts an unordered list.Supported attributes are the
base attributes
.- Specified by:
list
in interfaceSink
- Overrides:
list
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
list_
public void list_()Ends an unordered list element.- Specified by:
list_
in interfaceSink
- Overrides:
list_
in classSinkAdapter
- See Also:
-
listItem
public void listItem()Starts a list item element within an unordered list.- Specified by:
listItem
in interfaceSink
- Overrides:
listItem
in classSinkAdapter
- See Also:
-
listItem
Starts a list item element within an unordered list.Supported attributes are the
base attributes
.- Specified by:
listItem
in interfaceSink
- Overrides:
listItem
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
listItem_
public void listItem_()Ends a list item element within an unordered list.- Specified by:
listItem_
in interfaceSink
- Overrides:
listItem_
in classSinkAdapter
- See Also:
-
numberedList
public void numberedList(int numbering) The default list style depends on the numbering. Starts an ordered list element.- Specified by:
numberedList
in interfaceSink
- Overrides:
numberedList
in classSinkAdapter
- Parameters:
numbering
- the numbering style.- See Also:
-
numberedList
The default list style depends on the numbering. Starts an ordered list element.Supported attributes are the
base attributes
.- Specified by:
numberedList
in interfaceSink
- Overrides:
numberedList
in classSinkAdapter
- Parameters:
numbering
- the numbering style.attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
numberedList_
public void numberedList_()Ends an ordered list element.- Specified by:
numberedList_
in interfaceSink
- Overrides:
numberedList_
in classSinkAdapter
- See Also:
-
numberedListItem
public void numberedListItem()Starts a list item element within an ordered list.- Specified by:
numberedListItem
in interfaceSink
- Overrides:
numberedListItem
in classSinkAdapter
- See Also:
-
numberedListItem
Starts a list item element within an ordered list.Supported attributes are the
base attributes
.- Specified by:
numberedListItem
in interfaceSink
- Overrides:
numberedListItem
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
numberedListItem_
public void numberedListItem_()Ends a list item element within an ordered list.- Specified by:
numberedListItem_
in interfaceSink
- Overrides:
numberedListItem_
in classSinkAdapter
- See Also:
-
definitionList
public void definitionList()Starts a definition list element.- Specified by:
definitionList
in interfaceSink
- Overrides:
definitionList
in classSinkAdapter
- See Also:
-
definitionList
Starts a definition list.Supported attributes are the
base attributes
.- Specified by:
definitionList
in interfaceSink
- Overrides:
definitionList
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
definitionList_
public void definitionList_()Ends a definition list element.- Specified by:
definitionList_
in interfaceSink
- Overrides:
definitionList_
in classSinkAdapter
- See Also:
-
definedTerm
Starts a definition term element within a definition list.Supported attributes are the
base attributes
.- Specified by:
definedTerm
in interfaceSink
- Overrides:
definedTerm
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
definedTerm
public void definedTerm()Starts a definition term element within a definition list.- Specified by:
definedTerm
in interfaceSink
- Overrides:
definedTerm
in classSinkAdapter
- See Also:
-
definedTerm_
public void definedTerm_()Ends a definition term element within a definition list.- Specified by:
definedTerm_
in interfaceSink
- Overrides:
definedTerm_
in classSinkAdapter
- See Also:
-
definition
public void definition()Starts a definition element within a definition list.- Specified by:
definition
in interfaceSink
- Overrides:
definition
in classSinkAdapter
- See Also:
-
definition
Starts a definition element within a definition list.Supported attributes are the
base attributes
.- Specified by:
definition
in interfaceSink
- Overrides:
definition
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
definition_
public void definition_()Ends a definition element within a definition list.- Specified by:
definition_
in interfaceSink
- Overrides:
definition_
in classSinkAdapter
- See Also:
-
figure
public void figure()Starts a basic image embedding element.- Specified by:
figure
in interfaceSink
- Overrides:
figure
in classSinkAdapter
- See Also:
-
figure
Starts a basic image embedding element.The canonical sequence of events for the figure element is:
sink.figure(); sink.figureGraphics( "figure.png" ); sink.figureCaption(); sink.text( "Figure caption",); sink.figureCaption_(); sink.figure_();
where the figureCaption element is optional.
However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.
NOTE also that the figureGraphics() event does not have to be embedded inside figure(), in particular for in-line images the figureGraphics() should be used stand-alone (in HTML language, figureGraphics() produces a
<img>
tag, while figure() opens a paragraph- or<div>
- like environment).Supported attributes are the
base attributes
.- Specified by:
figure
in interfaceSink
- Overrides:
figure
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
figure_
public void figure_()Ends a basic image embedding element.- Specified by:
figure_
in interfaceSink
- Overrides:
figure_
in classSinkAdapter
-
figureGraphics
Adding a source of a graphic.- Specified by:
figureGraphics
in interfaceSink
- Overrides:
figureGraphics
in classSinkAdapter
- Parameters:
name
- the source
-
figureGraphics
Adds a graphic element.The
src
parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.Supported attributes are the
base attributes
plus:SRC
,ALT
,WIDTH
,HEIGHT
,ALIGN
,BORDER
,HSPACE
,VSPACE
,ISMAP
,USEMAP
.If the
SRC
attribute is specified in SinkEventAttributes, it will be overridden by thesrc
parameter.- Specified by:
figureGraphics
in interfaceSink
- Overrides:
figureGraphics
in classSinkAdapter
- Parameters:
src
- the image source, a valid URL.attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
figureCaption
public void figureCaption()Starts a caption of an image element.- Specified by:
figureCaption
in interfaceSink
- Overrides:
figureCaption
in classSinkAdapter
- See Also:
-
figureCaption
Starts a figure caption.Supported attributes are the
base attributes
.- Specified by:
figureCaption
in interfaceSink
- Overrides:
figureCaption
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
figureCaption_
public void figureCaption_()Ends a caption of an image.- Specified by:
figureCaption_
in interfaceSink
- Overrides:
figureCaption_
in classSinkAdapter
-
paragraph
public void paragraph()Starts an element which represents a paragraph.- Specified by:
paragraph
in interfaceSink
- Overrides:
paragraph
in classSinkAdapter
- See Also:
-
paragraph
Starts a paragraph.Supported attributes are the
base attributes
plusALIGN
.- Specified by:
paragraph
in interfaceSink
- Overrides:
paragraph
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
paragraph_
public void paragraph_()Ends a paragraph element.- Specified by:
paragraph_
in interfaceSink
- Overrides:
paragraph_
in classSinkAdapter
- See Also:
-
data
Starts a data element which groups together other elements representing microformats.- Specified by:
data
in interfaceSink
- Overrides:
data
in classSinkAdapter
- Parameters:
value
- aString
object.- See Also:
-
data
Starts a data element which groups together other elements representing microformats.Supported attributes are the
base attributes
plusVALUE
.- Specified by:
data
in interfaceSink
- Overrides:
data
in classSinkAdapter
- Parameters:
value
- the machine readable value of the data, may benull
.attributes
- A set ofSinkEventAttributes
, may benull
.
-
data_
public void data_()Ends an data element.- Specified by:
data_
in interfaceSink
- Overrides:
data_
in classSinkAdapter
-
time
Starts a time element which groups together other elements representing a time.- Specified by:
time
in interfaceSink
- Overrides:
time
in classSinkAdapter
- See Also:
-
time
Starts a time element which groups together other elements representing a time.Supported attributes are the
base attributes
plusDATETIME
.- Specified by:
time
in interfaceSink
- Overrides:
time
in classSinkAdapter
- Parameters:
datetime
- the machine readable value of the time, may benull
.attributes
- A set ofSinkEventAttributes
, may benull
.
-
time_
public void time_()Ends a time element.- Specified by:
time_
in interfaceSink
- Overrides:
time_
in classSinkAdapter
-
address
public void address()Starts an address element.- Specified by:
address
in interfaceSink
- Overrides:
address
in classSinkAdapter
- See Also:
-
address
Starts an address element.- Specified by:
address
in interfaceSink
- Overrides:
address
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
address_
public void address_()Ends an address element.- Specified by:
address_
in interfaceSink
- Overrides:
address_
in classSinkAdapter
- See Also:
-
blockquote
public void blockquote()Starts a blockquote element.- Specified by:
blockquote
in interfaceSink
- Overrides:
blockquote
in classSinkAdapter
- See Also:
-
blockquote
Starts a blockquote element.Supported attributes are the
base attributes
.- Specified by:
blockquote
in interfaceSink
- Overrides:
blockquote
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
blockquote_
public void blockquote_()Ends an blockquote element.- Specified by:
blockquote_
in interfaceSink
- Overrides:
blockquote_
in classSinkAdapter
- See Also:
-
division
public void division()Starts a division element grouping together other elements.- Specified by:
division
in interfaceSink
- Overrides:
division
in classSinkAdapter
- See Also:
-
division
Starts a division element grouping together other elements.Supported attributes are the
base attributes
plusALIGN
.- Specified by:
division
in interfaceSink
- Overrides:
division
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
division_
public void division_()Ends a division element.- Specified by:
division_
in interfaceSink
- Overrides:
division_
in classSinkAdapter
- See Also:
-
verbatim
public void verbatim(boolean boxed) The default class style for boxed issource
. Starts an element which indicates that whitespace in the enclosed text has semantic relevance.- Specified by:
verbatim
in interfaceSink
- Overrides:
verbatim
in classSinkAdapter
- Parameters:
boxed
- true to add a box, false otherwise- See Also:
-
verbatim
The default class style for boxed issource
. Starts a verbatim block, ie a block where whitespace has semantic relevance.Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.
Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.
Supported attributes are the
base attributes
plus:DECORATION
(value: "boxed"),ALIGN
,WIDTH
.- Specified by:
verbatim
in interfaceSink
- Overrides:
verbatim
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
verbatim_
public void verbatim_()Ends a verbatim element.- Specified by:
verbatim_
in interfaceSink
- Overrides:
verbatim_
in classSinkAdapter
- See Also:
-
horizontalRule
public void horizontalRule()Adding a separator of sections from a text to each other.- Specified by:
horizontalRule
in interfaceSink
- Overrides:
horizontalRule
in classSinkAdapter
- See Also:
-
horizontalRule
Adds a horizontal separator rule.Supported attributes are the
base attributes
plus:ALIGN
,NOSHADE
,SIZE
,WIDTH
.- Specified by:
horizontalRule
in interfaceSink
- Overrides:
horizontalRule
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
table
public void table()Starts a table element for marking up tabular information in a document.- Specified by:
table
in interfaceSink
- Overrides:
table
in classSinkAdapter
- See Also:
-
table
Starts a table.The canonical sequence of events for the table element is:
sink.table(); sink.tableRows( justify, true ); sink.tableRow(); sink.tableCell(); sink.text( "cell 1,1" ); sink.tableCell_(); sink.tableCell(); sink.text( "cell 1,2" ); sink.tableCell_(); sink.tableRow_(); sink.tableRows_(); sink.tableCaption(); sink.text( "Table caption" ); sink.tableCaption_(); sink.table_();
where the tableCaption element is optional.
However, NOTE that the order of tableCaption and
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
.- Specified by:
table
in interfaceSink
- Overrides:
table
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
table_
public void table_()Ends a table element.- Specified by:
table_
in interfaceSink
- Overrides:
table_
in classSinkAdapter
- See Also:
-
tableRows
public void tableRows(int[] justification, boolean grid) The default class style isbodyTable
. The default align iscenter
. Starts an element that contains rows of table data.- Specified by:
tableRows
in interfaceSink
- Overrides:
tableRows
in classSinkAdapter
- Parameters:
justification
- the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells.grid
- true to provide a grid, false otherwise.- See Also:
-
tableRows_
public void tableRows_()Ends an element that contains rows of table data.- Specified by:
tableRows_
in interfaceSink
- Overrides:
tableRows_
in classSinkAdapter
-
tableRow
public void tableRow()The default class style isa
orb
depending the row id. Starts a row element which acts as a container for a row of table cells.- Specified by:
tableRow
in interfaceSink
- Overrides:
tableRow
in classSinkAdapter
- See Also:
-
tableRow
The default class style isa
orb
depending the row id. Starts a table row.Supported attributes are the
base attributes
plus:ALIGN
,BGCOLOR
,VALIGN
.- Specified by:
tableRow
in interfaceSink
- Overrides:
tableRow
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
tableRow_
public void tableRow_()Ends a row element.- Specified by:
tableRow_
in interfaceSink
- Overrides:
tableRow_
in classSinkAdapter
- See Also:
-
tableCell
public void tableCell()Starts a cell element which defines a cell that contains data.- Specified by:
tableCell
in interfaceSink
- Overrides:
tableCell
in classSinkAdapter
- See Also:
-
tableHeaderCell
public void tableHeaderCell()Starts a cell element which defines a cell that contains header information.- Specified by:
tableHeaderCell
in interfaceSink
- Overrides:
tableHeaderCell
in classSinkAdapter
- See Also:
-
tableCell
Starts a cell element which defines a cell that contains data.- Specified by:
tableCell
in interfaceSink
- Overrides:
tableCell
in classSinkAdapter
- Parameters:
width
- the size of the cell.
-
tableHeaderCell
Starts a cell element which defines a cell that contains header information.- Specified by:
tableHeaderCell
in interfaceSink
- Overrides:
tableHeaderCell
in classSinkAdapter
- Parameters:
width
- the size of the header cell.
-
tableCell
Starts a table cell.Supported attributes are the
base attributes
plus:ABBRV
,ALIGN
,AXIS
,BGCOLOR
,COLSPAN
,HEADERS
,HEIGHT
,NOWRAP
,ROWSPAN
,SCOPE
,VALIGN
,WIDTH
.- Specified by:
tableCell
in interfaceSink
- Overrides:
tableCell
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
tableHeaderCell
Starts a table header cell.Supported attributes are the same as for
tableCell
.- Specified by:
tableHeaderCell
in interfaceSink
- Overrides:
tableHeaderCell
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
tableCell
- Parameters:
headerRow
- true if it is an header rowattributes
- the cell attributes- See Also:
-
tableCell_
public void tableCell_()Ends a cell element.- Specified by:
tableCell_
in interfaceSink
- Overrides:
tableCell_
in classSinkAdapter
-
tableHeaderCell_
public void tableHeaderCell_()Ends a cell header element.- Specified by:
tableHeaderCell_
in interfaceSink
- Overrides:
tableHeaderCell_
in classSinkAdapter
-
tableCell_
private void tableCell_(boolean headerRow) Ends a table cell.- Parameters:
headerRow
- true if it is an header row- See Also:
-
tableCaption
public void tableCaption()Starts a caption element of a table.- Specified by:
tableCaption
in interfaceSink
- Overrides:
tableCaption
in classSinkAdapter
- See Also:
-
tableCaption
Starts a table caption.Note that the order of tableCaption and
Sink.tableRows(int[],boolean)
events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.Supported attributes are the
base attributes
plusALIGN
.- Specified by:
tableCaption
in interfaceSink
- Overrides:
tableCaption
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
tableCaption_
public void tableCaption_()Ends a caption element of a table.- Specified by:
tableCaption_
in interfaceSink
- Overrides:
tableCaption_
in classSinkAdapter
- See Also:
-
anchor
Starts an element which defines an anchor.- Specified by:
anchor
in interfaceSink
- Overrides:
anchor
in classSinkAdapter
- Parameters:
name
- the name of the anchor.- See Also:
-
anchor
Starts an element which defines an anchor.The
name
parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").
Supported attributes are the
base attributes
. IfNAME
is specified in the SinkEventAttributes, it will be overwritten by thename
parameter.- Specified by:
anchor
in interfaceSink
- Overrides:
anchor
in classSinkAdapter
- Parameters:
name
- the name of the anchor. This has to be a valid SGML NAME token.attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
anchor_
public void anchor_()Ends an anchor element.- Specified by:
anchor_
in interfaceSink
- Overrides:
anchor_
in classSinkAdapter
- See Also:
-
link
Starts an element which defines a link.- Specified by:
link
in interfaceSink
- Overrides:
link
in classSinkAdapter
- Parameters:
name
- the name of the link.- See Also:
-
link
Starts a link.The
name
parameter has to be a valid htmlhref
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 thename
parameter.- Specified by:
link
in interfaceSink
- Overrides:
link
in classSinkAdapter
- Parameters:
name
- the name of the link.attributes
- A set ofSinkEventAttributes
, may benull
.
-
link
Adds a link with an optional target. The default style class for external link isexternalLink
.- Parameters:
href
- the link href.target
- the link target, may be null.attributes
- an AttributeSet, may be null. This is supposed to be filtered already.- See Also:
-
link_
public void link_()Ends a link element.- Specified by:
link_
in interfaceSink
- Overrides:
link_
in classSinkAdapter
- See Also:
-
inline
public void inline()Starts an inline element.- Specified by:
inline
in interfaceSink
- Overrides:
inline
in classSinkAdapter
- See Also:
-
inlineSemantics
private void inlineSemantics(SinkEventAttributes attributes, String semantic, List<HTML.Tag> tags, HTML.Tag tag) -
inline
Starts an inline element.The inline method is similar to
Sink.text(String,SinkEventAttributes)
, but allows you to wrap arbitrary elements in addition to text.Supported attributes are the
base attributes
plusSEMANTICS
(values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").- Specified by:
inline
in interfaceSink
- Overrides:
inline
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
inline_
public void inline_()Ends an inline element.- Specified by:
inline_
in interfaceSink
- Overrides:
inline_
in classSinkAdapter
-
italic
public void italic()Starts an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
italic
in interfaceSink
- Overrides:
italic
in classSinkAdapter
- See Also:
-
italic_
public void italic_()Ends an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
italic_
in interfaceSink
- Overrides:
italic_
in classSinkAdapter
- See Also:
-
bold
public void bold()Starts a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
bold
in interfaceSink
- Overrides:
bold
in classSinkAdapter
- See Also:
-
bold_
public void bold_()Ends a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
bold_
in interfaceSink
- Overrides:
bold_
in classSinkAdapter
- See Also:
-
monospaced
public void monospaced()Starts a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
monospaced
in interfaceSink
- Overrides:
monospaced
in classSinkAdapter
- See Also:
-
monospaced_
public void monospaced_()Ends a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
monospaced_
in interfaceSink
- Overrides:
monospaced_
in classSinkAdapter
- See Also:
-
lineBreak
public void lineBreak()Adds a line break.- Specified by:
lineBreak
in interfaceSink
- Overrides:
lineBreak
in classSinkAdapter
- See Also:
-
lineBreak
- Specified by:
lineBreak
in interfaceSink
- Overrides:
lineBreak
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
lineBreakOpportunity
public void lineBreakOpportunity()Adds a line break opportunity.- Specified by:
lineBreakOpportunity
in interfaceSink
- Overrides:
lineBreakOpportunity
in classSinkAdapter
- See Also:
-
lineBreakOpportunity
- Specified by:
lineBreakOpportunity
in interfaceSink
- Overrides:
lineBreakOpportunity
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
pageBreak
public void pageBreak()Adding a new page separator.- Specified by:
pageBreak
in interfaceSink
- Overrides:
pageBreak
in classSinkAdapter
-
nonBreakingSpace
public void nonBreakingSpace()Adding a non breaking space, ie a space without any special formatting operations.- Specified by:
nonBreakingSpace
in interfaceSink
- Overrides:
nonBreakingSpace
in classSinkAdapter
-
text
Adding a text.- Specified by:
text
in interfaceSink
- Overrides:
text
in classSinkAdapter
- Parameters:
text
- The text to write.- See Also:
-
text
Adds a text.The
text
parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.If
text
contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.Supported attributes are the
base attributes
plusSEMANTICS
(values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").The following attributes are deprecated:
VALIGN
(values "sub", "sup"),DECORATION
(values "underline", "overline", "line-through"),STYLE
(values "italic", "bold", "monospaced").- Specified by:
text
in interfaceSink
- Overrides:
text
in classSinkAdapter
- Parameters:
text
- The text to write.attributes
- A set ofSinkEventAttributes
, may benull
.
-
rawText
Adding a raw text, ie a text without any special formatting operations.- Specified by:
rawText
in interfaceSink
- Overrides:
rawText
in classSinkAdapter
- Parameters:
text
- The text to write.
-
comment
Add a comment.- Specified by:
comment
in interfaceSink
- Overrides:
comment
in classSinkAdapter
- Parameters:
comment
- The comment to write.
-
unknown
Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. Add an unknown event. This can be used to generate html tags for which no corresponding sink event exists.If
HtmlTools.getHtmlTag( name )
does not return null, the corresponding tag will be written.For example, the div block
<div class="detail" style="display:inline">text</div>
can be generated via the following event sequence:
SinkEventAttributeSet atts = new SinkEventAttributeSet(); atts.addAttribute( SinkEventAttributes.CLASS, "detail" ); atts.addAttribute( SinkEventAttributes.STYLE, "display:inline" ); sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_START )}, atts ); sink.text( "text" ); sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );
- Specified by:
unknown
in interfaceSink
- Overrides:
unknown
in classSinkAdapter
- Parameters:
name
- the name of the event. If this is not a valid xhtml tag name as defined inHtmlMarkup
then the event is ignored.requiredParams
- If this is null or the first argument is not an Integer then the event is ignored. The first argument should indicate the type of the unknown event, its integer value should be one ofTAG_TYPE_START
,TAG_TYPE_END
,TAG_TYPE_SIMPLE
,ENTITY_TYPE
, orCDATA_TYPE
, otherwise the event will be ignored.attributes
- a set of attributes for the event. May be null. The attributes will always be written, no validity check is performed.
-
escapeAttributeValues
-
flush
public void flush()Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.- Specified by:
flush
in interfaceSink
- Overrides:
flush
in classSinkAdapter
-
close
public void close()Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.- Specified by:
close
in interfaceSink
- Overrides:
close
in classSinkAdapter
-
content
Write HTML escaped text to output.- Parameters:
text
- The text to write.
-
verbatimContent
Write HTML escaped text to output.- Parameters:
text
- The text to write.
-
escapeHTML
Forward to HtmlTools.escapeHTML( text ).- Parameters:
text
- the String to escape, may be null- Returns:
- the text escaped, "" if null String input
- See Also:
-
encodeURL
Forward to HtmlTools.encodeURL( text ).- Parameters:
text
- the String to encode, may be null.- Returns:
- the text encoded, null if null String input.
- See Also:
-
write
Write a text to the sink.- Specified by:
write
in classAbstractXmlSink
- Parameters:
text
- the given text to write
-
writeStartTag
Starts a Tag with attributes. For instance:<tag attName="attValue">
- Overrides:
writeStartTag
in classAbstractXmlSink
- Parameters:
t
- a non null tag.att
- a set of attributes. May be null.isSimpleTag
- boolean to write as a simple tag.
-
writeEndTag
Ends a Tag without writing an EOL. For instance:</tag>
.- Overrides:
writeEndTag
in classAbstractXmlSink
- Parameters:
t
- a tag.
-
logMessage
If debug mode is enabled, log themsg
as is, otherwise add unique msg inwarnMessages
.- Parameters:
key
- not nullmsg
- not null- Since:
- 1.1.1
- See Also:
-
init()
instead of.