org.odftoolkit.simple.style
Class ParagraphProperties

java.lang.Object
  org.odftoolkit.simple.style.ParagraphProperties

public class ParagraphProperties
extends Object

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".

Since:

0.3

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

StyleTypeDefinitions.HorizontalAlignmentType	getHorizontalAlignment() Return the horizontal alignment.
static ParagraphProperties	getOrCreateParagraphProperties(OdfStyleBase style) Return an instance of ParagraphProperties
static ParagraphProperties	getParagraphProperties(OdfStyleBase style) Return an instance of ParagraphProperties
void	setHorizontalAlignment(StyleTypeDefinitions.HorizontalAlignmentType alignType) Set the horizontal alignment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParagraphProperties

protected ParagraphProperties()

Create an empty paragraph style setting object

ParagraphProperties

protected ParagraphProperties(StyleParagraphPropertiesElement properties)

Create a paragraph style setting object, which has the association with an element "style:paragraph-properties".

Parameters:

properties - - the element "style:paragraph-properties"

Method Detail

setHorizontalAlignment

public void setHorizontalAlignment(StyleTypeDefinitions.HorizontalAlignmentType alignType)

Set the horizontal alignment.

If the first parameter is null, the horizontal alignment setting will be removed.

Parameters:

alignType - - the horizontal alignment

getHorizontalAlignment

public StyleTypeDefinitions.HorizontalAlignmentType getHorizontalAlignment()

Return the horizontal alignment.

Null will be returned if there is no horizontal alignment setting.

Returns:

- the horizontal alignment; null if there is no horizontal alignment setting.

getOrCreateParagraphProperties

public static ParagraphProperties getOrCreateParagraphProperties(OdfStyleBase style)

Return an instance of 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

getParagraphProperties

public static ParagraphProperties getParagraphProperties(OdfStyleBase style)

Return an instance of 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