com.mindoo.remote.api.symphony.document
Interface IRemoteTextParagraph

public interface IRemoteTextParagraph

This class represents a paragraph of a document.

Creation and access

• To create a paragraph, use the insertParagraph method in the TextRange class.
• To get a paragraph, use the item method in the TextParagraphs class.

Usage

TextParagraph provides access to the text range of the paragraph and properties to format the paragraph.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getBackColor() This property returns or sets the background color of a paragraph.
IRemoteTextDropCap	getDropCap() This property returns a TextDropCap object that represents the dropped capital letter at the beginning of a paragraph.
int	getFirstLineIndent() This property returns or sets indentation for the first line in 1/100th mm.
int	getHoriAlignment() This property returns or sets horizontal alignment of the paragraph.
int	getLineSpacing() This property returns or sets the line spacing type of a paragraph.
int	getLineSpacingHeight() This property returns or sets the height of the LineSpacing property.
java.lang.String	getNumberingStyleName() This property returns or sets the numbering style of a paragraph.
java.lang.String	getParagraphStyleName() This property returns or sets the style of the paragraph.
IRemoteTextRange	getRange() This property returns the range in the paragraph.
boolean	isAutoFirstLineIndent() This property returns or sets whether the first line is indented automatically.
boolean	isBackTransparent() This property returns or sets whether the background of a paragraph is transparent.
boolean	isPageBreakBefore() Specifying true allows page breaks between current paragraph and the following paragraph.
void	remove() This method deletes the selected paragraph from the document.
void	setAutoFirstLineIndent(boolean auto) This property returns or sets whether the first line is indented automatically.
void	setBackColor(int color) This property returns or sets the background color of a paragraph.
void	setBackTransparent(boolean transparent) This property returns or sets whether the background of a paragraph is transparent.
void	setFirstLineIndent(int indent) This property returns or sets indentation for the first line in 1/100th mm.
void	setHoriAlignment(int alignment) This property returns or sets horizontal alignment of the paragraph.
void	setLineSpacing(int spacing) This property returns or sets the line spacing type of a paragraph.
void	setLineSpacingHeight(int height) This property returns or sets the height of the LineSpacing property.
void	setNumberingStyleName(java.lang.String numberingStyleName) This property returns or sets the numbering style of a paragraph.
void	setPageBreakBefore(boolean before) Specifying true allows page breaks between current paragraph and the following paragraph.
void	setParagraphStyleName(java.lang.String paragraphStyleName) This property returns or sets the style of the paragraph.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

isAutoFirstLineIndent

boolean isAutoFirstLineIndent()
                              throws RemoteEclipseAPIException

This property returns or sets whether the first line is indented automatically. When set to true, the first line is indented by two characters automatically. When set to false, the FirstLineIndent property does not take effect.

Returns:

auto

Throws:

RemoteEclipseAPIException

setAutoFirstLineIndent

void setAutoFirstLineIndent(boolean auto)
                            throws RemoteEclipseAPIException

This property returns or sets whether the first line is indented automatically. When set to true, the first line is indented by two characters automatically. When set to false, the FirstLineIndent property does not take effect.

Parameters:

auto - auto

Throws:

RemoteEclipseAPIException

getBackColor

int getBackColor()
                 throws RemoteEclipseAPIException

This property returns or sets the background color of a paragraph.

The value of this property is the decimal value of a color which you can using the RGB method in the Application class.

Returns:

color

Throws:

RemoteEclipseAPIException

setBackColor

void setBackColor(int color)
                  throws RemoteEclipseAPIException

This property returns or sets the background color of a paragraph.

The value of this property is the decimal value of a color which you can using the RGB method in the Application class.

Parameters:

color - color

Throws:

RemoteEclipseAPIException

isBackTransparent

boolean isBackTransparent()
                          throws RemoteEclipseAPIException

This property returns or sets whether the background of a paragraph is transparent. Specifying true means that no background color is used in this paragraph. Specifying false uses the background color specified by the BackColor property.

Returns:

transparent

Throws:

RemoteEclipseAPIException

setBackTransparent

void setBackTransparent(boolean transparent)
                        throws RemoteEclipseAPIException

This property returns or sets whether the background of a paragraph is transparent. Specifying true means that no background color is used in this paragraph. Specifying false uses the background color specified by the BackColor property.

Parameters:

transparent - transparent

Throws:

RemoteEclipseAPIException

getDropCap

IRemoteTextDropCap getDropCap()
                              throws RemoteEclipseAPIException

This property returns a TextDropCap object that represents the dropped capital letter at the beginning of a paragraph.

Returns:

drop cap

Throws:

RemoteEclipseAPIException

getFirstLineIndent

int getFirstLineIndent()
                       throws RemoteEclipseAPIException

This property returns or sets indentation for the first line in 1/100th mm. If the value is negative, the property sets a hanging indentation.

Returns:

indent

Throws:

RemoteEclipseAPIException

setFirstLineIndent

void setFirstLineIndent(int indent)
                        throws RemoteEclipseAPIException

This property returns or sets indentation for the first line in 1/100th mm. If the value is negative, the property sets a hanging indentation.

Parameters:

indent - indentation

Throws:

RemoteEclipseAPIException

getHoriAlignment

int getHoriAlignment()
                     throws RemoteEclipseAPIException

This property returns or sets horizontal alignment of the paragraph. The type of this property can be a horizontal alignment constant. If unsupported value is used, this property throws an exception.

Returns:

alignment

Throws:

RemoteEclipseAPIException

setHoriAlignment

void setHoriAlignment(int alignment)
                      throws RemoteEclipseAPIException

This property returns or sets horizontal alignment of the paragraph. The type of this property can be a horizontal alignment constant. If unsupported value is used, this property throws an exception.

Parameters:

alignment - alignment

Throws:

RemoteEclipseAPIException

getLineSpacing

int getLineSpacing()
                   throws RemoteEclipseAPIException

This property returns or sets the line spacing type of a paragraph. The type of this property can be a linespacing type constant.

Returns:

spacing

Throws:

RemoteEclipseAPIException

setLineSpacing

void setLineSpacing(int spacing)
                    throws RemoteEclipseAPIException

This property returns or sets the line spacing type of a paragraph. The type of this property can be a linespacing type constant.

Parameters:

spacing - spacing

Throws:

RemoteEclipseAPIException

getLineSpacingHeight

int getLineSpacingHeight()
                         throws RemoteEclipseAPIException

This property returns or sets the height of the LineSpacing property.

The LineSpacingHeight property only takes effect when the value of LineSpacing property is Constant.SYMPHONY_LINESPACING_MODE_PROP or Constant.SYMPHONY_LINESPACING_MODE_FIX.

• When set the LineSpacing value is Constant.SYMPHONY_LINESPACING_MODE_PROP, the value for this property is a proportional value of the line height, the range of its value is 50 to 200.
• When set the LineSpacing value is Constant.SYMPHONY_LINESPACING_MODE_FIX, the value for this property is a fixed height in 1/100th mm.

Returns:

height

Throws:

RemoteEclipseAPIException

See Also:

IRemoteConstant

setLineSpacingHeight

void setLineSpacingHeight(int height)
                          throws RemoteEclipseAPIException

This property returns or sets the height of the LineSpacing property.

The LineSpacingHeight property only takes effect when the value of LineSpacing property is Constant.SYMPHONY_LINESPACING_MODE_PROP or Constant.SYMPHONY_LINESPACING_MODE_FIX.

• When set the LineSpacing value is Constant.SYMPHONY_LINESPACING_MODE_PROP, the value for this property is a proportional value of the line height, the range of its value is 50 to 200.
• When set the LineSpacing value is Constant.SYMPHONY_LINESPACING_MODE_FIX, the value for this property is a fixed height in 1/100th mm.

Parameters:

height -

Throws:

RemoteEclipseAPIException

isPageBreakBefore

boolean isPageBreakBefore()
                          throws RemoteEclipseAPIException

Specifying true allows page breaks between current paragraph and the following paragraph. Specifying false to prevents page breaks between current paragraph and the following paragraph.

Returns:

before

Throws:

RemoteEclipseAPIException

setPageBreakBefore

void setPageBreakBefore(boolean before)
                        throws RemoteEclipseAPIException

Specifying true allows page breaks between current paragraph and the following paragraph. Specifying false to prevents page breaks between current paragraph and the following paragraph.

Parameters:

before -

Throws:

RemoteEclipseAPIException

getRange

IRemoteTextRange getRange()
                          throws RemoteEclipseAPIException

This property returns the range in the paragraph.

Returns:

range

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method deletes the selected paragraph from the document.

Throws:

RemoteEclipseAPIException

setParagraphStyleName

void setParagraphStyleName(java.lang.String paragraphStyleName)
                           throws RemoteEclipseAPIException

This property returns or sets the style of the paragraph.

When setting style of a paragraph, if the style name is not contained in the paragraph style family, this property throws an exception.

Parameters:

paragraphStyleName - name

Throws:

RemoteEclipseAPIException

getParagraphStyleName

java.lang.String getParagraphStyleName()
                                       throws RemoteEclipseAPIException

This property returns or sets the style of the paragraph.

When setting style of a paragraph, if the style name is not contained in the paragraph style family, this property throws an exception.

Returns:

name

Throws:

RemoteEclipseAPIException

setNumberingStyleName

void setNumberingStyleName(java.lang.String numberingStyleName)
                           throws RemoteEclipseAPIException

This property returns or sets the numbering style of a paragraph.

When setting numbering style for a paragraph, if the style name is not contained in the numbering style family, this property throws an exception.

Parameters:

numberingStyleName - name

Throws:

RemoteEclipseAPIException

getNumberingStyleName

java.lang.String getNumberingStyleName()
                                       throws RemoteEclipseAPIException

This property returns or sets the numbering style of a paragraph.

When setting numbering style for a paragraph, if the style name is not contained in the numbering style family, this property throws an exception.

Returns:

name

Throws:

RemoteEclipseAPIException