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

public interface IRemoteTextRange

This class represents a text range.

Access

• To get the whole text range of a document, use the Content property in the Document class.
• To get the text range of a paragraph, use the Range property in the TextParagraph class.
• To get the text range of a header or footer, use the Range property in the TextHeaderFooter class.
• To get the text range of a cell of a table, use the Range property in the TextTableCell class.
• To get the text range of a section, use the Range property in the TextSection class.

Usage

TextRange provides access to the text, and the start and end of a range. It provides methods to insert text in the range, insert a paragraph before or after a table or a section, and insert breaks in the paragraph.

Method Summary

IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getBackColor() This property returns or sets the background color of the text range.
java.lang.String	getCharStyleName() This property returns or sets the char style of a range.
IRemoteDocument	getDocument() Deprecated.
IRemoteTextRange	getEnd() This property returns a text range which represents the ending character position of a range.
IRemoteFont	getFont() This property returns the font of the range.
int	getHoriAlignment() This property returns or sets the horizontal alignment of the range.
IRemotePresentation	getPresentation() Deprecated.
IRemoteSpreadsheet	getSpreadsheet() Deprecated.
IRemoteTextRange	getStart() This property returns a text range which represents the starting character position of a range.
IRemoteSymphonyDocument	getSymphonyDocument() This property returns the document to which the range belongs.
java.lang.String	getText() This property returns or sets the string content in this range.
void	importFile(java.lang.String fileName) This method imports the content of a target file to the text range.
void	insertAfter(java.lang.String text) This method inserts text at the end of a range.
void	insertBefore(java.lang.String text) This method inserts text before a range.
void	insertBreak(IRemoteTextRange position, int type) This method inserts a break, such as paragraph break, line break, and so on.
IRemoteTextParagraph	insertParagraph(java.lang.Object tableOrSection, boolean before) This method inserts a paragraph before or after a table or section.
boolean	isBackTransparent() This property returns or sets whether the background of the text range is transparent.
void	setBackColor(int color) This property returns or sets the background color of the text range.
void	setBackTransparent(boolean transparent) This property returns or sets whether the background of the text range is transparent.
void	setCharStyleName(java.lang.String charStyleName) This property returns or sets the char style of a range.
void	setHoriAlignment(int alignment) This property returns or sets the horizontal alignment of the range.
void	setText(java.lang.String text) This property returns or sets the string content in this range.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getHoriAlignment

int getHoriAlignment()
                     throws RemoteEclipseAPIException

This property returns or sets the horizontal alignment of the range. The type of this property can be a horizontal alignment constant.

Returns:

alignment

Throws:

RemoteEclipseAPIException

setHoriAlignment

void setHoriAlignment(int alignment)
                      throws RemoteEclipseAPIException

This property returns or sets the horizontal alignment of the range. The type of this property can be a horizontal alignment constant.

Parameters:

alignment - alignment

Throws:

RemoteEclipseAPIException

getDocument

IRemoteDocument getDocument()
                            throws RemoteEclipseAPIException

Deprecated.

This property returns the document to which the range belongs. If the range belongs to a presentation or a spreadsheet, this property throws an exception.

Returns:

document

Throws:

RemoteEclipseAPIException

getEnd

IRemoteTextRange getEnd()
                        throws RemoteEclipseAPIException

This property returns a text range which represents the ending character position of a range.

Returns:

end

Throws:

RemoteEclipseAPIException

getFont

IRemoteFont getFont()
                    throws RemoteEclipseAPIException

This property returns the font of the range.

Returns:

font

Throws:

RemoteEclipseAPIException

getText

java.lang.String getText()
                         throws RemoteEclipseAPIException

This property returns or sets the string content in this range.

Returns:

text

Throws:

RemoteEclipseAPIException

setText

void setText(java.lang.String text)
             throws RemoteEclipseAPIException

This property returns or sets the string content in this range.

Parameters:

text - text

Throws:

RemoteEclipseAPIException

getStart

IRemoteTextRange getStart()
                          throws RemoteEclipseAPIException

This property returns a text range which represents the starting character position of a range.

Returns:

range

Throws:

RemoteEclipseAPIException

insertBefore

void insertBefore(java.lang.String text)
                  throws RemoteEclipseAPIException

This method inserts text before a range. After the text is inserted, the range is expanded to include the new text.

After calling this method, the text of the range object does not refresh automatically. To avoid any problem, get the range again.

Parameters:

text - Specifies the text to be inserted into the range.

Throws:

RemoteEclipseAPIException

insertAfter

void insertAfter(java.lang.String text)
                 throws RemoteEclipseAPIException

This method inserts text at the end of a range. After the text is inserted, the range is expanded to include the new text.

After calling this method, the text of the range object does not refresh automatically. To avoid any problem, get the range again.

Parameters:

text - Specifies the text to be inserted into the range.

Throws:

RemoteEclipseAPIException

insertBreak

void insertBreak(IRemoteTextRange position,
                 int type)
                 throws RemoteEclipseAPIException

This method inserts a break, such as paragraph break, line break, and so on.

If the break type is invalid, this method throws an exception.

Parameters:

position - Specifies the position where the break is to be inserted.

type - Specifies the type of the break. The type of this property can be a break type constant.

Throws:

RemoteEclipseAPIException

See Also:

IRemoteConstant

getBackColor

int getBackColor()
                 throws RemoteEclipseAPIException

This property returns or sets the background color of the text range.

Defined in

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 the text range.

Defined in

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 -

Throws:

RemoteEclipseAPIException

isBackTransparent

boolean isBackTransparent()
                          throws RemoteEclipseAPIException

This property returns or sets whether the background of the text range is transparent. Specifying true means that no background color in this text range. 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 the text range is transparent. Specifying true means that no background color in this text range. Specifying false uses the background color specified by the BackColor property.

Parameters:

transparent - transparent

Throws:

RemoteEclipseAPIException

importFile

void importFile(java.lang.String fileName)
                throws RemoteEclipseAPIException

This method imports the content of a target file to the text range.

Only a range of paragraphs and sections can import files.

Parameters:

fileName - Specifies the full name of the file to be imported. The file formats odt, doc, and txt are supported. If the file does not exist or is an unsupported file type, this method throws an exception.

Throws:

RemoteEclipseAPIException

insertParagraph

IRemoteTextParagraph insertParagraph(java.lang.Object tableOrSection,
                                     boolean before)
                                     throws RemoteEclipseAPIException

This method inserts a paragraph before or after a table or section.

Parameters:

tableOrSection - Specifies where the new paragraph to be inserted. Only a TextTable or TextSection object can be used as the argument, otherwise this method throws an exception.

before - Specifying true means to insert the paragraph before the parameter tableOrSection. Specifying false means to insert the paragraph after the parameter tableOrSection.

Returns:

A TextParagraph object that represents a paragraph.

Throws:

RemoteEclipseAPIException

getPresentation

IRemotePresentation getPresentation()
                                    throws RemoteEclipseAPIException

Deprecated.

This property returns the presentation to which the range belongs. If the range belongs to a document or a spreadsheet, this property throws an exception.

Returns:

presentation

Throws:

RemoteEclipseAPIException

getSpreadsheet

IRemoteSpreadsheet getSpreadsheet()
                                  throws RemoteEclipseAPIException

Deprecated.

This property returns the spreadsheet to which the range belongs. If the range belongs to a presentation or a spreadsheet, this property throws an exception.

Returns:

spreadsheet

Throws:

RemoteEclipseAPIException

getSymphonyDocument

IRemoteSymphonyDocument getSymphonyDocument()
                                            throws RemoteEclipseAPIException

This property returns the document to which the range belongs.

Returns:

doc

Throws:

RemoteEclipseAPIException

setCharStyleName

void setCharStyleName(java.lang.String charStyleName)
                      throws RemoteEclipseAPIException

This property returns or sets the char style of a range.

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

Parameters:

charStyleName -

Throws:

RemoteEclipseAPIException

getCharStyleName

java.lang.String getCharStyleName()
                                  throws RemoteEclipseAPIException

This property returns or sets the char style of a range.

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

Returns:

name

Throws:

RemoteEclipseAPIException