RtfText (JRTF 0.7 API)

java.lang.Object
- com.tutego.jrtf.RtfText

```
public class RtfText
extends Object
```
Class for RTF text with different text formattings like bold, italic, ...

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RtfText.FieldModifier
Modifiers for fields.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RtfText.FieldModifier` Modifiers for fields.

Method Summary

Methods
Modifier and Type	Method and Description
`static RtfText`	`bold(Object text)` Bold a given text.
`static RtfText`	`bullet()` Bullet character.
`static RtfText`	`color(int colorindex, Object text)` Colors text.
`static RtfText`	`color(int colorindex, String text)` Colors text.
`static RtfText`	`columnBreak()` Required column break.
`static RtfText`	`currentDate()` Current date.
`static RtfText`	`currentDateAbbreviated()` Current date in abbreviated format.
`static RtfText`	`currentDateLong()` Current date in long format.
`static RtfText`	`currentPageNumber()` Current page number.
`static RtfText`	`currentSectionNumber()` Current section number.
`static RtfText`	`currentTime()` Current time.
`static RtfText`	`dottedUnderline(String text)` Underlines dotted.
`static RtfText`	`doubleQuote(Object text)` Sets a text in double quotation marks.
`static RtfText`	`doubleUnderline(Object text)` Underlines double.
`static RtfText`	`field(RtfPara fieldInstructions, RtfPara recentResult)` Inserts a RTF field.
`static RtfText`	`field(RtfPara fieldInstructions, RtfPara recentResult, RtfText.FieldModifier fieldModifier)` Inserts a RTF field.
`static RtfText`	`font(int fontnum, Object text)` Sets text with a given font style.
`static RtfText`	`fontSize(int fontSize, Object text)` Sets the font size in half-points.
`static RtfText`	`footnote(Object para)` Place a footnote with automatic footnote reference.
`static RtfText`	`footnote(RtfPara... paras)` Place a footnote with automatic footnote reference.
`static RtfText`	`hyperlink(String url, RtfPara text)` Adds an hyperlink (aka anchor).
`static RtfText`	`italic(Object text)` Italic given text.
`static RtfText`	`leftDoubleQuotationMark()` Left double quotation mark.
`static RtfText`	`leftQuotationMark()` Left single quotation mark.
`static RtfText`	`lineBreak()` Required line break (no paragraph break).
`static RtfText`	`longHyphen()` Em-dash (long hyphen).
`static RtfText`	`nonBreakingSpace()` Non-breaking space.
`static RtfText`	`pageBreak()` Required page break.
`static RtfPicture`	`picture(InputStream source)` Place a picture.
`static RtfPicture`	`picture(URL source)` Place a picture.
`static RtfText`	`qoute(Object text)` Sets a text in single quotation marks.
`static RtfText`	`revised(Object text)` Set text for revision.
`static RtfText`	`rightDoubleQuotationMark()` Right double quotation mark.
`static RtfText`	`rightQuotationMark()` Right single quotation mark.
`static RtfText`	`shadow(Object text)` Shadows text.
`static RtfText`	`shortHyphen()` En-dash (short hyphen).
`static RtfText`	`smallCapitals(Object text)` Shows text in small capitals.
`static RtfText`	`softColumnBreak()` Non-required column break.
`static RtfText`	`softLineBreak()` Non-required line break.
`static RtfText`	`softPageBreak()` Non-required page break.
`static RtfText`	`strikethru(Object text)` Strikes through text.
`static RtfText`	`subscript(Object text)` Subscripts text.
`static RtfText`	`superscript(Object text)` Superscripts text.
`static RtfText`	`tab()` Tab character.
`static RtfText`	`text(Object... texts)` Converts every object in the sequence with `toString` to a String object and wraps it into a RtfText if its not already a RtfText object.
`static RtfText`	`text(String text)` Wraps a String in a `RtfText` object.
`static RtfText`	`textJoinWithSpace(boolean joinWithSpace, Object... texts)` Converts every object in the sequence with `toString` to a String object and wraps it into a RtfText if its not already a RtfText object and join every text with a space between if wanted.
`static RtfText`	`underline(Object text)` Underline text.
`static RtfText`	`wordUnderline(Object text)` Underlines word.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - text
```
public static RtfText text(Object... texts)
```
    Converts every object in the sequence with toString to a String object and wraps it into a RtfText if its not already a RtfText object. If the argument is null or no elements are given the result is equal to text(""). If one element of the vararg is null then this element is omitted and no separating space will be written too.
    
    Parameters:
    texts - Sequence of text.
    
    Returns:
    New RtfText object representing this sequence of text.
  - textJoinWithSpace
```
public static RtfText textJoinWithSpace(boolean joinWithSpace,
                        Object... texts)
```
    Converts every object in the sequence with toString to a String object and wraps it into a RtfText if its not already a RtfText object and join every text with a space between if wanted. If the argument is null or no elements are given the result is equal to text(""). If one element of the vararg is null then this element is omitted and no separating space will be written too.
    
    Parameters:
    joinWithSpace - If space character should be set between non null elements.
    texts - Sequence of text.
    
    Returns:
    New RtfText object representing this sequence of text.
  - text
```
public static RtfText text(String text)
```
    Wraps a String in a RtfText object. If the argument is a null value then it will be treated like a "".
    
    Parameters:
    text - String
    
    Returns:
    New RtfText object representing this text.
  - font
```
public static RtfText font(int fontnum,
           Object text)
```
    Sets text with a given font style.
    
    Parameters:
    fontnum - Font number according to the header.
    text - Text to set with a different font.
    
    Returns:
    New RtfText object representing this text.
  - italic
```
public static RtfText italic(Object text)
```
    Italic given text.
    
    Parameters:
    text - Text to make italic.
    
    Returns:
    New RtfText object representing this text.
  - bold
```
public static RtfText bold(Object text)
```
    Bold a given text.
    
    Parameters:
    text - Text to be set bold.
    
    Returns:
    New RtfText object representing this bold text.
  - underline
```
public static RtfText underline(Object text)
```
    Underline text.
    
    Parameters:
    text - Text to underline.
    
    Returns:
    New RtfText object representing this underlined text.
  - dottedUnderline
```
public static RtfText dottedUnderline(String text)
```
    Underlines dotted.
    
    Parameters:
    text - Text to underline dotted.
    
    Returns:
    New RtfText object representing this text.
  - doubleUnderline
```
public static RtfText doubleUnderline(Object text)
```
    Underlines double.
    
    Parameters:
    text - Text to underline double.
    
    Returns:
    New RtfText object representing this text.
  - wordUnderline
```
public static RtfText wordUnderline(Object text)
```
    Underlines word.
    
    Parameters:
    text - Text where words will be underlined.
    
    Returns:
    New RtfText object representing this text.
  - subscript
```
public static RtfText subscript(Object text)
```
    Subscripts text.
    
    Parameters:
    text - Text to subscript.
    
    Returns:
    New RtfText object representing this subscripted text.
  - revised
```
public static RtfText revised(Object text)
```
    Set text for revision.
    
    Parameters:
    text - Text for revision.
    
    Returns:
    New RtfText object representing this resivisioned text.
  - superscript
```
public static RtfText superscript(Object text)
```
    Superscripts text.
    
    Parameters:
    text - Text to superscript.
    
    Returns:
    New RtfText object representing this superscripted text.
  - strikethru
```
public static RtfText strikethru(Object text)
```
    Strikes through text.
    
    Parameters:
    text - Text to strike through.
    
    Returns:
    New RtfText object representing this strikes through text.
  - shadow
```
public static RtfText shadow(Object text)
```
    Shadows text.
    
    Parameters:
    text - Text to shadow.
    
    Returns:
    New RtfText object representing this shadowed text.
  - smallCapitals
```
public static RtfText smallCapitals(Object text)
```
    Shows text in small capitals.
    
    Parameters:
    text - Text to show in small capitals.
    
    Returns:
    New RtfText object representing this text.
  - fontSize
```
public static RtfText fontSize(int fontSize,
               Object text)
```
    Sets the font size in half-points. The default is 24.
    
    Parameters:
    fontSize - Font size.
    text - Text to set in a different font size.
    
    Returns:
    New RtfText object representing this text.
  - color
```
public static RtfText color(int colorindex,
            Object text)
```
    Colors text.
    
    Parameters:
    colorindex - Index of the color set defined in the header.
    text - Text to color.
    
    Returns:
    New RtfText object representing this text.
  - color
```
public static RtfText color(int colorindex,
            String text)
```
    Colors text.
    
    Parameters:
    colorindex - Index of the color set defined in the header.
    text - Text to color.
    
    Returns:
    New RtfText object representing this text.
  - currentDate
```
public static RtfText currentDate()
```
    Current date. Useful in headers.
    
    Returns:
    New RtfText object representing this current date.
  - currentDateLong
```
public static RtfText currentDateLong()
```
    Current date in long format. Useful in headers
    
    Returns:
    New RtfText object representing this current date.
  - currentDateAbbreviated
```
public static RtfText currentDateAbbreviated()
```
    Current date in abbreviated format. Useful in headers.
    
    Returns:
    New RtfText object representing this current date.
  - currentTime
```
public static RtfText currentTime()
```
    Current time. Useful in headers.
    
    Returns:
    New RtfText object representing current time.
  - currentPageNumber
```
public static RtfText currentPageNumber()
```
    Current page number. Useful in headers.
    
    Returns:
    New RtfText object representing page number.
  - currentSectionNumber
```
public static RtfText currentSectionNumber()
```
    Current section number. Useful in headers.
    
    Returns:
    New RtfText object representing the section number.
  - pageBreak
```
public static RtfText pageBreak()
```
    Required page break.
    
    Returns:
    New RtfText object representing a page break.
  - columnBreak
```
public static RtfText columnBreak()
```
    Required column break.
    
    Returns:
    New RtfText object representing a column break.
  - lineBreak
```
public static RtfText lineBreak()
```
    Required line break (no paragraph break).
    
    Returns:
    New RtfText object representing a like break.
  - softPageBreak
```
public static RtfText softPageBreak()
```
    Non-required page break. Emitted as it appears in galley view.
    
    Returns:
    New RtfText object representing a soft page break.
  - softColumnBreak
```
public static RtfText softColumnBreak()
```
    Non-required column break. Emitted as it appears in galley view.
    
    Returns:
    New RtfText object representing a column break.
  - softLineBreak
```
public static RtfText softLineBreak()
```
    Non-required line break. Emitted as it appears in galley view.
    
    Returns:
    New RtfText object representing a soft line break.
  - tab
```
public static RtfText tab()
```
    Tab character. You can also insert a regular "\t" in text. See RtfTextPara.tab(double, RtfUnit) for adjustments.
    
    Returns:
    New RtfText object representing a tab.
  - longHyphen
```
public static RtfText longHyphen()
```
    Em-dash (long hyphen).
    
    Returns:
    New RtfText object representing a hyphen.
  - shortHyphen
```
public static RtfText shortHyphen()
```
    En-dash (short hyphen).
    
    Returns:
    New RtfText object representing a hypen.
  - bullet
```
public static RtfText bullet()
```
    Bullet character.
    
    Returns:
    New RtfText object representing a bullet.
  - leftQuotationMark
```
public static RtfText leftQuotationMark()
```
    Left single quotation mark.
    
    Returns:
    New RtfText object representing this text.
  - rightQuotationMark
```
public static RtfText rightQuotationMark()
```
    Right single quotation mark.
    
    Returns:
    New RtfText object representing this text.
  - qoute
```
public static RtfText qoute(Object text)
```
    Sets a text in single quotation marks.
    
    Parameters:
    text - Text to put in quotes.
    
    Returns:
    New RtfText object representing this text in quotation marks.
  - leftDoubleQuotationMark
```
public static RtfText leftDoubleQuotationMark()
```
    Left double quotation mark.
    
    Returns:
    New RtfText object representing this text.
  - rightDoubleQuotationMark
```
public static RtfText rightDoubleQuotationMark()
```
    Right double quotation mark.
    
    Returns:
    New RtfText object representing this text.
  - doubleQuote
```
public static RtfText doubleQuote(Object text)
```
    Sets a text in double quotation marks.
    
    Parameters:
    text - to put in quotes.
    
    Returns:
    New RtfText object representing this text in quotation marks.
  - nonBreakingSpace
```
public static RtfText nonBreakingSpace()
```
    Non-breaking space.
    
    Returns:
    New RtfText object representing this text.
  - picture
```
public static RtfPicture picture(URL source)
```
    Place a picture.
    
    Parameters:
    source - InputStream of the image.
    
    Returns:
    New RtfPicture object.
  - picture
```
public static RtfPicture picture(InputStream source)
```
    Place a picture.
    
    Parameters:
    source - InputStream of the image.
    
    Returns:
    New RtfPicture object.
  - footnote
```
public static RtfText footnote(RtfPara... paras)
```
    Place a footnote with automatic footnote reference.
    
    Parameters:
    paras - Paragraphs of this footnote.
    
    Returns:
    New RtfText object representing this footnote.
  - footnote
```
public static RtfText footnote(Object para)
```
    Place a footnote with automatic footnote reference.
    
    Parameters:
    para - Paragraph of this footnote.
    
    Returns:
    New RtfText object representing this footnote.
  - field
```
public static RtfText field(RtfPara fieldInstructions,
            RtfPara recentResult,
            RtfText.FieldModifier fieldModifier)
```
    Inserts a RTF field.
    
    Parameters:
    fieldInstructions - Field instructions.
    recentResult - Recent results of this field.
    fieldModifier - Additional field modifier. Can be null.
    
    Returns:
    New RtfText object representing this field.
  - field
```
public static RtfText field(RtfPara fieldInstructions,
            RtfPara recentResult)
```
    Inserts a RTF field.
    
    Parameters:
    fieldInstructions - Field instructions.
    recentResult - Recent results of this field.
    
    Returns:
    New RtfText object representing this field.
  - hyperlink
```
public static RtfText hyperlink(String url,
                RtfPara text)
```
    Adds an hyperlink (aka anchor). This is a special field.
    
    Parameters:
    url - URL of this hyperlink.
    text - Text for this hyperlink.
    
    Returns:
    New RtfText object representing this hyperlink.

Class RtfText

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

text

textJoinWithSpace

text

font

italic

bold

underline

dottedUnderline

doubleUnderline

wordUnderline

subscript

revised

superscript

strikethru

shadow

smallCapitals

fontSize

color

color

currentDate

currentDateLong

currentDateAbbreviated

currentTime

currentPageNumber

currentSectionNumber

pageBreak

columnBreak

lineBreak

softPageBreak

softColumnBreak

softLineBreak

tab

longHyphen

shortHyphen

bullet

leftQuotationMark

rightQuotationMark

qoute

leftDoubleQuotationMark

rightDoubleQuotationMark

doubleQuote

nonBreakingSpace

picture

picture

footnote

footnote

field

field

hyperlink