com.lowagie.text.rtf.parser.properties
public class RtfProperty extends Object
RtfProperty
handles document, paragraph, etc. property values
Since: 2.0.8
Field Summary | |
---|---|
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 |
ArrayList | listeners The RtfPropertyListener . |
boolean | modifiedCharacter |
boolean | modifiedDocument |
boolean | modifiedParagraph |
boolean | modifiedSection |
static int | OFF |
static int | ON |
protected HashMap | properties Properties for this RtfProperty object |
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 |
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 |
Method Summary | |
---|---|
void | addRtfPropertyListener(RtfPropertyListener listener)
Adds a RtfPropertyListener to the RtfProperty .
|
boolean | addToProperty(String propertyName, int propertyValue)
Add the value of the property identified by the parameter.
|
boolean | addToProperty(String propertyName, long propertyValue)
Add the value of the property identified by the parameter.
|
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() |
boolean | removeProperty(String propertyName) |
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.
|
boolean | setProperty(String propertyName, Object propertyValueNew)
Set the value of the property identified by the parameter.
|
boolean | setProperty(String propertyName, int propertyValueNew)
Set the value of the property identified by the parameter.
|
boolean | setProperty(String propertyName, long propertyValueNew)
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.
|
RtfPropertyListener
.RtfPropertyListener
to the RtfProperty
.
Parameters: listener the new RtfPropertyListener.
Parameters: propertyName The property name to set propertyValue The object to set the property value to
Returns: true
for handled or false
if propertyName
is null
Parameters: propertyName The property name to set propertyValue The object to set the property value to
Returns: true
for handled or false
if propertyName
is null
Parameters: propertyGroup The group name to obtain.
Returns: Properties object with requested values.
Parameters: propertyName String containing the property name to get
Returns: Property Object requested or null if not found in map.
Returns: the modified
Returns: the modifiedCharacter
Returns: the modifiedDocument
Returns: the modifiedParagraph
Returns: the modifiedSection
RtfPropertyListener
from the RtfProperty
.
Parameters: listener the new RtfPropertyListener.
Parameters: propertyName the propertyName that is modified modified the modified to set
Parameters: modifiedCharacter the modifiedCharacter to set
Parameters: modifiedDocument the modifiedDocument to set
Parameters: modifiedParagraph the modifiedParagraph to set
Parameters: modifiedSection the modifiedSection to set
Parameters: ctrlWordData The controlword with the name to set
Returns: true
for handled or false
if propertyName
or propertyValue
is null
Parameters: propertyName The property name to set propertyValueNew The object to set the property value to
Returns: true
for handled or false
if propertyName
or propertyValue
is null
Parameters: propertyName The property name to set propertyValueNew The object to set the property value to
Returns: true
for handled or false
if propertyName
is null
Parameters: propertyName The property name to set propertyValueNew The object to set the property value to
Returns: true
for handled or false
if propertyName
is null
Since: 2.0.8
Parameters: propertyGroup String
name of the property group to set to default.
Since: 2.0.8
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