IRemoteTextSection

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

public interface IRemoteTextSection

This class represents a section in a document.

Usage

TextSection provides access to the text range of the section, and provides method to remove the section, and properties to set the indentation of the section.

To protect the section from being modified by users, use the Protected property.

When setting indentation for a section in 1/100th mm, the value of the indentation is converted to a internal value in twip (1 inch = 1440 twips) which is the internal unit for this property in Lotus Symphony. When getting the indentation, the internal value in twip is converted to a value in 1/100th mm and the value in 1/100th mm is returned to the user. So the value you get from the indentation maybe different (a little larger or smaller) from the value you set to the indentation. The following is the macro of converting a value in twip to 1/100th mm:

((TWIP) >= 0 ? (((TWIP)*127L+36L)/72L) : (((TWIP)*127L-36L)/72L))

The following is the macro of converting a value in 1/100th mm to twip :

((MM100) >= 0 ? (((MM100)*72L+63L)/127L) : (((MM100)*72L-63L)/127L))

Creation and access

To create a new section, use the add method in the TextSections class.
To get a section of a document, use the item method in the TextSections class.

Method Summary
`IRemoteSymphonyApplication`	`getApplication()` This property represents the Lotus Symphony application.
`int`	`getLeftIndent()` This property returns or sets the left indentation before a section in 1/100th mm.
`java.lang.String`	`getLink()` This property returns or sets a link section for this section.
`java.lang.String`	`getName()` This property returns or sets the name of the section.
`IRemoteTextRange`	`getRange()` This property returns the range in the section.
`int`	`getRightIndent()` This property returns or sets the right indentation after a section in 1/100th mm.
`boolean`	`isProtected()` This property returns or sets whether the section can be modified from the user interface.
`boolean`	`isVisible()` This property returns or sets whether the section is visible.
`void`	`remove()` This method removes the section from the document.
`void`	`setLeftIndent(int indent)` This property returns or sets the left indentation before a section in 1/100th mm.
`void`	`setLink(java.lang.String link)` This property returns or sets a link section for this section.
`void`	`setName(java.lang.String name)` This property returns or sets the name of the section.
`void`	`setProtected(boolean protect)` This property returns or sets whether the section can be modified from the user interface.
`void`	`setRightIndent(int indent)` This property returns or sets the right indentation after a section in 1/100th mm.
`void`	`setVisible(boolean visible)` This property returns or sets whether the section is visible.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:: application
Throws:: RemoteEclipseAPIException

getLeftIndent

int getLeftIndent()
                  throws RemoteEclipseAPIException

This property returns or sets the left indentation before a section in 1/100th mm.

Returns:: indent
Throws:: RemoteEclipseAPIException

setLeftIndent

void setLeftIndent(int indent)
                   throws RemoteEclipseAPIException

This property returns or sets the left indentation before a section in 1/100th mm.

Parameters:: indent - indentation
Throws:: RemoteEclipseAPIException

getLink

java.lang.String getLink()
                         throws RemoteEclipseAPIException

This property returns or sets a link section for this section. This section and the link section share the same content. The value for this property is the name of the link section.

Returns:: link
Throws:: RemoteEclipseAPIException

setLink

void setLink(java.lang.String link)
             throws RemoteEclipseAPIException

This property returns or sets a link section for this section. This section and the link section share the same content. The value for this property is the name of the link section.

Parameters:: link - link
Throws:: RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns or sets the name of the section.

Returns:: name
Throws:: RemoteEclipseAPIException

setName

void setName(java.lang.String name)
             throws RemoteEclipseAPIException

This property returns or sets the name of the section.

Parameters:: name - name
Throws:: RemoteEclipseAPIException

isProtected

boolean isProtected()
                    throws RemoteEclipseAPIException

This property returns or sets whether the section can be modified from the user interface. Specifying true means that the section is read-only from the user interface. Specifying false means that the section is read-write from the user interface.

If the Protected property is set to true, the section can not be modified from the user interface, but can be modified by the API.

Returns:: protect
Throws:: RemoteEclipseAPIException

setProtected

void setProtected(boolean protect)
                  throws RemoteEclipseAPIException

Parameters:: protect -
Throws:: RemoteEclipseAPIException

getRightIndent

int getRightIndent()
                   throws RemoteEclipseAPIException

This property returns or sets the right indentation after a section in 1/100th mm.

Returns:: indentation
Throws:: RemoteEclipseAPIException

setRightIndent

void setRightIndent(int indent)
                    throws RemoteEclipseAPIException