|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.odftoolkit.simple.style.ParagraphProperties
public class ParagraphProperties
This class represents the paragraph style settings. It provides methods to access horizontal alignment. More functions will be added latter.
This class is a corresponded high level class for element "style:paragraph-properties". It provides methods to access the attributes and children of "style:paragraph-properties".
Constructor Summary | |
---|---|
protected |
ParagraphProperties()
Create an empty paragraph style setting object |
protected |
ParagraphProperties(StyleParagraphPropertiesElement properties)
Create a paragraph style setting object, which has the association with an element "style:paragraph-properties". |
Method Summary | |
---|---|
String |
getBackgroundColorAttribute()
Gets backgroundColor represented by the OpenDocument format used data type See W3C CSS specification for further details. |
String |
getBreakAfter()
|
String |
getBreakBefore()
|
StyleTypeDefinitions.HorizontalAlignmentType |
getHorizontalAlignment()
Return the horizontal alignment. |
double |
getMarginBottom()
Get the size of the bottom margin of this ParagraphProperties |
double |
getMarginLeft()
Get the size of the left margin of this ParagraphProperties |
double |
getMarginRight()
Get the size of the right margin of this ParagraphProperties |
double |
getMarginTop()
Get the size of the top margin of this ParagraphProperties |
static ParagraphProperties |
getOrCreateParagraphProperties(OdfStyleBase style)
Return an instance of ParagraphProperties |
int |
getPageNumber()
|
static ParagraphProperties |
getParagraphProperties(OdfStyleBase style)
Return an instance of ParagraphProperties |
double |
getTextIndent()
Get the size of the text indention of this ParagraphProperties |
void |
setBackgroundColor(Color bkColor)
Sets backgroundColor represented by the OpenDocument format used data type See W3C CSS specification for further details. |
void |
setBreak(String breakPosition,
String breakAttribute)
|
void |
setHorizontalAlignment(StyleTypeDefinitions.HorizontalAlignmentType alignType)
Set the horizontal alignment. |
void |
setMarginBottom(double marginBottom)
Set the bottom margin of this ParagraphProperties |
void |
setMarginLeft(double marginLeft)
Set the left margin of this ParagraphProperties |
void |
setMarginRight(double marginRight)
Set the right margin of this ParagraphProperties |
void |
setMarginTop(double marginTop)
Set the top margin of this ParagraphProperties |
void |
setPageNumber(int pageNumber)
|
void |
setTextIndent(double textIndent)
Set the text indention size of this ParagraphProperties |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected ParagraphProperties()
protected ParagraphProperties(StyleParagraphPropertiesElement properties)
properties
- - the element "style:paragraph-properties"Method Detail |
---|
public void setHorizontalAlignment(StyleTypeDefinitions.HorizontalAlignmentType alignType)
If the first parameter is null, the horizontal alignment setting will be removed.
alignType
- - the horizontal alignmentpublic StyleTypeDefinitions.HorizontalAlignmentType getHorizontalAlignment()
Null will be returned if there is no horizontal alignment setting.
public void setMarginLeft(double marginLeft)
ParagraphProperties
marginLeft
- the size of the left margin (in Millimeter)public double getMarginLeft()
ParagraphProperties
public void setMarginRight(double marginRight)
ParagraphProperties
marginRight
- the size of the right margin (in Millimeter)public double getMarginRight()
ParagraphProperties
public void setMarginTop(double marginTop)
ParagraphProperties
marginTop
- the size of the right margin (in Millimeter)public double getMarginTop()
ParagraphProperties
public void setMarginBottom(double marginBottom)
ParagraphProperties
marginBottom
- the size of the bottom margin (in Millimeter)public double getMarginBottom()
ParagraphProperties
public void setTextIndent(double textIndent)
ParagraphProperties
textIndent
- the size of the text indention (in Millimeter)public double getTextIndent()
ParagraphProperties
public static ParagraphProperties getOrCreateParagraphProperties(OdfStyleBase style)
ParagraphProperties to represent the
"style:paragraph-properties" in a style element.
If there is no "style:paragraph-properties" defined in the style element,
a new "style:paragraph-properties" element will be created.
- Parameters:
style
- - a style element
- Returns:
- an instance of
ParagraphProperties
public static ParagraphProperties getParagraphProperties(OdfStyleBase style)
ParagraphProperties to represent the
"style:paragraph-properties" in a style element.
If there is no "style:paragraph-properties" defined in the style element,
null will be returned.
- Parameters:
style
- - a style element
- Returns:
- an instance of
ParagraphProperties;Null if there is no
"style:paragraph-properties" defined
public void setBreak(String breakPosition, String breakAttribute)
public String getBreakBefore()
public String getBreakAfter()
public int getPageNumber()
public void setPageNumber(int pageNumber)
public void setBackgroundColor(Color bkColor)
bkColor
- public String getBackgroundColorAttribute()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |