Class RtfProperty
java.lang.Object
com.lowagie.text.rtf.parser.properties.RtfProperty
RtfProperty
handles document, paragraph, etc. property values- Since:
- 2.0.8
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final int
Justify centerstatic final int
Justify fullstatic final int
Justify leftstatic final int
Justify rightprivate final List
<RtfPropertyListener> TheRtfPropertyListener
.private boolean
private boolean
private boolean
private boolean
static final int
static final int
static final String
Landscape orientationstatic final String
Portrait orientationstatic final String
static final String
static final int
possible border setttingstatic final String
static final int
possible border setttingstatic final int
possible border setttingstatic final int
possible border setttingstatic final int
possible border setttingstatic final int
possible border setttingstatic final int
possible border setttingstatic final int
possible border setttingstatic final int
possible border setttingstatic final String
static final String
static final String
static final String
static final int
Decimal number formatstatic final int
Lowercase Letterstatic final int
Uppercase Letterstatic final int
Lowercase Roman Numeralstatic final int
Uppercase Roman NumeralProperties for this RtfProperty objectstatic final int
Section Break Column breakstatic final int
Section Break Even page breakstatic final int
Section Break Nonestatic final int
Section Break Odd page breakstatic final int
Section Break Page breakstatic final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addRtfPropertyListener
(RtfPropertyListener listener) Adds aRtfPropertyListener
to theRtfProperty
.private boolean
addToProperty
(String propertyName, int propertyValue) Add the value of the property identified by the parameter.private boolean
addToProperty
(String propertyName, long propertyValue) Add the value of the property identified by the parameter.void
afterChange
(String propertyName) void
beforeChange
(String propertyName) getProperties
(String propertyGroup) Get a group of properties.getProperty
(String propertyName) Get the value of the property identified by the parameter.boolean
boolean
boolean
boolean
boolean
private boolean
removeProperty
(String propertyName) void
removeRtfPropertyListener
(RtfPropertyListener listener) Removes aRtfPropertyListener
from theRtfProperty
.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.private boolean
setProperty
(String propertyName, int propertyValueNew) Set the value of the property identified by the parameter.private boolean
setProperty
(String propertyName, long propertyValueNew) Set the value of the property identified by the parameter.private boolean
setProperty
(String propertyName, Object propertyValueNew) Set the value of the property identified by the parameter.void
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 theRtfCtrlWordData.specialHandler
parameter.
-
Field Details
-
OFF
public static final int OFF- See Also:
-
ON
public static final int ON- See Also:
-
COLOR
- See Also:
-
CHARACTER
- See Also:
-
PARAGRAPH
- See Also:
-
SECTION
- See Also:
-
DOCUMENT
- See Also:
-
COLOR_FG
- See Also:
-
COLOR_BG
- See Also:
-
CHARACTER_BOLD
- See Also:
-
CHARACTER_UNDERLINE
- See Also:
-
CHARACTER_ITALIC
- See Also:
-
CHARACTER_SIZE
- See Also:
-
CHARACTER_FONT
- See Also:
-
CHARACTER_STYLE
- See Also:
-
JUSTIFY_LEFT
public static final int JUSTIFY_LEFTJustify left- See Also:
-
JUSTIFY_RIGHT
public static final int JUSTIFY_RIGHTJustify right- See Also:
-
JUSTIFY_CENTER
public static final int JUSTIFY_CENTERJustify center- See Also:
-
JUSTIFY_FULL
public static final int JUSTIFY_FULLJustify full- See Also:
-
PARAGRAPH_INDENT_LEFT
- See Also:
-
PARAGRAPH_INDENT_RIGHT
- See Also:
-
PARAGRAPH_INDENT_FIRST_LINE
- See Also:
-
PARAGRAPH_JUSTIFICATION
- See Also:
-
PARAGRAPH_BORDER
- See Also:
-
PARAGRAPH_BORDER_CELL
- See Also:
-
PARAGRAPH_BORDER_NIL
public static final int PARAGRAPH_BORDER_NILpossible border settting- See Also:
-
PARAGRAPH_BORDER_BOTTOM
public static final int PARAGRAPH_BORDER_BOTTOMpossible border settting- See Also:
-
PARAGRAPH_BORDER_TOP
public static final int PARAGRAPH_BORDER_TOPpossible border settting- See Also:
-
PARAGRAPH_BORDER_LEFT
public static final int PARAGRAPH_BORDER_LEFTpossible border settting- See Also:
-
PARAGRAPH_BORDER_RIGHT
public static final int PARAGRAPH_BORDER_RIGHTpossible border settting- See Also:
-
PARAGRAPH_BORDER_DIAGONAL_UL_LR
public static final int PARAGRAPH_BORDER_DIAGONAL_UL_LRpossible border settting- See Also:
-
PARAGRAPH_BORDER_DIAGONAL_UR_LL
public static final int PARAGRAPH_BORDER_DIAGONAL_UR_LLpossible border settting- See Also:
-
PARAGRAPH_BORDER_TABLE_HORIZONTAL
public static final int PARAGRAPH_BORDER_TABLE_HORIZONTALpossible border settting- See Also:
-
PARAGRAPH_BORDER_TABLE_VERTICAL
public static final int PARAGRAPH_BORDER_TABLE_VERTICALpossible border settting- See Also:
-
PGN_DECIMAL
public static final int PGN_DECIMALDecimal number format- See Also:
-
PGN_ROMAN_NUMERAL_UPPERCASE
public static final int PGN_ROMAN_NUMERAL_UPPERCASEUppercase Roman Numeral- See Also:
-
PGN_ROMAN_NUMERAL_LOWERCASE
public static final int PGN_ROMAN_NUMERAL_LOWERCASELowercase Roman Numeral- See Also:
-
PGN_LETTER_UPPERCASE
public static final int PGN_LETTER_UPPERCASEUppercase Letter- See Also:
-
PGN_LETTER_LOWERCASE
public static final int PGN_LETTER_LOWERCASELowercase Letter- See Also:
-
SBK_NONE
public static final int SBK_NONESection Break None- See Also:
-
SBK_COLUMN
public static final int SBK_COLUMNSection Break Column break- See Also:
-
SBK_EVEN
public static final int SBK_EVENSection Break Even page break- See Also:
-
SBK_ODD
public static final int SBK_ODDSection Break Odd page break- See Also:
-
SBK_PAGE
public static final int SBK_PAGESection Break Page break- See Also:
-
SECTION_NUMBER_OF_COLUMNS
- See Also:
-
SECTION_BREAK_TYPE
- See Also:
-
SECTION_PAGE_NUMBER_POSITION_X
- See Also:
-
SECTION_PAGE_NUMBER_POSITION_Y
- See Also:
-
SECTION_PAGE_NUMBER_FORMAT
- See Also:
-
PAGE_PORTRAIT
Portrait orientation- See Also:
-
PAGE_LANDSCAPE
Landscape orientation- See Also:
-
DOCUMENT_PAGE_WIDTH_TWIPS
- See Also:
-
DOCUMENT_PAGE_HEIGHT_TWIPS
- See Also:
-
DOCUMENT_MARGIN_LEFT_TWIPS
- See Also:
-
DOCUMENT_MARGIN_TOP_TWIPS
- See Also:
-
DOCUMENT_MARGIN_RIGHT_TWIPS
- See Also:
-
DOCUMENT_MARGIN_BOTTOM_TWIPS
- See Also:
-
DOCUMENT_PAGE_NUMBER_START
- See Also:
-
DOCUMENT_ENABLE_FACING_PAGES
- See Also:
-
DOCUMENT_PAGE_ORIENTATION
- See Also:
-
DOCUMENT_DEFAULT_FONT_NUMER
- See Also:
-
properties
Properties for this RtfProperty object -
modifiedCharacter
private boolean modifiedCharacter -
modifiedParagraph
private boolean modifiedParagraph -
modifiedSection
private boolean modifiedSection -
modifiedDocument
private boolean modifiedDocument -
listeners
TheRtfPropertyListener
.
-
-
Constructor Details
-
RtfProperty
public RtfProperty()
-
-
Method Details
-
setToDefault
public void setToDefault()Set all property objects to default values.- Since:
- 2.0.8
-
setToDefault
Set individual property group to default values.- Parameters:
propertyGroup
-String
name of the property group to set to default.- Since:
- 2.0.8
-
toggleProperty
Toggle the value of the property identified by theRtfCtrlWordData.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 orfalse
ifpropertyName
isnull
or blank
-
setProperty
Set the value of the property identified by the parameter.- Parameters:
ctrlWordData
- The controlword with the name to set- Returns:
true
for handled orfalse
ifpropertyName
orpropertyValue
isnull
-
setProperty
Set the value of the property identified by the parameter.- Parameters:
propertyName
- The property name to setpropertyValueNew
- The object to set the property value to- Returns:
true
for handled orfalse
ifpropertyName
orpropertyValue
isnull
-
setProperty
Set the value of the property identified by the parameter.- Parameters:
propertyName
- The property name to setpropertyValueNew
- The object to set the property value to- Returns:
true
for handled orfalse
ifpropertyName
isnull
-
addToProperty
Add the value of the property identified by the parameter.- Parameters:
propertyName
- The property name to setpropertyValue
- The object to set the property value to- Returns:
true
for handled orfalse
ifpropertyName
isnull
-
setProperty
Set the value of the property identified by the parameter.- Parameters:
propertyName
- The property name to setpropertyValueNew
- The object to set the property value to- Returns:
true
for handled orfalse
ifpropertyName
isnull
-
addToProperty
Add the value of the property identified by the parameter.- Parameters:
propertyName
- The property name to setpropertyValue
- The object to set the property value to- Returns:
true
for handled orfalse
ifpropertyName
isnull
-
removeProperty
-
getProperty
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
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
- Parameters:
propertyName
- the propertyName that is modifiedmodified
- 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
Adds aRtfPropertyListener
to theRtfProperty
.- Parameters:
listener
- the new RtfPropertyListener.
-
removeRtfPropertyListener
Removes aRtfPropertyListener
from theRtfProperty
.- Parameters:
listener
- the new RtfPropertyListener.
-
beforeChange
-
afterChange
-