RtfParagraphStyle (iText-4.2.0 -- we had to fork it! 4.2.0-pds-1 API)

java.lang.Object
- com.lowagie.text.Font
- - com.lowagie.text.rtf.style.RtfFont
  - - com.lowagie.text.rtf.style.RtfParagraphStyle

All Implemented Interfaces:

RtfBasicElement, RtfExtendedElement, RtfElementInterface, Comparable
```
public class RtfParagraphStyle
extends RtfFont
```
The RtfParagraphStyle stores all style/formatting attributes of a RtfParagraph. Additionally it also supports the style name system available in RTF. The RtfParagraphStyle is a Font and can thus be used as such. To use the stylesheet functionality it needs to be set as the font of a Paragraph. Otherwise it will work like a RtfFont. It also supports inheritance of styles.

Version:

$Id: RtfParagraphStyle.java 3580 2008-08-06 15:52:00Z howard_s $

Author:

Mark Hall (Mark.Hall@mail.room3b.eu), Thomas Bickel (tmb99@inode.at)

Field Summary

Fields
Modifier and Type	Field and Description
`static byte[]`	`ALIGN_CENTER` Constant for center alignment
`static byte[]`	`ALIGN_JUSTIFY` Constant for justified alignment
`static byte[]`	`ALIGN_LEFT` Constant for left alignment
`static byte[]`	`ALIGN_RIGHT` Constant for right alignment
`static byte[]`	`FIRST_LINE_INDENT` Constant for the first line indentation
`static byte[]`	`INDENT_LEFT` Constant for left indentation
`static byte[]`	`INDENT_RIGHT` Constant for right indentation
`static byte[]`	`KEEP_TOGETHER` Constant for keeping the paragraph together on one page
`static byte[]`	`KEEP_TOGETHER_WITH_NEXT` Constant for keeping the paragraph together with the next one on one page
`static byte[]`	`SPACING_AFTER` Constant for the space after the paragraph.
`static byte[]`	`SPACING_BEFORE` Constant for the space before the paragraph.
`static RtfParagraphStyle`	`STYLE_HEADING_1` The style for level 1 headings.
`static RtfParagraphStyle`	`STYLE_HEADING_2` The style for level 2 headings.
`static RtfParagraphStyle`	`STYLE_HEADING_3` The style for level 3 headings.
`static RtfParagraphStyle`	`STYLE_NORMAL` The NORMAL/STANDARD style.

Fields inherited from class com.lowagie.text.rtf.style.RtfFont
DEFAULT_FONT, document, FONT_SIZE, STYLE_BOLD, STYLE_DOUBLE_STRIKETHROUGH, STYLE_EMBOSSED, STYLE_ENGRAVED, STYLE_HIDDEN, STYLE_ITALIC, STYLE_NONE, STYLE_OUTLINE, STYLE_SHADOW, STYLE_STRIKETHROUGH, STYLE_UNDERLINE

Fields inherited from class com.lowagie.text.Font
BOLD, BOLDITALIC, COURIER, DEFAULTSIZE, HELVETICA, ITALIC, NORMAL, STRIKETHRU, SYMBOL, TIMES_ROMAN, UNDEFINED, UNDERLINE, ZAPFDINGBATS

Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR

Constructor Summary

Constructors
Constructor and Description
`RtfParagraphStyle(RtfDocument doc, RtfParagraphStyle style)` Constructs a RtfParagraphStyle from another RtfParagraphStyle.
`RtfParagraphStyle(String styleName, String basedOnName)` Constructs a new RtfParagraphStyle that is based on an existing RtfParagraphStyle.
`RtfParagraphStyle(String styleName, String fontName, int fontSize, int fontStyle, Color fontColor)` Constructs a new RtfParagraphStyle with the given attributes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Tests whether two RtfParagraphStyles are equal.
`int`	`getAlignment()` Gets the alignment of this RtfParagraphStyle.
`String`	`getBasedOnName()` Gets the name of the RtfParagraphStyle this RtfParagraphStyle is based on.
`int`	`getFirstLineIndent()` Gets the first line indentation of this RtfParagraphStyle.
`int`	`getIndentLeft()` Gets the left indentation of this RtfParagraphStyle.
`int`	`getIndentRight()` Gets the right indentation of this RtfParagraphStyle.
`boolean`	`getKeepTogether()` Gets whether the lines in the paragraph should be kept together in this RtfParagraphStyle.
`boolean`	`getKeepTogetherWithNext()` Gets whether the paragraph should be kept together with the next in this RtfParagraphStyle.
`int`	`getLineLeading()` Gets the line leading of this RtfParagraphStyle.
`int`	`getSpacingAfter()` Gets the space after the paragraph of this RtfParagraphStyle.
`int`	`getSpacingBefore()` Gets the space before the paragraph of this RtfParagraphStyle..
`String`	`getStyleName()` Gets the name of this RtfParagraphStyle.
`void`	`handleInheritance()` Handles the inheritance of paragraph style settings.
`int`	`hashCode()` Gets the hash code of this RtfParagraphStyle.
`void`	`setAlignment(int alignment)` Sets the alignment of this RtfParagraphStyle.
`void`	`setColor(Color color)` Sets the color of this RtfParagraphStyle.
`void`	`setFirstLineIndent(int firstLineIndent)` Sets the first line indentation of this RtfParagraphStyle.
`void`	`setFontName(String fontName)` Sets the font name of this RtfParagraphStyle.
`void`	`setIndentLeft(int indentLeft)` Sets the left indentation of this RtfParagraphStyle.
`void`	`setIndentRight(int indentRight)` Sets the right indentation of this RtfParagraphStyle.
`void`	`setKeepTogether(boolean keepTogether)` Sets whether the lines in the paragraph should be kept together in this RtfParagraphStyle.
`void`	`setKeepTogetherWithNext(boolean keepTogetherWithNext)` Sets whether the paragraph should be kept together with the next in this RtfParagraphStyle.
`void`	`setLineLeading(int lineLeading)` Sets the line leading of this RtfParagraphStyle.
`void`	`setSize(float fontSize)` Sets the font size of this RtfParagraphStyle.
`void`	`setSpacingAfter(int spacingAfter)` Sets the space after the paragraph of this RtfParagraphStyle.
`void`	`setSpacingBefore(int spacingBefore)` Sets the space before the paragraph of this RtfParagraphStyle.
`void`	`setStyle(int fontStyle)` Sets the font style of this RtfParagraphStyle.
`protected void`	`setStyleNumber(int styleNumber)` Sets the number of this RtfParagraphStyle in the stylesheet list.
`void`	`writeBegin(OutputStream result)` Writes the start information of this RtfParagraphStyle.
`void`	`writeContent(OutputStream out)` unused
`void`	`writeDefinition(OutputStream result)` Writes the definition of this RtfParagraphStyle for the stylesheet list.
`void`	`writeEnd(OutputStream result)` Unused

Methods inherited from class com.lowagie.text.rtf.style.RtfFont
compareTo, difference, getFamilyname, getFontName, getFontNumber, getFontSize, getFontStyle, getCharset, intToByteArray, isStandardFont, setColor, setFamily, setCharset, setInHeader, setInTable, setRtfDocument, setStyle

Methods inherited from class com.lowagie.text.Font
getBaseFont, getCalculatedBaseFont, getCalculatedLeading, getCalculatedSize, getCalculatedStyle, getColor, getFamily, getFamilyIndex, getSize, getStyle, getStyleValue, isBold, isItalic, isStrikethru, isUnderlined

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

- Field Detail
  - ALIGN_LEFT
```
public static final byte[] ALIGN_LEFT
```
    Constant for left alignment
  - ALIGN_RIGHT
```
public static final byte[] ALIGN_RIGHT
```
    Constant for right alignment
  - ALIGN_CENTER
```
public static final byte[] ALIGN_CENTER
```
    Constant for center alignment
  - ALIGN_JUSTIFY
```
public static final byte[] ALIGN_JUSTIFY
```
    Constant for justified alignment
  - FIRST_LINE_INDENT
```
public static final byte[] FIRST_LINE_INDENT
```
    Constant for the first line indentation
  - INDENT_LEFT
```
public static final byte[] INDENT_LEFT
```
    Constant for left indentation
  - INDENT_RIGHT
```
public static final byte[] INDENT_RIGHT
```
    Constant for right indentation
  - KEEP_TOGETHER
```
public static final byte[] KEEP_TOGETHER
```
    Constant for keeping the paragraph together on one page
  - KEEP_TOGETHER_WITH_NEXT
```
public static final byte[] KEEP_TOGETHER_WITH_NEXT
```
    Constant for keeping the paragraph together with the next one on one page
  - SPACING_AFTER
```
public static final byte[] SPACING_AFTER
```
    Constant for the space after the paragraph.
  - SPACING_BEFORE
```
public static final byte[] SPACING_BEFORE
```
    Constant for the space before the paragraph.
  - STYLE_NORMAL
```
public static final RtfParagraphStyle STYLE_NORMAL
```
    The NORMAL/STANDARD style.
  - STYLE_HEADING_1
```
public static final RtfParagraphStyle STYLE_HEADING_1
```
    The style for level 1 headings.
  - STYLE_HEADING_2
```
public static final RtfParagraphStyle STYLE_HEADING_2
```
    The style for level 2 headings.
  - STYLE_HEADING_3
```
public static final RtfParagraphStyle STYLE_HEADING_3
```
    The style for level 3 headings.
- Constructor Detail
  - RtfParagraphStyle
```
public RtfParagraphStyle(String styleName,
                         String fontName,
                         int fontSize,
                         int fontStyle,
                         Color fontColor)
```
    Constructs a new RtfParagraphStyle with the given attributes.
    
    Parameters:
    
    styleName - The name of this RtfParagraphStyle.
    
    fontName - The name of the font to use for this RtfParagraphStyle.
    
    fontSize - The size of the font to use for this RtfParagraphStyle.
    
    fontStyle - The style of the font to use for this RtfParagraphStyle.
    
    fontColor - The color of the font to use for this RtfParagraphStyle.
  - RtfParagraphStyle
```
public RtfParagraphStyle(String styleName,
                         String basedOnName)
```
    Constructs a new RtfParagraphStyle that is based on an existing RtfParagraphStyle.
    
    Parameters:
    
    styleName - The name of this RtfParagraphStyle.
    
    basedOnName - The name of the RtfParagraphStyle this RtfParagraphStyle is based on.
  - RtfParagraphStyle
```
public RtfParagraphStyle(RtfDocument doc,
                         RtfParagraphStyle style)
```
    Constructs a RtfParagraphStyle from another RtfParagraphStyle. INTERNAL USE ONLY
    
    Parameters:
    
    doc - The RtfDocument this RtfParagraphStyle belongs to.
    
    style - The RtfParagraphStyle to copy settings from.
- Method Detail
  - getStyleName
```
public String getStyleName()
```
    Gets the name of this RtfParagraphStyle.
    
    Returns:
    
    The name of this RtfParagraphStyle.
  - getBasedOnName
```
public String getBasedOnName()
```
    Gets the name of the RtfParagraphStyle this RtfParagraphStyle is based on.
    
    Returns:
    
    The name of the base RtfParagraphStyle.
  - getAlignment
```
public int getAlignment()
```
    Gets the alignment of this RtfParagraphStyle.
    
    Returns:
    
    The alignment of this RtfParagraphStyle.
  - setAlignment
```
public void setAlignment(int alignment)
```
    Sets the alignment of this RtfParagraphStyle.
    
    Parameters:
    
    alignment - The alignment to use.
  - getFirstLineIndent
```
public int getFirstLineIndent()
```
    Gets the first line indentation of this RtfParagraphStyle.
    
    Returns:
    
    The first line indentation of this RtfParagraphStyle.
  - setFirstLineIndent
```
public void setFirstLineIndent(int firstLineIndent)
```
    Sets the first line indentation of this RtfParagraphStyle. It is relative to the left indentation.
    
    Parameters:
    
    firstLineIndent - The first line indentation to use.
  - getIndentLeft
```
public int getIndentLeft()
```
    Gets the left indentation of this RtfParagraphStyle.
    
    Returns:
    
    The left indentation of this RtfParagraphStyle.
  - setIndentLeft
```
public void setIndentLeft(int indentLeft)
```
    Sets the left indentation of this RtfParagraphStyle.
    
    Parameters:
    
    indentLeft - The left indentation to use.
  - getIndentRight
```
public int getIndentRight()
```
    Gets the right indentation of this RtfParagraphStyle.
    
    Returns:
    
    The right indentation of this RtfParagraphStyle.
  - setIndentRight
```
public void setIndentRight(int indentRight)
```
    Sets the right indentation of this RtfParagraphStyle.
    
    Parameters:
    
    indentRight - The right indentation to use.
  - getSpacingBefore
```
public int getSpacingBefore()
```
    Gets the space before the paragraph of this RtfParagraphStyle..
    
    Returns:
    
    The space before the paragraph.
  - setSpacingBefore
```
public void setSpacingBefore(int spacingBefore)
```
    Sets the space before the paragraph of this RtfParagraphStyle.
    
    Parameters:
    
    spacingBefore - The space before to use.
  - getSpacingAfter
```
public int getSpacingAfter()
```
    Gets the space after the paragraph of this RtfParagraphStyle.
    
    Returns:
    
    The space after the paragraph.
  - setSpacingAfter
```
public void setSpacingAfter(int spacingAfter)
```
    Sets the space after the paragraph of this RtfParagraphStyle.
    
    Parameters:
    
    spacingAfter - The space after to use.
  - setFontName
```
public void setFontName(String fontName)
```
    Sets the font name of this RtfParagraphStyle.
    
    Overrides:
    
    setFontName in class RtfFont
    
    Parameters:
    
    fontName - The font name to use
  - setSize
```
public void setSize(float fontSize)
```
    Sets the font size of this RtfParagraphStyle.
    
    Overrides:
    
    setSize in class RtfFont
    
    Parameters:
    
    fontSize - The font size to use.
    
    See Also:
    
    Font.setSize(float)
  - setStyle
```
public void setStyle(int fontStyle)
```
    Sets the font style of this RtfParagraphStyle.
    
    Overrides:
    
    setStyle in class RtfFont
    
    Parameters:
    
    fontStyle - The font style to use.
    
    See Also:
    
    Font.setStyle(int)
  - setColor
```
public void setColor(Color color)
```
    Sets the color of this RtfParagraphStyle.
    
    Overrides:
    
    setColor in class RtfFont
    
    Parameters:
    
    color - The Color to use.
    
    See Also:
    
    Font.setColor(Color)
  - getLineLeading
```
public int getLineLeading()
```
    Gets the line leading of this RtfParagraphStyle.
    
    Returns:
    
    The line leading of this RtfParagraphStyle.
  - setLineLeading
```
public void setLineLeading(int lineLeading)
```
    Sets the line leading of this RtfParagraphStyle.
    
    Parameters:
    
    lineLeading - The line leading to use.
  - getKeepTogether
```
public boolean getKeepTogether()
```
    Gets whether the lines in the paragraph should be kept together in this RtfParagraphStyle.
    
    Returns:
    
    Whether the lines in the paragraph should be kept together.
  - setKeepTogether
```
public void setKeepTogether(boolean keepTogether)
```
    Sets whether the lines in the paragraph should be kept together in this RtfParagraphStyle.
    
    Parameters:
    
    keepTogether - Whether the lines in the paragraph should be kept together.
  - getKeepTogetherWithNext
```
public boolean getKeepTogetherWithNext()
```
    Gets whether the paragraph should be kept together with the next in this RtfParagraphStyle.
    
    Returns:
    
    Whether the paragraph should be kept together with the next.
  - setKeepTogetherWithNext
```
public void setKeepTogetherWithNext(boolean keepTogetherWithNext)
```
    Sets whether the paragraph should be kept together with the next in this RtfParagraphStyle.
    
    Parameters:
    
    keepTogetherWithNext - Whether the paragraph should be kept together with the next.
  - handleInheritance
```
public void handleInheritance()
```
    Handles the inheritance of paragraph style settings. All settings that have not been modified will be inherited from the base RtfParagraphStyle. If this RtfParagraphStyle is not based on another one, then nothing happens.
  - writeDefinition
```
public void writeDefinition(OutputStream result)
                     throws IOException
```
    Writes the definition of this RtfParagraphStyle for the stylesheet list.
    
    Specified by:
    
    writeDefinition in interface RtfExtendedElement
    
    Overrides:
    
    writeDefinition in class RtfFont
    
    Parameters:
    
    result - The OutputStream to write the element definition to
    
    Throws:
    
    IOException
  - writeBegin
```
public void writeBegin(OutputStream result)
                throws IOException
```
    Writes the start information of this RtfParagraphStyle.
    
    Overrides:
    
    writeBegin in class RtfFont
    
    Parameters:
    
    result - The OutputStream to write to.
    
    Throws:
    
    IOException - On i/o errors.
  - writeEnd
```
public void writeEnd(OutputStream result)
              throws IOException
```
    Unused
    
    Overrides:
    
    writeEnd in class RtfFont
    
    Parameters:
    
    result - The OutputStream that nothing is written to
    
    Throws:
    
    IOException - On i/o errors.
  - writeContent
```
public void writeContent(OutputStream out)
                  throws IOException
```
    unused
    
    Specified by:
    
    writeContent in interface RtfBasicElement
    
    Overrides:
    
    writeContent in class RtfFont
    
    Parameters:
    
    out - The OutputStream to write the content to
    
    Throws:
    
    IOException
  - equals
```
public boolean equals(Object o)
```
    Tests whether two RtfParagraphStyles are equal. Equality is determined via the name.
    
    Overrides:
    
    equals in class RtfFont
    
    Parameters:
    
    o - The RtfFont to compare with this RtfFont
    
    Returns:
    
    True if the RtfFonts are equal, false otherwise
  - hashCode
```
public int hashCode()
```
    Gets the hash code of this RtfParagraphStyle.
    
    Overrides:
    
    hashCode in class RtfFont
    
    Returns:
    
    The hash code of this RtfFont
  - setStyleNumber
```
protected void setStyleNumber(int styleNumber)
```
    Sets the number of this RtfParagraphStyle in the stylesheet list.
    
    Parameters:
    
    styleNumber - The number to use.

Class RtfParagraphStyle

Field Summary

Fields inherited from class com.lowagie.text.rtf.style.RtfFont

Fields inherited from class com.lowagie.text.Font

Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement

Constructor Summary

Method Summary

Methods inherited from class com.lowagie.text.rtf.style.RtfFont

Methods inherited from class com.lowagie.text.Font

Methods inherited from class java.lang.Object

Field Detail

ALIGN_LEFT

ALIGN_RIGHT

ALIGN_CENTER

ALIGN_JUSTIFY

FIRST_LINE_INDENT

INDENT_LEFT

INDENT_RIGHT

KEEP_TOGETHER

KEEP_TOGETHER_WITH_NEXT

SPACING_AFTER

SPACING_BEFORE

STYLE_NORMAL

STYLE_HEADING_1

STYLE_HEADING_2

STYLE_HEADING_3

Constructor Detail

RtfParagraphStyle

RtfParagraphStyle

RtfParagraphStyle

Method Detail

getStyleName

getBasedOnName

getAlignment

setAlignment

getFirstLineIndent

setFirstLineIndent

getIndentLeft

setIndentLeft

getIndentRight

setIndentRight

getSpacingBefore

setSpacingBefore

getSpacingAfter

setSpacingAfter

setFontName

setSize

setStyle

setColor

getLineLeading

setLineLeading

getKeepTogether

setKeepTogether

getKeepTogetherWithNext

setKeepTogetherWithNext

handleInheritance

writeDefinition

writeBegin

writeEnd

writeContent

equals

hashCode

setStyleNumber