ag.ion.bion.officelayer.internal.text
Class ParagraphProperties

java.lang.Object
  ag.ion.bion.officelayer.internal.beans.AbstractProperties
      ag.ion.bion.officelayer.internal.text.ParagraphProperties

All Implemented Interfaces:

IProperties, IParagraphProperties

public class ParagraphProperties
extends AbstractProperties
implements IParagraphProperties

Properties of a paragraph.

Field Summary

Fields inherited from interface ag.ion.bion.officelayer.text.IParagraphProperties

ALIGN_BLOCK, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_UNDEFINED, BREAK_TYPE_PAGE_AFTER, BREAK_TYPE_PAGE_BEFORE, BREAK_TYPE_PAGE_BOTH, TYPE_ID

Constructor Summary

ParagraphProperties(com.sun.star.beans.XPropertySet xPropertySet)
Constructs new ParagraphProperties.

Method Summary

short	getBreakType() Returns break type.
ICharacterProperties	getCharacterProperties() Gets the characterproperties contained in the paragraph
static java.lang.String[]	getDefaultPropertyKeys() Returns the default property keys.
short	getParaAdjust() Returns para adjust.
java.lang.String	getParaStyleName() Returns name of the paragraph style.
static IPropertyKey[]	getPossiblyPropertyKeys() Returns the possible property keys.
java.lang.String	getTypeID() Returns the id of the property.
void	setBreakType(short breakType) Sets break type.
void	setParaAdjust(short adjustValue) Sets the para adjust
void	setParaStyleName(java.lang.String name) Sets name of the paragraph style.

Methods inherited from class ag.ion.bion.officelayer.internal.beans.AbstractProperties

copyTo, getXPropertySet

Methods inherited from class java.lang.Object

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

Methods inherited from interface ag.ion.bion.officelayer.beans.IProperties

copyTo, getXPropertySet

Constructor Detail

ParagraphProperties

public ParagraphProperties(com.sun.star.beans.XPropertySet xPropertySet)
                    throws java.lang.IllegalArgumentException

Constructs new ParagraphProperties.

Parameters:

xPropertySet - OpenOffice.org XPropertySet interface

Throws:

java.lang.IllegalArgumentException - if the OpenOffice.org interface is not valid

Method Detail

getPossiblyPropertyKeys

public static IPropertyKey[] getPossiblyPropertyKeys()

Returns the possible property keys.

Returns:

the possible property keys

getDefaultPropertyKeys

public static java.lang.String[] getDefaultPropertyKeys()

Returns the default property keys.

Returns:

the default property keys

getTypeID

public java.lang.String getTypeID()

Returns the id of the property.

Specified by:

getTypeID in interface IProperties

Specified by:

getTypeID in class AbstractProperties

Returns:

the id of the property

setBreakType

public void setBreakType(short breakType)
                  throws TextException

Sets break type.

Specified by:

setBreakType in interface IParagraphProperties

Parameters:

breakType - break type

Throws:

TextException - if the break type can not be set

getBreakType

public short getBreakType()
                   throws TextException

Returns break type.

Specified by:

getBreakType in interface IParagraphProperties

Returns:

break type

Throws:

TextException - if the break type is not available

getParaAdjust

public short getParaAdjust()
                    throws TextException

Returns para adjust.

Specified by:

getParaAdjust in interface IParagraphProperties

Returns:

para adjust

Throws:

TextException - if the break type is not available

setParaAdjust

public void setParaAdjust(short adjustValue)
                   throws TextException

Sets the para adjust

Specified by:

setParaAdjust in interface IParagraphProperties

Parameters:

adjustValue - the para adjust to be set

Throws:

TextException - if any error occurs

setParaStyleName

public void setParaStyleName(java.lang.String name)
                      throws NOAException

Sets name of the paragraph style.

Specified by:

setParaStyleName in interface IParagraphProperties

Parameters:

name - name of the paragraph style

Throws:

NOAException - if the new paragraph style can not be set

getParaStyleName

public java.lang.String getParaStyleName()
                                  throws NOAException

Returns name of the paragraph style.

Specified by:

getParaStyleName in interface IParagraphProperties

Throws:

NOAException - if the name of the paragraph style can not be provided

getCharacterProperties

public ICharacterProperties getCharacterProperties()
                                            throws TextException

Gets the characterproperties contained in the paragraph

Specified by:

getCharacterProperties in interface IParagraphProperties

Returns:

the characterproperties of the paragraph

Throws:

TextException - if any error occurs