public class RtfSink extends AbstractTextSink
Modifier and Type | Field and Description |
---|---|
static double |
DEFAULT_BOTTOM_MARGIN
Paper bottom margin, 2 cm
|
static int |
DEFAULT_CHAR_SET
Constant
DEFAULT_CHAR_SET=0 |
static int |
DEFAULT_CODE_PAGE
Codepage, 1252
|
static String |
DEFAULT_DATA_FORMAT
Data format, ascii
|
static int |
DEFAULT_FONT_SIZE
Font size, 10 pts
|
static String |
DEFAULT_IMAGE_FORMAT
Image format, bmp
|
static String |
DEFAULT_IMAGE_TYPE
Image type, palette
|
static double |
DEFAULT_LEFT_MARGIN
Paper left margin, 2 cm
|
static double |
DEFAULT_PAPER_HEIGHT
Paper height, 29.7 cm
|
static double |
DEFAULT_PAPER_WIDTH
Paper width, 21 cm
|
static int |
DEFAULT_RESOLUTION
Resolution, 72 dpi
|
static double |
DEFAULT_RIGHT_MARGIN
Paper right margin, 2 cm
|
static int |
DEFAULT_SPACING
Spacing, 10 pts
|
static double |
DEFAULT_TOP_MARGIN
Paper top margin, 2 cm
|
protected int |
fontSize |
static String |
IMG_DATA_ASCII
Constant
IMG_DATA_ASCII="ascii" |
static String |
IMG_DATA_RAW
Constant
IMG_DATA_RAW="raw" |
static String |
IMG_FORMAT_BMP
Constant
IMG_FORMAT_BMP="bmp" |
static String |
IMG_FORMAT_WMF
Constant
IMG_FORMAT_WMF="wmf" |
static String |
IMG_TYPE_PALETTE
Constant
IMG_TYPE_PALETTE="palette" |
static String |
IMG_TYPE_RGB
Constant
IMG_TYPE_RGB="rgb" |
protected org.apache.maven.doxia.module.rtf.RtfSink.Indentation |
indentation |
protected org.apache.maven.doxia.module.rtf.RtfSink.Space |
space |
protected OutputStream |
stream |
static int |
STYLE_BOLD
Constant
STYLE_BOLD=2 |
static int |
STYLE_ITALIC
Constant
STYLE_ITALIC=1 |
static int |
STYLE_ROMAN
Constant
STYLE_ROMAN=0 |
static int |
STYLE_TYPEWRITER
Constant
STYLE_TYPEWRITER=3 |
protected PrintWriter |
writer |
PIPE
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
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
Modifier | Constructor and Description |
---|---|
protected |
RtfSink()
Constructor for RtfSink.
|
protected |
RtfSink(OutputStream output)
Constructor for RtfSink.
|
protected |
RtfSink(OutputStream output,
String encoding)
Constructor for RtfSink.
|
Modifier and Type | Method and Description |
---|---|
void |
anchor_()
Ends an anchor element.
|
void |
anchor(String name)
Starts an element which defines an anchor.
|
void |
author_()
Ends an author element.
|
void |
author()
Starts an author element.
|
void |
body_()
Ends the body element.
|
void |
body()
Starts the body of a document.
|
void |
bold_()
Ends a bold element.
|
void |
bold()
Starts a bold element.
|
void |
close()
Close the writer or the stream, if needed.
|
void |
date_()
Ends the date element.
|
void |
date()
Starts the date element.
|
void |
definedTerm_()
Starts a definition term element within a definition list.
|
void |
definedTerm()
Starts a definition term element within a definition list.
|
void |
definition_()
Ends a definition element within a definition list.
|
void |
definition()
Starts a definition element within a definition list.
|
void |
definitionList_()
Ends a definition list element.
|
void |
definitionList()
Starts a definition list element.
|
void |
definitionListItem_()
Ends a list item element within a definition list.
|
void |
definitionListItem()
Starts a list item element within a definition list.
|
void |
figure_()
Ends a basic image embedding element.
|
void |
figure()
Starts a basic image embedding element.
|
void |
figureCaption_()
Ends a caption of an image.
|
void |
figureCaption()
Starts 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.
|
protected org.apache.maven.doxia.module.rtf.Font |
getFont(int style,
int size)
getFont.
|
void |
head_()
Ends the head element.
|
void |
head()
Starts the head element.
|
void |
horizontalRule()
Adding a separator of sections from a text to each other.
|
protected void |
init()
This is called in
Sink.head() or in Sink.close() , and can be used
to set the sink into a clear state so it can be re-used. |
void |
italic_()
Ends an italic element.
|
void |
italic()
Starts an italic element.
|
void |
lineBreak()
Adds a line break.
|
void |
link_()
Ends a link element.
|
void |
link(String name)
Starts an element which defines a link.
|
void |
list_()
Ends an unordered list element.
|
void |
list()
Starts an unordered list element.
|
void |
listItem_()
Ends a list item element within an unordered list.
|
void |
listItem()
Starts a list item element within an unordered list.
|
void |
monospaced_()
Ends a monospaced element.
|
void |
monospaced()
Starts a monospaced element.
|
void |
nonBreakingSpace()
Adding a non breaking space, ie a space without any special formatting operations.
|
void |
numberedList_()
Ends an ordered list element.
|
void |
numberedList(int numbering)
Starts an ordered list element.
|
void |
numberedListItem_()
Ends a list item element within an ordered list.
|
void |
numberedListItem()
Starts a list item element within an ordered list.
|
void |
pageBreak()
Adding a new page separator.
|
void |
paragraph_()
Ends a paragraph element.
|
void |
paragraph()
Starts an element which represents a paragraph.
|
void |
section1_()
Ends a first heading element.
|
void |
section1()
Starts a first heading element which contains the topic of the section.
|
void |
section2_()
Ends a second heading element.
|
void |
section2()
Starts a second heading element which contains the topic of the section.
|
void |
section3_()
Ends a third heading element.
|
void |
section3()
Starts a third heading element which contains the topic of the section.
|
void |
section4_()
Ends a 4th heading element.
|
void |
section4()
Starts a 4th heading element which contains the topic of the section.
|
void |
section5_()
Ends a 5th heading element.
|
void |
section5()
Starts a 5th heading element which contains the topic of the section.
|
void |
sectionTitle_()
Ends a title heading element.
|
void |
sectionTitle()
Starts a title heading element.
|
void |
setBottomMargin(double margin)
Setter for the field
bottomMargin . |
void |
setCharSet(int cs)
Setter for the field
charSet . |
void |
setCodePage(int cp)
Setter for the field
codePage . |
void |
setFontSize(int size)
Setter for the field
fontSize . |
void |
setImageCompression(boolean compression)
Setter for the field
imageCompression . |
void |
setImageDataFormat(String format)
Setter for the field
imageDataFormat . |
void |
setImageFormat(String format)
Setter for the field
imageFormat . |
void |
setImageType(String type)
Setter for the field
imageType . |
void |
setLeftMargin(double margin)
Setter for the field
leftMargin . |
void |
setPaperSize(double width,
double height)
setPaperSize.
|
void |
setResolution(int resolution)
Setter for the field
resolution . |
void |
setRightMargin(double margin)
Setter for the field
rightMargin . |
void |
setSpacing(int spacing)
setSpacing.
|
void |
setTopMargin(double margin)
Setter for the field
topMargin . |
void |
table_()
Ends a table element.
|
void |
table()
Starts a table element for marking up tabular information in a document.
|
void |
tableCaption_()
Ends a caption element of a table.
|
void |
tableCaption()
Starts a caption element of a table.
|
void |
tableCell_()
Ends a cell element.
|
void |
tableCell()
Starts a cell element which defines a cell that contains data.
|
void |
tableHeaderCell_()
Ends a cell header element.
|
void |
tableHeaderCell()
Starts a cell element which defines a cell that contains header information.
|
void |
tableRow_()
Ends a row element.
|
void |
tableRow()
Starts a row element which acts as a container for a row of table cells.
|
void |
tableRows_()
Ends an element that contains rows of table data.
|
void |
tableRows(int[] justification,
boolean grid)
Starts an element that contains rows of table data.
|
void |
text(String text)
Adding a text.
|
void |
title_()
Ends the title element.
|
void |
title()
Starts the title element.
|
protected int |
toTwips(double length,
int unit)
toTwips.
|
void |
unknown(String name,
Object[] requiredParams,
SinkEventAttributes attributes)
Add an unknown event.
|
void |
verbatim_()
Ends a verbatim element.
|
void |
verbatim(boolean boxed)
Starts an element which indicates that whitespace in the enclosed text has semantic relevance.
|
anchor, author, body, comment, date, definedTerm, definition, definitionList, definitionListItem, figure, figureCaption, figureGraphics, head, horizontalRule, lineBreak, link, list, listItem, numberedList, numberedListItem, paragraph, rawText, section_, section, section6_, section6, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, sectionTitle6_, sectionTitle6, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, verbatim
enableLogging, getLog, unifyEOLs
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
DEFAULT_CHAR_SET=0
public static final String IMG_FORMAT_BMP
IMG_FORMAT_BMP="bmp"
public static final String IMG_FORMAT_WMF
IMG_FORMAT_WMF="wmf"
public static final String IMG_TYPE_PALETTE
IMG_TYPE_PALETTE="palette"
public static final String IMG_TYPE_RGB
IMG_TYPE_RGB="rgb"
public static final String IMG_DATA_ASCII
IMG_DATA_ASCII="ascii"
public static final String IMG_DATA_RAW
IMG_DATA_RAW="raw"
public static final int STYLE_ROMAN
STYLE_ROMAN=0
public static final int STYLE_ITALIC
STYLE_ITALIC=1
public static final int STYLE_BOLD
STYLE_BOLD=2
public static final int STYLE_TYPEWRITER
STYLE_TYPEWRITER=3
protected int fontSize
protected org.apache.maven.doxia.module.rtf.RtfSink.Indentation indentation
protected org.apache.maven.doxia.module.rtf.RtfSink.Space space
protected PrintWriter writer
protected OutputStream stream
protected RtfSink() throws IOException
Constructor for RtfSink.
IOException
- if anyprotected RtfSink(OutputStream output) throws IOException
Constructor for RtfSink.
output
- not nullIOException
- if anyprotected RtfSink(OutputStream output, String encoding) throws IOException
Constructor for RtfSink.
output
- not nullencoding
- a valid charsetIOException
- if anypublic void setPaperSize(double width, double height)
width
- in cm.height
- in cm.public void setTopMargin(double margin)
Setter for the field topMargin
.
margin
- margin.public void setBottomMargin(double margin)
Setter for the field bottomMargin
.
margin
- margin.public void setLeftMargin(double margin)
Setter for the field leftMargin
.
margin
- marginpublic void setRightMargin(double margin)
Setter for the field rightMargin
.
margin
- marginpublic void setFontSize(int size)
Setter for the field fontSize
.
size
- in ptspublic void setSpacing(int spacing)
setSpacing.
spacing
- in pts.public void setResolution(int resolution)
Setter for the field resolution
.
resolution
- in dpipublic void setImageFormat(String format)
Setter for the field imageFormat
.
format
- public void setImageType(String type)
Setter for the field imageType
.
type
- public void setImageDataFormat(String format)
Setter for the field imageDataFormat
.
format
- public void setImageCompression(boolean compression)
Setter for the field imageCompression
.
compression
- public void setCodePage(int cp)
Setter for the field codePage
.
cp
- public void setCharSet(int cs)
Setter for the field charSet
.
cs
- public void head()
head
in interface Sink
head
in class SinkAdapter
Sink.head(SinkEventAttributes)
public void head_()
head_
in interface Sink
head_
in class SinkAdapter
protected int toTwips(double length, int unit)
toTwips.
length
- a double.unit
- a int.public void title()
title
in interface Sink
title
in class SinkAdapter
Sink.title(SinkEventAttributes)
public void title_()
title_
in interface Sink
title_
in class SinkAdapter
public void author()
author
in interface Sink
author
in class SinkAdapter
Sink.author(SinkEventAttributes)
public void author_()
author_
in interface Sink
author_
in class SinkAdapter
public void date()
date
in interface Sink
date
in class SinkAdapter
Sink.date(SinkEventAttributes)
public void date_()
date_
in interface Sink
date_
in class SinkAdapter
public void body()
body
in interface Sink
body
in class SinkAdapter
Sink.body(SinkEventAttributes)
public void body_()
body_
in interface Sink
body_
in class SinkAdapter
public void section1()
section1
in interface Sink
section1
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section1_()
section1_
in interface Sink
section1_
in class SinkAdapter
public void section2()
Sink.section1()
element.section2
in interface Sink
section2
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section2_()
section2_
in interface Sink
section2_
in class SinkAdapter
public void section3()
Sink.section2()
element.section3
in interface Sink
section3
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section3_()
section3_
in interface Sink
section3_
in class SinkAdapter
public void section4()
Sink.section3()
element.section4
in interface Sink
section4
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section4_()
section4_
in interface Sink
section4_
in class SinkAdapter
public void section5()
Sink.section4()
element.section5
in interface Sink
section5
in class SinkAdapter
Sink.section(int,SinkEventAttributes)
public void section5_()
section5_
in interface Sink
section5_
in class SinkAdapter
public void sectionTitle()
sectionTitle
in interface Sink
sectionTitle
in class SinkAdapter
public void sectionTitle_()
sectionTitle_
in interface Sink
sectionTitle_
in class SinkAdapter
public void list()
list
in interface Sink
list
in class SinkAdapter
Sink.list(SinkEventAttributes)
public void list_()
list_
in interface Sink
list_
in class SinkAdapter
public void listItem()
listItem
in interface Sink
listItem
in class SinkAdapter
Sink.listItem(SinkEventAttributes)
public void listItem_()
listItem_
in interface Sink
listItem_
in class SinkAdapter
public void numberedList(int numbering)
numberedList
in interface Sink
numberedList
in class SinkAdapter
numbering
- the numbering style.Sink.numberedList(int,SinkEventAttributes)
public void numberedList_()
numberedList_
in interface Sink
numberedList_
in class SinkAdapter
public void numberedListItem()
numberedListItem
in interface Sink
numberedListItem
in class SinkAdapter
Sink.numberedListItem(SinkEventAttributes)
public void numberedListItem_()
numberedListItem_
in interface Sink
numberedListItem_
in class SinkAdapter
public void definitionList()
definitionList
in interface Sink
definitionList
in class SinkAdapter
Sink.definitionList(SinkEventAttributes)
public void definitionList_()
definitionList_
in interface Sink
definitionList_
in class SinkAdapter
public void definitionListItem()
definitionListItem
in interface Sink
definitionListItem
in class SinkAdapter
Sink.definitionListItem(SinkEventAttributes)
public void definitionListItem_()
definitionListItem_
in interface Sink
definitionListItem_
in class SinkAdapter
public void definedTerm()
definedTerm
in interface Sink
definedTerm
in class SinkAdapter
Sink.definedTerm(SinkEventAttributes)
public void definedTerm_()
definedTerm_
in interface Sink
definedTerm_
in class SinkAdapter
public void definition()
definition
in interface Sink
definition
in class SinkAdapter
Sink.definition(SinkEventAttributes)
public void definition_()
definition_
in interface Sink
definition_
in class SinkAdapter
public void table()
table
in interface Sink
table
in class SinkAdapter
Sink.table(SinkEventAttributes)
public void table_()
table_
in interface Sink
table_
in class SinkAdapter
public void tableRows(int[] justification, boolean grid)
tableRows
in interface Sink
tableRows
in class SinkAdapter
justification
- the default justification of columns.
This can be overridden by individual table rows or table cells.
If null a left alignment is assumed by default. If this array
has less elements than there are columns in the table then the value of
the last array element will be taken as default for the remaining table cells.grid
- true to provide a grid, false otherwise.Sink.table(SinkEventAttributes)
,
Sink.JUSTIFY_CENTER
,
Sink.JUSTIFY_LEFT
,
Sink.JUSTIFY_RIGHT
public void tableRows_()
tableRows_
in interface Sink
tableRows_
in class SinkAdapter
public void tableRow()
tableRow
in interface Sink
tableRow
in class SinkAdapter
Sink.tableRow(SinkEventAttributes)
public void tableRow_()
tableRow_
in interface Sink
tableRow_
in class SinkAdapter
public void tableHeaderCell()
tableHeaderCell
in interface Sink
tableHeaderCell
in class SinkAdapter
Sink.tableHeaderCell(SinkEventAttributes)
public void tableHeaderCell_()
tableHeaderCell_
in interface Sink
tableHeaderCell_
in class SinkAdapter
public void tableCell()
tableCell
in interface Sink
tableCell
in class SinkAdapter
Sink.tableCell(SinkEventAttributes)
public void tableCell_()
tableCell_
in interface Sink
tableCell_
in class SinkAdapter
public void tableCaption()
tableCaption
in interface Sink
tableCaption
in class SinkAdapter
Sink.tableCaption(SinkEventAttributes)
public void tableCaption_()
tableCaption_
in interface Sink
tableCaption_
in class SinkAdapter
public void paragraph()
paragraph
in interface Sink
paragraph
in class SinkAdapter
Sink.paragraph(SinkEventAttributes)
public void paragraph_()
paragraph_
in interface Sink
paragraph_
in class SinkAdapter
public void verbatim(boolean boxed)
verbatim
in interface Sink
verbatim
in class SinkAdapter
boxed
- true to add a box, false otherwisepublic void verbatim_()
verbatim_
in interface Sink
verbatim_
in class SinkAdapter
public void figure()
figure
in interface Sink
figure
in class SinkAdapter
Sink.figure(SinkEventAttributes)
public void figure_()
figure_
in interface Sink
figure_
in class SinkAdapter
public void figureGraphics(String name)
figureGraphics
in interface Sink
figureGraphics
in class SinkAdapter
name
- the sourcepublic void figureCaption()
figureCaption
in interface Sink
figureCaption
in class SinkAdapter
Sink.figureCaption(SinkEventAttributes)
public void figureCaption_()
figureCaption_
in interface Sink
figureCaption_
in class SinkAdapter
public void horizontalRule()
horizontalRule
in interface Sink
horizontalRule
in class SinkAdapter
Sink.horizontalRule(SinkEventAttributes)
public void pageBreak()
pageBreak
in interface Sink
pageBreak
in class SinkAdapter
public void anchor(String name)
anchor
in interface Sink
anchor
in class SinkAdapter
name
- the name of the anchor.Sink.anchor(String,SinkEventAttributes)
public void anchor_()
anchor_
in interface Sink
anchor_
in class SinkAdapter
public void link(String name)
link
in interface Sink
link
in class SinkAdapter
name
- the name of the link.Sink.link(String,SinkEventAttributes)
public void link_()
link_
in interface Sink
link_
in class SinkAdapter
public void italic()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.italic
in interface Sink
italic
in class SinkAdapter
public void italic_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.italic_
in interface Sink
italic_
in class SinkAdapter
public void bold()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.bold
in interface Sink
bold
in class SinkAdapter
public void bold_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.bold_
in interface Sink
bold_
in class SinkAdapter
public void monospaced()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.monospaced
in interface Sink
monospaced
in class SinkAdapter
public void monospaced_()
Sink.text(String,SinkEventAttributes)
with
STYLE
instead.monospaced_
in interface Sink
monospaced_
in class SinkAdapter
public void lineBreak()
lineBreak
in interface Sink
lineBreak
in class SinkAdapter
Sink.lineBreak(SinkEventAttributes)
public void nonBreakingSpace()
nonBreakingSpace
in interface Sink
nonBreakingSpace
in class SinkAdapter
public void text(String text)
text
in interface Sink
text
in class SinkAdapter
text
- The text to write.Sink.text(String,SinkEventAttributes)
public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
unknown
in interface Sink
unknown
in class SinkAdapter
name
- The name of the event.requiredParams
- An optional array of required parameters to the event.
May be null
.attributes
- A set of SinkEventAttributes
, may be null
.Sink.unknown(String,Object[],SinkEventAttributes)
protected org.apache.maven.doxia.module.rtf.Font getFont(int style, int size)
getFont.
style
- a int.size
- a int.Font
object.public void flush()
flush
in interface Sink
flush
in class SinkAdapter
public void close()
close
in interface Sink
close
in class SinkAdapter
protected void init()
Sink.head()
or in Sink.close()
, and can be used
to set the sink into a clear state so it can be re-used.init
in class AbstractSink
Copyright © 2005–2017 The Apache Software Foundation. All rights reserved.