ag.ion.bion.officelayer.text
Interface IParagraphProperties

All Superinterfaces:

IProperties

All Known Subinterfaces:

IParagraphPropertyStore

All Known Implementing Classes:

ParagraphProperties, ParagraphPropertyStore

public interface IParagraphProperties
extends IProperties

Properties of a paragraph.

Field Summary

static short	ALIGN_BLOCK
static short	ALIGN_CENTER
static short	ALIGN_LEFT
static short	ALIGN_RIGHT
static short	ALIGN_UNDEFINED
static short	BREAK_TYPE_PAGE_AFTER
static short	BREAK_TYPE_PAGE_BEFORE
static short	BREAK_TYPE_PAGE_BOTH
static java.lang.String	TYPE_ID type id of this property

Method Summary

short	getBreakType() Returns break type.
ICharacterProperties	getCharacterProperties() Gets the characterproperties contained in the paragraph
short	getParaAdjust() Returns para adjust.
java.lang.String	getParaStyleName() Returns name of the paragraph style.
void	setBreakType(short breakType) Sets break type.
void	setParaAdjust(short adjust) Sets the para adjust.
void	setParaStyleName(java.lang.String name) Sets name of the paragraph style.

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

copyTo, getTypeID, getXPropertySet

Field Detail

TYPE_ID

static final java.lang.String TYPE_ID

type id of this property

See Also:

Constant Field Values

BREAK_TYPE_PAGE_BEFORE

static final short BREAK_TYPE_PAGE_BEFORE

See Also:

Constant Field Values

BREAK_TYPE_PAGE_AFTER

static final short BREAK_TYPE_PAGE_AFTER

See Also:

Constant Field Values

BREAK_TYPE_PAGE_BOTH

static final short BREAK_TYPE_PAGE_BOTH

See Also:

Constant Field Values

ALIGN_UNDEFINED

static final short ALIGN_UNDEFINED

See Also:

Constant Field Values

ALIGN_RIGHT

static final short ALIGN_RIGHT

See Also:

Constant Field Values

ALIGN_LEFT

static final short ALIGN_LEFT

See Also:

Constant Field Values

ALIGN_CENTER

static final short ALIGN_CENTER

See Also:

Constant Field Values

ALIGN_BLOCK

static final short ALIGN_BLOCK

See Also:

Constant Field Values

Method Detail

setBreakType

void setBreakType(short breakType)
                  throws TextException

Sets break type.

Parameters:

breakType - break type

Throws:

TextException - if the break type can not be set

getBreakType

short getBreakType()
                   throws TextException

Returns break type.

Returns:

break type

Throws:

TextException - if the break type is not available

getParaAdjust

short getParaAdjust()
                    throws TextException

Returns para adjust.

Returns:

para adjust

Throws:

TextException - if the break type is not available

setParaAdjust

void setParaAdjust(short adjust)
                   throws TextException

Sets the para adjust.

Parameters:

adjust - the value of the para adjust

Throws:

TextException - if the break type is not available

setParaStyleName

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

Sets name of the paragraph style.

Parameters:

name - name of the paragraph style

Throws:

NOAException - if the new paragraph style can not be set

getParaStyleName

java.lang.String getParaStyleName()
                                  throws NOAException

Returns name of the paragraph style. Returns null if a name of a paragraph style is not available.

Throws:

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

getCharacterProperties

ICharacterProperties getCharacterProperties()
                                            throws TextException

Gets the characterproperties contained in the paragraph

Returns:

the characterproperties of the paragraph

Throws:

TextException