RtfProperty (iText-4.2.1 4.2.1 API)

java.lang.Object
- com.lowagie.text.rtf.parser.properties.RtfProperty

```
public class RtfProperty
extends Object
```
RtfProperty handles document, paragraph, etc. property values

Since:

2.0.8

Author:

Howard Shank ([email protected])

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHARACTER`
`static String`	`CHARACTER_BOLD`
`static String`	`CHARACTER_FONT`
`static String`	`CHARACTER_ITALIC`
`static String`	`CHARACTER_SIZE`
`static String`	`CHARACTER_STYLE`
`static String`	`CHARACTER_UNDERLINE`
`static String`	`COLOR`
`static String`	`COLOR_BG`
`static String`	`COLOR_FG`
`static String`	`DOCUMENT`
`static String`	`DOCUMENT_DEFAULT_FONT_NUMER`
`static String`	`DOCUMENT_ENABLE_FACING_PAGES`
`static String`	`DOCUMENT_MARGIN_BOTTOM_TWIPS`
`static String`	`DOCUMENT_MARGIN_LEFT_TWIPS`
`static String`	`DOCUMENT_MARGIN_RIGHT_TWIPS`
`static String`	`DOCUMENT_MARGIN_TOP_TWIPS`
`static String`	`DOCUMENT_PAGE_HEIGHT_TWIPS`
`static String`	`DOCUMENT_PAGE_NUMBER_START`
`static String`	`DOCUMENT_PAGE_ORIENTATION`
`static String`	`DOCUMENT_PAGE_WIDTH_TWIPS`
`static int`	`JUSTIFY_CENTER` Justify center
`static int`	`JUSTIFY_FULL` Justify full
`static int`	`JUSTIFY_LEFT` Justify left
`static int`	`JUSTIFY_RIGHT` Justify right
`static int`	`OFF`
`static int`	`ON`
`static String`	`PAGE_LANDSCAPE` Landscape orientation
`static String`	`PAGE_PORTRAIT` Portrait orientation
`static String`	`PARAGRAPH`
`static String`	`PARAGRAPH_BORDER`
`static int`	`PARAGRAPH_BORDER_BOTTOM` possible border settting
`static String`	`PARAGRAPH_BORDER_CELL`
`static int`	`PARAGRAPH_BORDER_DIAGONAL_UL_LR` possible border settting
`static int`	`PARAGRAPH_BORDER_DIAGONAL_UR_LL` possible border settting
`static int`	`PARAGRAPH_BORDER_LEFT` possible border settting
`static int`	`PARAGRAPH_BORDER_NIL` possible border settting
`static int`	`PARAGRAPH_BORDER_RIGHT` possible border settting
`static int`	`PARAGRAPH_BORDER_TABLE_HORIZONTAL` possible border settting
`static int`	`PARAGRAPH_BORDER_TABLE_VERTICAL` possible border settting
`static int`	`PARAGRAPH_BORDER_TOP` possible border settting
`static String`	`PARAGRAPH_INDENT_FIRST_LINE`
`static String`	`PARAGRAPH_INDENT_LEFT`
`static String`	`PARAGRAPH_INDENT_RIGHT`
`static String`	`PARAGRAPH_JUSTIFICATION`
`static int`	`PGN_DECIMAL` Decimal number format
`static int`	`PGN_LETTER_LOWERCASE` Lowercase Letter
`static int`	`PGN_LETTER_UPPERCASE` Uppercase Letter
`static int`	`PGN_ROMAN_NUMERAL_LOWERCASE` Lowercase Roman Numeral
`static int`	`PGN_ROMAN_NUMERAL_UPPERCASE` Uppercase Roman Numeral
`protected HashMap`	`properties` Properties for this RtfProperty object
`static int`	`SBK_COLUMN` Section Break Column break
`static int`	`SBK_EVEN` Section Break Even page break
`static int`	`SBK_NONE` Section Break None
`static int`	`SBK_ODD` Section Break Odd page break
`static int`	`SBK_PAGE` Section Break Page break
`static String`	`SECTION`
`static String`	`SECTION_BREAK_TYPE`
`static String`	`SECTION_NUMBER_OF_COLUMNS`
`static String`	`SECTION_PAGE_NUMBER_FORMAT`
`static String`	`SECTION_PAGE_NUMBER_POSITION_X`
`static String`	`SECTION_PAGE_NUMBER_POSITION_Y`

Constructor Summary

Constructors
Constructor and Description

RtfProperty()

Constructors
Constructor and Description
`RtfProperty()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRtfPropertyListener(RtfPropertyListener listener)` Adds a `RtfPropertyListener` to the `RtfProperty`.
`void`	`afterChange(String propertyName)`
`void`	`beforeChange(String propertyName)`
`HashMap`	`getProperties(String propertyGroup)` Get a group of properties.
`Object`	`getProperty(String propertyName)` Get the value of the property identified by the parameter.
`boolean`	`isModified()`
`boolean`	`isModifiedCharacter()`
`boolean`	`isModifiedDocument()`
`boolean`	`isModifiedParagraph()`
`boolean`	`isModifiedSection()`
`void`	`removeRtfPropertyListener(RtfPropertyListener listener)` Removes a `RtfPropertyListener` from the `RtfProperty`.
`void`	`setModified(String propertyName, boolean modified)`
`void`	`setModifiedCharacter(boolean modifiedCharacter)`
`void`	`setModifiedDocument(boolean modifiedDocument)`
`void`	`setModifiedParagraph(boolean modifiedParagraph)`
`void`	`setModifiedSection(boolean modifiedSection)`
`boolean`	`setProperty(RtfCtrlWordData ctrlWordData)` Set the value of the property identified by the parameter.
`void`	`setToDefault()` Set all property objects to default values.
`void`	`setToDefault(String propertyGroup)` Set individual property group to default values.
`boolean`	`toggleProperty(RtfCtrlWordData ctrlWordData)` Toggle the value of the property identified by the `RtfCtrlWordData.specialHandler` parameter.

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

- Field Detail
  - OFF
```
public static final int OFF
```
    See Also:
    Constant Field Values
  - ON
```
public static final int ON
```
    See Also:
    Constant Field Values
  - COLOR
```
public static final String COLOR
```
    See Also:
    Constant Field Values
  - CHARACTER
```
public static final String CHARACTER
```
    See Also:
    Constant Field Values
  - PARAGRAPH
```
public static final String PARAGRAPH
```
    See Also:
    Constant Field Values
  - SECTION
```
public static final String SECTION
```
    See Also:
    Constant Field Values
  - DOCUMENT
```
public static final String DOCUMENT
```
    See Also:
    Constant Field Values
  - COLOR_FG
```
public static final String COLOR_FG
```
    See Also:
    Constant Field Values
  - COLOR_BG
```
public static final String COLOR_BG
```
    See Also:
    Constant Field Values
  - CHARACTER_BOLD
```
public static final String CHARACTER_BOLD
```
    See Also:
    Constant Field Values
  - CHARACTER_UNDERLINE
```
public static final String CHARACTER_UNDERLINE
```
    See Also:
    Constant Field Values
  - CHARACTER_ITALIC
```
public static final String CHARACTER_ITALIC
```
    See Also:
    Constant Field Values
  - CHARACTER_SIZE
```
public static final String CHARACTER_SIZE
```
    See Also:
    Constant Field Values
  - CHARACTER_FONT
```
public static final String CHARACTER_FONT
```
    See Also:
    Constant Field Values
  - CHARACTER_STYLE
```
public static final String CHARACTER_STYLE
```
    See Also:
    Constant Field Values
  - JUSTIFY_LEFT
```
public static final int JUSTIFY_LEFT
```
    Justify left
    
    See Also:
    Constant Field Values
  - JUSTIFY_RIGHT
```
public static final int JUSTIFY_RIGHT
```
    Justify right
    
    See Also:
    Constant Field Values
  - JUSTIFY_CENTER
```
public static final int JUSTIFY_CENTER
```
    Justify center
    
    See Also:
    Constant Field Values
  - JUSTIFY_FULL
```
public static final int JUSTIFY_FULL
```
    Justify full
    
    See Also:
    Constant Field Values
  - PARAGRAPH_INDENT_LEFT
```
public static final String PARAGRAPH_INDENT_LEFT
```
    See Also:
    Constant Field Values
  - PARAGRAPH_INDENT_RIGHT
```
public static final String PARAGRAPH_INDENT_RIGHT
```
    See Also:
    Constant Field Values
  - PARAGRAPH_INDENT_FIRST_LINE
```
public static final String PARAGRAPH_INDENT_FIRST_LINE
```
    See Also:
    Constant Field Values
  - PARAGRAPH_JUSTIFICATION
```
public static final String PARAGRAPH_JUSTIFICATION
```
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER
```
public static final String PARAGRAPH_BORDER
```
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_CELL
```
public static final String PARAGRAPH_BORDER_CELL
```
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_NIL
```
public static final int PARAGRAPH_BORDER_NIL
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_BOTTOM
```
public static final int PARAGRAPH_BORDER_BOTTOM
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_TOP
```
public static final int PARAGRAPH_BORDER_TOP
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_LEFT
```
public static final int PARAGRAPH_BORDER_LEFT
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_RIGHT
```
public static final int PARAGRAPH_BORDER_RIGHT
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_DIAGONAL_UL_LR
```
public static final int PARAGRAPH_BORDER_DIAGONAL_UL_LR
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_DIAGONAL_UR_LL
```
public static final int PARAGRAPH_BORDER_DIAGONAL_UR_LL
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_TABLE_HORIZONTAL
```
public static final int PARAGRAPH_BORDER_TABLE_HORIZONTAL
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PARAGRAPH_BORDER_TABLE_VERTICAL
```
public static final int PARAGRAPH_BORDER_TABLE_VERTICAL
```
    possible border settting
    
    See Also:
    Constant Field Values
  - PGN_DECIMAL
```
public static final int PGN_DECIMAL
```
    Decimal number format
    
    See Also:
    Constant Field Values
  - PGN_ROMAN_NUMERAL_UPPERCASE
```
public static final int PGN_ROMAN_NUMERAL_UPPERCASE
```
    Uppercase Roman Numeral
    
    See Also:
    Constant Field Values
  - PGN_ROMAN_NUMERAL_LOWERCASE
```
public static final int PGN_ROMAN_NUMERAL_LOWERCASE
```
    Lowercase Roman Numeral
    
    See Also:
    Constant Field Values
  - PGN_LETTER_UPPERCASE
```
public static final int PGN_LETTER_UPPERCASE
```
    Uppercase Letter
    
    See Also:
    Constant Field Values
  - PGN_LETTER_LOWERCASE
```
public static final int PGN_LETTER_LOWERCASE
```
    Lowercase Letter
    
    See Also:
    Constant Field Values
  - SBK_NONE
```
public static final int SBK_NONE
```
    Section Break None
    
    See Also:
    Constant Field Values
  - SBK_COLUMN
```
public static final int SBK_COLUMN
```
    Section Break Column break
    
    See Also:
    Constant Field Values
  - SBK_EVEN
```
public static final int SBK_EVEN
```
    Section Break Even page break
    
    See Also:
    Constant Field Values
  - SBK_ODD
```
public static final int SBK_ODD
```
    Section Break Odd page break
    
    See Also:
    Constant Field Values
  - SBK_PAGE
```
public static final int SBK_PAGE
```
    Section Break Page break
    
    See Also:
    Constant Field Values
  - SECTION_NUMBER_OF_COLUMNS
```
public static final String SECTION_NUMBER_OF_COLUMNS
```
    See Also:
    Constant Field Values
  - SECTION_BREAK_TYPE
```
public static final String SECTION_BREAK_TYPE
```
    See Also:
    Constant Field Values
  - SECTION_PAGE_NUMBER_POSITION_X
```
public static final String SECTION_PAGE_NUMBER_POSITION_X
```
    See Also:
    Constant Field Values
  - SECTION_PAGE_NUMBER_POSITION_Y
```
public static final String SECTION_PAGE_NUMBER_POSITION_Y
```
    See Also:
    Constant Field Values
  - SECTION_PAGE_NUMBER_FORMAT
```
public static final String SECTION_PAGE_NUMBER_FORMAT
```
    See Also:
    Constant Field Values
  - PAGE_PORTRAIT
```
public static final String PAGE_PORTRAIT
```
    Portrait orientation
    
    See Also:
    Constant Field Values
  - PAGE_LANDSCAPE
```
public static final String PAGE_LANDSCAPE
```
    Landscape orientation
    
    See Also:
    Constant Field Values
  - DOCUMENT_PAGE_WIDTH_TWIPS
```
public static final String DOCUMENT_PAGE_WIDTH_TWIPS
```
    See Also:
    Constant Field Values
  - DOCUMENT_PAGE_HEIGHT_TWIPS
```
public static final String DOCUMENT_PAGE_HEIGHT_TWIPS
```
    See Also:
    Constant Field Values
  - DOCUMENT_MARGIN_LEFT_TWIPS
```
public static final String DOCUMENT_MARGIN_LEFT_TWIPS
```
    See Also:
    Constant Field Values
  - DOCUMENT_MARGIN_TOP_TWIPS
```
public static final String DOCUMENT_MARGIN_TOP_TWIPS
```
    See Also:
    Constant Field Values
  - DOCUMENT_MARGIN_RIGHT_TWIPS
```
public static final String DOCUMENT_MARGIN_RIGHT_TWIPS
```
    See Also:
    Constant Field Values
  - DOCUMENT_MARGIN_BOTTOM_TWIPS
```
public static final String DOCUMENT_MARGIN_BOTTOM_TWIPS
```
    See Also:
    Constant Field Values
  - DOCUMENT_PAGE_NUMBER_START
```
public static final String DOCUMENT_PAGE_NUMBER_START
```
    See Also:
    Constant Field Values
  - DOCUMENT_ENABLE_FACING_PAGES
```
public static final String DOCUMENT_ENABLE_FACING_PAGES
```
    See Also:
    Constant Field Values
  - DOCUMENT_PAGE_ORIENTATION
```
public static final String DOCUMENT_PAGE_ORIENTATION
```
    See Also:
    Constant Field Values
  - DOCUMENT_DEFAULT_FONT_NUMER
```
public static final String DOCUMENT_DEFAULT_FONT_NUMER
```
    See Also:
    Constant Field Values
  - properties
```
protected HashMap properties
```
    Properties for this RtfProperty object
- Constructor Detail
  - RtfProperty
```
public RtfProperty()
```
- Method Detail
  - setToDefault
```
public void setToDefault()
```
    Set all property objects to default values.
    
    Since:
    
    2.0.8
  - setToDefault
```
public void setToDefault(String propertyGroup)
```
    Set individual property group to default values.
    
    Parameters:
    propertyGroup - String name of the property group to set to default.
    Since:
    
    2.0.8
  - toggleProperty
```
public boolean toggleProperty(RtfCtrlWordData ctrlWordData)
```
    Toggle the value of the property identified by the RtfCtrlWordData.specialHandler parameter. Toggle values are assumed to be integer values per the RTF spec with a value of 0=off or 1=on.
    
    Parameters:
    ctrlWordData - The property name to set
    
    Returns:
    true for handled or false if propertyName is null or blank
  - setProperty
```
public boolean setProperty(RtfCtrlWordData ctrlWordData)
```
    Set the value of the property identified by the parameter.
    
    Parameters:
    ctrlWordData - The controlword with the name to set
    
    Returns:
    true for handled or false if propertyName or propertyValue is null
  - getProperty
```
public Object getProperty(String propertyName)
```
    Get the value of the property identified by the parameter.
    
    Parameters:
    propertyName - String containing the property name to get
    
    Returns:
    Property Object requested or null if not found in map.
  - getProperties
```
public HashMap getProperties(String propertyGroup)
```
    Get a group of properties.
    
    Parameters:
    propertyGroup - The group name to obtain.
    
    Returns:
    Properties object with requested values.
  - isModified
```
public boolean isModified()
```
    Returns:
    the modified
  - setModified
```
public void setModified(String propertyName,
               boolean modified)
```
    Parameters:
    propertyName - the propertyName that is modified
    modified - the modified to set
  - isModifiedCharacter
```
public boolean isModifiedCharacter()
```
    Returns:
    the modifiedCharacter
  - setModifiedCharacter
```
public void setModifiedCharacter(boolean modifiedCharacter)
```
    Parameters:
    modifiedCharacter - the modifiedCharacter to set
  - isModifiedParagraph
```
public boolean isModifiedParagraph()
```
    Returns:
    the modifiedParagraph
  - setModifiedParagraph
```
public void setModifiedParagraph(boolean modifiedParagraph)
```
    Parameters:
    modifiedParagraph - the modifiedParagraph to set
  - isModifiedSection
```
public boolean isModifiedSection()
```
    Returns:
    the modifiedSection
  - setModifiedSection
```
public void setModifiedSection(boolean modifiedSection)
```
    Parameters:
    modifiedSection - the modifiedSection to set
  - isModifiedDocument
```
public boolean isModifiedDocument()
```
    Returns:
    the modifiedDocument
  - setModifiedDocument
```
public void setModifiedDocument(boolean modifiedDocument)
```
    Parameters:
    modifiedDocument - the modifiedDocument to set
  - addRtfPropertyListener
```
public void addRtfPropertyListener(RtfPropertyListener listener)
```
    Adds a RtfPropertyListener to the RtfProperty.
    
    Parameters:
    listener - the new RtfPropertyListener.
  - removeRtfPropertyListener
```
public void removeRtfPropertyListener(RtfPropertyListener listener)
```
    Removes a RtfPropertyListener from the RtfProperty.
    
    Parameters:
    listener - the new RtfPropertyListener.
  - beforeChange
```
public void beforeChange(String propertyName)
```
  - afterChange
```
public void afterChange(String propertyName)
```

Class RtfProperty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OFF

ON

COLOR

CHARACTER

PARAGRAPH

SECTION

DOCUMENT

COLOR_FG

COLOR_BG

CHARACTER_BOLD

CHARACTER_UNDERLINE

CHARACTER_ITALIC

CHARACTER_SIZE

CHARACTER_FONT

CHARACTER_STYLE

JUSTIFY_LEFT

JUSTIFY_RIGHT

JUSTIFY_CENTER

JUSTIFY_FULL

PARAGRAPH_INDENT_LEFT

PARAGRAPH_INDENT_RIGHT

PARAGRAPH_INDENT_FIRST_LINE

PARAGRAPH_JUSTIFICATION

PARAGRAPH_BORDER

PARAGRAPH_BORDER_CELL

PARAGRAPH_BORDER_NIL

PARAGRAPH_BORDER_BOTTOM

PARAGRAPH_BORDER_TOP

PARAGRAPH_BORDER_LEFT

PARAGRAPH_BORDER_RIGHT

PARAGRAPH_BORDER_DIAGONAL_UL_LR

PARAGRAPH_BORDER_DIAGONAL_UR_LL

PARAGRAPH_BORDER_TABLE_HORIZONTAL

PARAGRAPH_BORDER_TABLE_VERTICAL

PGN_DECIMAL

PGN_ROMAN_NUMERAL_UPPERCASE

PGN_ROMAN_NUMERAL_LOWERCASE

PGN_LETTER_UPPERCASE

PGN_LETTER_LOWERCASE

SBK_NONE

SBK_COLUMN

SBK_EVEN

SBK_ODD

SBK_PAGE

SECTION_NUMBER_OF_COLUMNS

SECTION_BREAK_TYPE

SECTION_PAGE_NUMBER_POSITION_X

SECTION_PAGE_NUMBER_POSITION_Y

SECTION_PAGE_NUMBER_FORMAT

PAGE_PORTRAIT

PAGE_LANDSCAPE

DOCUMENT_PAGE_WIDTH_TWIPS

DOCUMENT_PAGE_HEIGHT_TWIPS

DOCUMENT_MARGIN_LEFT_TWIPS

DOCUMENT_MARGIN_TOP_TWIPS

DOCUMENT_MARGIN_RIGHT_TWIPS

DOCUMENT_MARGIN_BOTTOM_TWIPS

DOCUMENT_PAGE_NUMBER_START

DOCUMENT_ENABLE_FACING_PAGES

DOCUMENT_PAGE_ORIENTATION

DOCUMENT_DEFAULT_FONT_NUMER

properties

Constructor Detail

RtfProperty

Method Detail

setToDefault

setToDefault

toggleProperty

setProperty

getProperty

getProperties

isModified

setModified

isModifiedCharacter