|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.doxia.sink.SinkAdapter
org.apache.maven.doxia.module.rtf.RtfSink
public class RtfSink
Field Summary | |
---|---|
static double |
DEFAULT_BOTTOM_MARGIN
|
static int |
DEFAULT_CHAR_SET
|
static int |
DEFAULT_CODE_PAGE
|
static String |
DEFAULT_DATA_FORMAT
|
static int |
DEFAULT_FONT_SIZE
|
static String |
DEFAULT_IMAGE_FORMAT
|
static String |
DEFAULT_IMAGE_TYPE
|
static double |
DEFAULT_LEFT_MARGIN
|
static double |
DEFAULT_PAPER_HEIGHT
|
static double |
DEFAULT_PAPER_WIDTH
|
static int |
DEFAULT_RESOLUTION
|
static double |
DEFAULT_RIGHT_MARGIN
|
static int |
DEFAULT_SPACING
|
static double |
DEFAULT_TOP_MARGIN
|
static String |
IMG_DATA_ASCII
|
static String |
IMG_DATA_RAW
|
static String |
IMG_FORMAT_BMP
|
static String |
IMG_FORMAT_WMF
|
static String |
IMG_TYPE_PALETTE
|
static String |
IMG_TYPE_RGB
|
protected OutputStream |
stream
|
static int |
STYLE_BOLD
|
static int |
STYLE_ITALIC
|
static int |
STYLE_ROMAN
|
static int |
STYLE_TYPEWRITER
|
protected PrintWriter |
writer
|
Fields inherited from interface org.apache.maven.doxia.sink.Sink |
---|
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 | |
---|---|
RtfSink()
|
|
RtfSink(OutputStream output)
|
|
RtfSink(OutputStream output,
String encoding)
|
Method Summary | |
---|---|
void |
anchor_()
Ending an anchor element. |
void |
anchor(String name)
Starting an element which defines an anchor. |
void |
author_()
Ending the author element. |
void |
author()
Starting the author element which is used to identify the author of the document. |
void |
body_()
Ending the body element. |
void |
body()
Starting the body of a document which contains the document's content. |
void |
bold_()
Ending a bold element. |
void |
bold()
Starting a bold element. |
void |
close()
Close the writer or the stream, if needed. |
void |
date_()
Ending the date element. |
void |
date()
Starting the date element which is used to identify the date of the document. |
void |
definedTerm_()
Starting a definition term element within a definition list. |
void |
definedTerm()
Starting a definition term element within a definition list. |
void |
definition_()
Ending a definition element within a definition list. |
void |
definition()
Starting a definition element within a definition list. |
void |
definitionList_()
Ending a definition list element. |
void |
definitionList()
Starting a definition list element. |
void |
definitionListItem_()
Ending a list item element within a definition list. |
void |
definitionListItem()
Starting a list item element within a definition list. |
void |
figure_()
Ending a basic image embedding element. |
void |
figure()
Starting a basic image embedding element. |
void |
figureCaption_()
Ending a caption of an image. |
void |
figureCaption()
Starting a caption of an image element. |
void |
figureGraphics(String name)
Adding a source of a graphic. |
void |
flush()
Flush the writer or the stream, if needed. |
void |
head_()
Ending the head element. |
void |
head()
Starting the head element which contains information about the current document, such as its title, that is not considered document content. |
void |
horizontalRule()
Adding a separator of sections from a text to each other. |
void |
italic_()
Ending an italic element. |
void |
italic()
Starting an italic element. |
void |
lineBreak()
Adding a line breaks. |
void |
link_()
Ending a link element. |
void |
link(String name)
Starting an element which defines a link. |
void |
list_()
Ending an unordered list element. |
void |
list()
Starting an unordered list element. |
void |
listItem_()
Ending a list item element within an unordered list. |
void |
listItem()
Starting a list item element within an unordered list. |
void |
monospaced_()
Ending a monospaced element. |
void |
monospaced()
Starting a monospaced element. |
void |
nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations. |
void |
numberedList_()
Ending an ordered list element. |
void |
numberedList(int numbering)
Starting an ordered list element. |
void |
numberedListItem_()
Ending a list item element within an ordered list. |
void |
numberedListItem()
Starting a list item element within an ordered list. |
void |
pageBreak()
Adding a new page separator. |
void |
paragraph_()
Ending a paragraph element. |
void |
paragraph()
Starting an element which represents a paragraph. |
void |
section1_()
Ending a first heading element. |
void |
section1()
Starting a first heading element which contains the topic of the section. |
void |
section2_()
Ending a second heading element. |
void |
section2()
Starting a second heading element which contains the topic of the section. |
void |
section3_()
Ending a third heading element. |
void |
section3()
Starting a third heading element which contains the topic of the section. |
void |
section4_()
Ending a 4th heading element. |
void |
section4()
Starting a 4th heading element which contains the topic of the section. |
void |
section5_()
Ending a 5th heading element. |
void |
section5()
Starting a 5th heading element which contains the topic of the section. |
void |
sectionTitle_()
Ending a title heading element. |
void |
sectionTitle()
Starting a title heading element. |
void |
setBottomMargin(double margin)
|
void |
setCharSet(int cs)
|
void |
setCodePage(int cp)
|
void |
setFontSize(int size)
|
void |
setImageCompression(boolean compression)
|
void |
setImageDataFormat(String format)
|
void |
setImageFormat(String format)
|
void |
setImageType(String type)
|
void |
setLeftMargin(double margin)
|
void |
setPaperSize(double width,
double height)
|
void |
setResolution(int resolution)
|
void |
setRightMargin(double margin)
|
void |
setSpacing(int spacing)
|
void |
setTopMargin(double margin)
|
void |
table_()
Ending a table element. |
void |
table()
Starting a table element for marking up tabular information in a document. |
void |
tableCaption_()
Ending a caption element of a table. |
void |
tableCaption()
Starting a caption element of a table. |
void |
tableCell_()
Ending a cell element. |
void |
tableCell()
Starting a cell element which defines a cell that contains data. |
void |
tableHeaderCell_()
Ending a cell header element. |
void |
tableHeaderCell()
Starting a cell element which defines a cell that contains header information. |
void |
tableRow_()
Ending a row element. |
void |
tableRow()
Starting a row element which acts as a container for a row of table cells. |
void |
tableRows_()
Ending an element contains rows of table data. |
void |
tableRows(int[] justification,
boolean grid)
Starting an element contains rows of table data. |
void |
text(String text)
Adding a text. |
void |
title_()
Ending the title element. |
void |
title()
Starting the title element which is used to identify the document. |
void |
verbatim_()
Ending a verbatim element. |
void |
verbatim(boolean boxed)
Starting an element which indicates that whitespace in the enclosed text has semantic relevance. |
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter |
---|
rawText, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, tableCell, tableHeaderCell |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final double DEFAULT_PAPER_WIDTH
public static final double DEFAULT_PAPER_HEIGHT
public static final double DEFAULT_TOP_MARGIN
public static final double DEFAULT_BOTTOM_MARGIN
public static final double DEFAULT_LEFT_MARGIN
public static final double DEFAULT_RIGHT_MARGIN
public static final int DEFAULT_FONT_SIZE
public static final int DEFAULT_SPACING
public static final int DEFAULT_RESOLUTION
public static final String DEFAULT_IMAGE_FORMAT
public static final String DEFAULT_IMAGE_TYPE
public static final String DEFAULT_DATA_FORMAT
public static final int DEFAULT_CODE_PAGE
public static final int DEFAULT_CHAR_SET
public static final String IMG_FORMAT_BMP
public static final String IMG_FORMAT_WMF
public static final String IMG_TYPE_PALETTE
public static final String IMG_TYPE_RGB
public static final String IMG_DATA_ASCII
public static final String IMG_DATA_RAW
public static final int STYLE_ROMAN
public static final int STYLE_ITALIC
public static final int STYLE_BOLD
public static final int STYLE_TYPEWRITER
protected PrintWriter writer
protected OutputStream stream
Constructor Detail |
---|
public RtfSink() throws IOException
IOException
public RtfSink(OutputStream output) throws IOException
IOException
public RtfSink(OutputStream output, String encoding) throws IOException
IOException
Method Detail |
---|
public void setPaperSize(double width, double height)
public void setTopMargin(double margin)
public void setBottomMargin(double margin)
public void setLeftMargin(double margin)
public void setRightMargin(double margin)
public void setFontSize(int size)
public void setSpacing(int spacing)
public void setResolution(int resolution)
public void setImageFormat(String format)
public void setImageType(String type)
public void setImageDataFormat(String format)
public void setImageCompression(boolean compression)
public void setCodePage(int cp)
public void setCharSet(int cs)
public void head()
SinkAdapter
head
in interface Sink
head
in class SinkAdapter
public void head_()
SinkAdapter
head_
in interface Sink
head_
in class SinkAdapter
public void title()
SinkAdapter
title
in interface Sink
title
in class SinkAdapter
public void title_()
SinkAdapter
title_
in interface Sink
title_
in class SinkAdapter
public void author()
SinkAdapter
author
in interface Sink
author
in class SinkAdapter
public void author_()
SinkAdapter
author_
in interface Sink
author_
in class SinkAdapter
public void date()
SinkAdapter
date
in interface Sink
date
in class SinkAdapter
public void date_()
SinkAdapter
date_
in interface Sink
date_
in class SinkAdapter
public void body()
SinkAdapter
body
in interface Sink
body
in class SinkAdapter
public void body_()
SinkAdapter
body_
in interface Sink
body_
in class SinkAdapter
public void section1()
SinkAdapter
section1
in interface Sink
section1
in class SinkAdapter
public void section1_()
SinkAdapter
section1_
in interface Sink
section1_
in class SinkAdapter
public void section2()
SinkAdapter
section2
in interface Sink
section2
in class SinkAdapter
public void section2_()
SinkAdapter
section2_
in interface Sink
section2_
in class SinkAdapter
public void section3()
SinkAdapter
section3
in interface Sink
section3
in class SinkAdapter
public void section3_()
SinkAdapter
section3_
in interface Sink
section3_
in class SinkAdapter
public void section4()
SinkAdapter
section4
in interface Sink
section4
in class SinkAdapter
public void section4_()
SinkAdapter
section4_
in interface Sink
section4_
in class SinkAdapter
public void section5()
SinkAdapter
section5
in interface Sink
section5
in class SinkAdapter
public void section5_()
SinkAdapter
section5_
in interface Sink
section5_
in class SinkAdapter
public void sectionTitle()
SinkAdapter
sectionTitle
in interface Sink
sectionTitle
in class SinkAdapter
public void sectionTitle_()
SinkAdapter
sectionTitle_
in interface Sink
sectionTitle_
in class SinkAdapter
public void list()
SinkAdapter
list
in interface Sink
list
in class SinkAdapter
public void list_()
SinkAdapter
list_
in interface Sink
list_
in class SinkAdapter
public void listItem()
SinkAdapter
listItem
in interface Sink
listItem
in class SinkAdapter
public void listItem_()
SinkAdapter
listItem_
in interface Sink
listItem_
in class SinkAdapter
public void numberedList(int numbering)
SinkAdapter
numberedList
in interface Sink
numberedList
in class SinkAdapter
numbering
- the numbering wantedSink.NUMBERING_DECIMAL
,
Sink.NUMBERING_LOWER_ALPHA
,
Sink.NUMBERING_LOWER_ROMAN
,
Sink.NUMBERING_UPPER_ALPHA
,
Sink.NUMBERING_UPPER_ROMAN
public void numberedList_()
SinkAdapter
numberedList_
in interface Sink
numberedList_
in class SinkAdapter
public void numberedListItem()
SinkAdapter
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
public void numberedListItem_()
SinkAdapter
numberedListItem_
in interface Sink
numberedListItem_
in class SinkAdapter
public void definitionList()
SinkAdapter
definitionList
in interface Sink
definitionList
in class SinkAdapter
public void definitionList_()
SinkAdapter
definitionList_
in interface Sink
definitionList_
in class SinkAdapter
public void definitionListItem()
SinkAdapter
definitionListItem
in interface Sink
definitionListItem
in class SinkAdapter
public void definitionListItem_()
SinkAdapter
definitionListItem_
in interface Sink
definitionListItem_
in class SinkAdapter
public void definedTerm()
SinkAdapter
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
public void definedTerm_()
SinkAdapter
definedTerm_
in interface Sink
definedTerm_
in class SinkAdapter
public void definition()
SinkAdapter
definition
in interface Sink
definition
in class SinkAdapter
public void definition_()
SinkAdapter
definition_
in interface Sink
definition_
in class SinkAdapter
public void table()
SinkAdapter
table
in interface Sink
table
in class SinkAdapter
public void table_()
SinkAdapter
table_
in interface Sink
table_
in class SinkAdapter
public void tableRows(int[] justification, boolean grid)
SinkAdapter
tableRows
in interface Sink
tableRows
in class SinkAdapter
justification
- the justification wantedgrid
- true to provide a grid, false otherwisepublic void tableRows_()
SinkAdapter
tableRows_
in interface Sink
tableRows_
in class SinkAdapter
public void tableRow()
SinkAdapter
tableRow
in interface Sink
tableRow
in class SinkAdapter
public void tableRow_()
SinkAdapter
tableRow_
in interface Sink
tableRow_
in class SinkAdapter
public void tableHeaderCell()
SinkAdapter
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
public void tableHeaderCell_()
SinkAdapter
tableHeaderCell_
in interface Sink
tableHeaderCell_
in class SinkAdapter
public void tableCell()
SinkAdapter
tableCell
in interface Sink
tableCell
in class SinkAdapter
public void tableCell_()
SinkAdapter
tableCell_
in interface Sink
tableCell_
in class SinkAdapter
public void tableCaption()
SinkAdapter
tableCaption
in interface Sink
tableCaption
in class SinkAdapter
public void tableCaption_()
SinkAdapter
tableCaption_
in interface Sink
tableCaption_
in class SinkAdapter
public void paragraph()
SinkAdapter
paragraph
in interface Sink
paragraph
in class SinkAdapter
public void paragraph_()
SinkAdapter
paragraph_
in interface Sink
paragraph_
in class SinkAdapter
public void verbatim(boolean boxed)
SinkAdapter
verbatim
in interface Sink
verbatim
in class SinkAdapter
boxed
- true to add a box, false otherwisepublic void verbatim_()
SinkAdapter
verbatim_
in interface Sink
verbatim_
in class SinkAdapter
public void figure()
SinkAdapter
figure
in interface Sink
figure
in class SinkAdapter
public void figure_()
SinkAdapter
figure_
in interface Sink
figure_
in class SinkAdapter
public void figureGraphics(String name)
SinkAdapter
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
name
- the sourcepublic void figureCaption()
SinkAdapter
figureCaption
in interface Sink
figureCaption
in class SinkAdapter
public void figureCaption_()
SinkAdapter
figureCaption_
in interface Sink
figureCaption_
in class SinkAdapter
public void horizontalRule()
SinkAdapter
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
public void pageBreak()
SinkAdapter
pageBreak
in interface Sink
pageBreak
in class SinkAdapter
public void anchor(String name)
SinkAdapter
anchor
in interface Sink
anchor
in class SinkAdapter
name
- the name of the anchorpublic void anchor_()
SinkAdapter
anchor_
in interface Sink
anchor_
in class SinkAdapter
public void link(String name)
SinkAdapter
link
in interface Sink
link
in class SinkAdapter
name
- the name of the linkpublic void link_()
SinkAdapter
link_
in interface Sink
link_
in class SinkAdapter
public void italic()
SinkAdapter
italic
in interface Sink
italic
in class SinkAdapter
public void italic_()
SinkAdapter
italic_
in interface Sink
italic_
in class SinkAdapter
public void bold()
SinkAdapter
bold
in interface Sink
bold
in class SinkAdapter
public void bold_()
SinkAdapter
bold_
in interface Sink
bold_
in class SinkAdapter
public void monospaced()
SinkAdapter
monospaced
in interface Sink
monospaced
in class SinkAdapter
public void monospaced_()
SinkAdapter
monospaced_
in interface Sink
monospaced_
in class SinkAdapter
public void lineBreak()
SinkAdapter
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
public void nonBreakingSpace()
SinkAdapter
nonBreakingSpace
in interface Sink
nonBreakingSpace
in class SinkAdapter
public void text(String text)
SinkAdapter
text
in interface Sink
text
in class SinkAdapter
text
- The text to write.public void flush()
SinkAdapter
flush
in interface Sink
flush
in class SinkAdapter
public void close()
SinkAdapter
close
in interface Sink
close
in class SinkAdapter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |