Index (Doxia :: Sink API 1.5 API)

A B C D E F H I J L M N O P R S T U V W

A

ABBRV - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies an abbreviated version of the content in an element.
ALIGN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the alignment of the event element within its parent element.
ALT - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines a short description of the event element.
anchor(String) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an element which defines an anchor.
anchor(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an element which defines an anchor.
anchor_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends an anchor element.
author() - Method in interface org.apache.maven.doxia.sink.Sink: Starts an author element.
author(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an author element.
author_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends an author element.
AXIS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines a name for a cell.

B

BGCOLOR - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the background color of an event element.
body() - Method in interface org.apache.maven.doxia.sink.Sink: Starts the body of a document.
body(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts the body of a document.
body_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends the body element.
bold() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a bold element.
bold_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a bold element.
BORDER - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines a border around an event element.

C

CELLPADDING - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the space between cell walls and contents.
CELLSPACING - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the space between cells.
CHARSET - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the character encoding of text associated with an event element.
CLASS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: The class of the event element.
close() - Method in interface org.apache.maven.doxia.sink.Sink: Close the writer or the stream, if needed.
COLSPAN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Indicates the number of columns a cell should span.
comment(String) - Method in interface org.apache.maven.doxia.sink.Sink: Add a comment.
COORDS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: May be used in conjunction with SinkEventAttributes.SHAPE.
createSink(File, String) - Method in interface org.apache.maven.doxia.sink.SinkFactory: Create a Sink into a file.
createSink(File, String, String) - Method in interface org.apache.maven.doxia.sink.SinkFactory: Create a Sink into a file using a specified encoding.
createSink(OutputStream) - Method in interface org.apache.maven.doxia.sink.SinkFactory: Create a Sink into an OutputStream.
createSink(OutputStream, String) - Method in interface org.apache.maven.doxia.sink.SinkFactory: Create a Sink into an OutputStream using a specified encoding.

D

date() - Method in interface org.apache.maven.doxia.sink.Sink: Starts the date element.
date(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts the date element.
date_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends the date element.
DECORATION - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies a decoration for an element.
definedTerm() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a definition term element within a definition list.
definedTerm(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a definition term element within a definition list.
definedTerm_() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a definition term element within a definition list.
definition() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a definition element within a definition list.
definition(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a definition element within a definition list.
definition_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a definition element within a definition list.
definitionList() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a definition list element.
definitionList(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a definition list.
definitionList_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a definition list element.
definitionListItem() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a list item element within a definition list.
definitionListItem(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a list item element within a definition list.
definitionListItem_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a list item element within a definition list.

E

EMAIL - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: An electronic mail address.

F

figure() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a basic image embedding element.
figure(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a basic image embedding element.
figure_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a basic image embedding element.
figureCaption() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a caption of an image element.
figureCaption(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a figure caption.
figureCaption_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a caption of an image.
figureGraphics(String) - Method in interface org.apache.maven.doxia.sink.Sink: Adding a source of a graphic.
figureGraphics(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Adds a graphic element.
flush() - Method in interface org.apache.maven.doxia.sink.Sink: Flush the writer or the stream, if needed.
FRAME - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies which sides of a border surrounding an element should be visible.

H

head() - Method in interface org.apache.maven.doxia.sink.Sink: Starts the head element.
head(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts the head element.
head_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends the head element.
HEADERS - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: A space-separated list of cell IDs that supply header information for the cell.
HEIGHT - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines the height of an event element.
horizontalRule() - Method in interface org.apache.maven.doxia.sink.Sink: Adding a separator of sections from a text to each other.
horizontalRule(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Adds a horizontal separator rule.
HREF - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: The target URL of an event element, eg a link.
HREFLANG - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the base language of the target URL.
HSPACE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines white space on the left and right side of an event element.

I

ID - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: A unique id for the event element.
ISMAP - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines an image as a server-side image map.
italic() - Method in interface org.apache.maven.doxia.sink.Sink: Starts an italic element.
italic_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends an italic element.

J

JUSTIFY_CENTER - Static variable in interface org.apache.maven.doxia.sink.Sink: Center alignment for table cells.
JUSTIFY_LEFT - Static variable in interface org.apache.maven.doxia.sink.Sink: Left alignment for table cells.
JUSTIFY_RIGHT - Static variable in interface org.apache.maven.doxia.sink.Sink: Right alignment for table cells.

L

LANG - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: The language code for the event element.
lineBreak() - Method in interface org.apache.maven.doxia.sink.Sink: Adds a line break.
lineBreak(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Adds a line break.
link(String) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an element which defines a link.
link(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a link.
link_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a link element.
list() - Method in interface org.apache.maven.doxia.sink.Sink: Starts an unordered list element.
list(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an unordered list.
list_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends an unordered list element.
listItem() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a list item element within an unordered list.
listItem(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a list item element within an unordered list.
listItem_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a list item element within an unordered list.

M

monospaced() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a monospaced element.
monospaced_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a monospaced element.

N

NAME - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the name of an anchor.
nonBreakingSpace() - Method in interface org.apache.maven.doxia.sink.Sink: Adding a non breaking space, ie a space without any special formatting operations.
NOSHADE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Used to indicate that an element comes with a shadow.
NOWRAP - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Whether to disable or enable automatic text wrapping for an element.
numberedList(int) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an ordered list element.
numberedList(int, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an ordered list element.
numberedList_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends an ordered list element.
numberedListItem() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a list item element within an ordered list.
numberedListItem(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a list item element within an ordered list.
numberedListItem_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a list item element within an ordered list.
NUMBERING_DECIMAL - Static variable in interface org.apache.maven.doxia.sink.Sink: A numbering to handle a number list.
NUMBERING_LOWER_ALPHA - Static variable in interface org.apache.maven.doxia.sink.Sink: A numbering to handle a lower alpha list.
NUMBERING_LOWER_ROMAN - Static variable in interface org.apache.maven.doxia.sink.Sink: A numbering to handle a lower roman list.
NUMBERING_UPPER_ALPHA - Static variable in interface org.apache.maven.doxia.sink.Sink: A numbering to handle a upper alpha list.
NUMBERING_UPPER_ROMAN - Static variable in interface org.apache.maven.doxia.sink.Sink: A numbering to handle a upper roman list.

O

org.apache.maven.doxia.sink - package org.apache.maven.doxia.sink: Maven Doxia API.
org.codehaus.doxia.sink - package org.codehaus.doxia.sink

P

pageBreak() - Method in interface org.apache.maven.doxia.sink.Sink: Adding a new page separator.
paragraph() - Method in interface org.apache.maven.doxia.sink.Sink: Starts an element which represents a paragraph.
paragraph(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a paragraph.
paragraph_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a paragraph element.
PROFILE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: A space separated list of URL's that contains meta data information about the document.

R

rawText(String) - Method in interface org.apache.maven.doxia.sink.Sink: Adding a raw text, ie a text without any special formatting operations.
REL - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: For references to external resourcs, specifies the relationship between the current document and the target URL.
REV - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: For references to external resourcs, specifies the relationship between the target URL and the current document.
ROLE - Static variable in interface org.apache.maven.doxia.sink.Sink: The Plexus Sink Role.
ROLE - Static variable in interface org.apache.maven.doxia.sink.SinkFactory: The Plexus SinkFactory Role.
ROWSPAN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Indicates the number of rows a cell should span.
RULES - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies horizontal/vertical divider lines between certain elements, eg table cells.

S

SCOPE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: A general scope parameter.
section(int, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Start a new section at the given level.
section1() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a first heading element which contains the topic of the section.
section1_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a first heading element.
section2() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a second heading element which contains the topic of the section.
section2_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a second heading element.
section3() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a third heading element which contains the topic of the section.
section3_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a third heading element.
section4() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a 4th heading element which contains the topic of the section.
section4_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a 4th heading element.
section5() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a 5th heading element which contains the topic of the section.
section5_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a 5th heading element.
section_(int) - Method in interface org.apache.maven.doxia.sink.Sink: Ends a section at the given level.
SECTION_LEVEL_1 - Static variable in interface org.apache.maven.doxia.sink.Sink: A level 1 section (section).
SECTION_LEVEL_2 - Static variable in interface org.apache.maven.doxia.sink.Sink: A level 2 section (subsection).
SECTION_LEVEL_3 - Static variable in interface org.apache.maven.doxia.sink.Sink: A level 3 section (sub-subsection).
SECTION_LEVEL_4 - Static variable in interface org.apache.maven.doxia.sink.Sink: A level 4 section (sub-sub-subsection).
SECTION_LEVEL_5 - Static variable in interface org.apache.maven.doxia.sink.Sink: A level 5 section (sub-sub-sub-subsection).
sectionTitle() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a title heading element.
sectionTitle(int, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Start a new section title at the given level.
sectionTitle1() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a first title heading element.
sectionTitle1_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a first title heading element.
sectionTitle2() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a second title heading element.
sectionTitle2_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a second title heading element.
sectionTitle3() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a third title heading element.
sectionTitle3_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a third title heading element.
sectionTitle4() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a 4th title heading element.
sectionTitle4_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a 4th title heading element.
sectionTitle5() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a 5th title heading element.
sectionTitle5_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a 5th title heading element.
sectionTitle_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a title heading element.
sectionTitle_(int) - Method in interface org.apache.maven.doxia.sink.Sink: Ends a section title at the given level.
SHAPE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines the type of region to be defined for a mapping.
Sink - Interface in org.apache.maven.doxia.sink: A Sink consumes Doxia events to produce a resultant output format (eg Docbook, PDF, XHTML...).
Sink - Interface in org.codehaus.doxia.sink: Deprecated.
use Sink instead (since 1.0-alpha-6).
SinkEventAttributes - Interface in org.apache.maven.doxia.sink: A set of attributes for a sink event.
SinkFactory - Interface in org.apache.maven.doxia.sink: A factory that creates a Sink object.
SIZE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the size, or thickness, or height of an event element.
SRC - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: The URL of an external resource, eg an image.
STYLE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: An inline style definition.
SUMMARY - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.

T

table() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a table element for marking up tabular information in a document.
table(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a table.
table_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a table element.
tableCaption() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a caption element of a table.
tableCaption(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a table caption.
tableCaption_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a caption element of a table.
tableCell() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a cell element which defines a cell that contains data.
tableCell(String) - Method in interface org.apache.maven.doxia.sink.Sink: Deprecated.
Use #tableCell(SinkEventAttributes) instead.
tableCell(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a table cell.
tableCell_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a cell element.
tableHeaderCell() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a cell element which defines a cell that contains header information.
tableHeaderCell(String) - Method in interface org.apache.maven.doxia.sink.Sink: Deprecated.
Use #tableHeaderCell(SinkEventAttributes) instead.
tableHeaderCell(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a table header cell.
tableHeaderCell_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a cell header element.
tableRow() - Method in interface org.apache.maven.doxia.sink.Sink: Starts a row element which acts as a container for a row of table cells.
tableRow(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a table row.
tableRow_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a row element.
tableRows(int[], boolean) - Method in interface org.apache.maven.doxia.sink.Sink: Starts an element that contains rows of table data.
tableRows_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends an element that contains rows of table data.
TARGET - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Where to open the target URL.
text(String) - Method in interface org.apache.maven.doxia.sink.Sink: Adding a text.
text(String, SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Adds a text.
title() - Method in interface org.apache.maven.doxia.sink.Sink: Starts the title element.
title(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts the title element.
TITLE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: A text to display in a tool tip.
title_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends the title element.
TYPE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.

U

unknown(String, Object[], SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Add an unknown event.
USEMAP - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines an image as a client-side image map.

V

VALIGN - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Specifies the vertical alignment of an element.
verbatim(boolean) - Method in interface org.apache.maven.doxia.sink.Sink: Deprecated.
Use #verbatim(SinkEventAttributes) instead.
verbatim(SinkEventAttributes) - Method in interface org.apache.maven.doxia.sink.Sink: Starts a verbatim block, ie a block where whitespace has semantic relevance.
verbatim_() - Method in interface org.apache.maven.doxia.sink.Sink: Ends a verbatim element.
VSPACE - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Defines white space on the top and bottom of the event element.

W

WIDTH - Static variable in interface org.apache.maven.doxia.sink.SinkEventAttributes: Sets the width of an event element.

A B C D E F H I J L M N O P R S T U V W