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

public interface IRemoteTextDropCap

This class represents the dropped capital letter at the beginning of a paragraph.

You must call the Enable method first before setting properties of the TextDropCap class.

Method Summary

void	clear() This method clears the dropped capital format.
void	enable() This method enables the dropped capital format.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
int	getCharacterCount() This property returns or sets the number of characters which the dropped capital format is applied.
java.lang.String	getCharStyle() This property returns or sets the character style of the dropped capital.
int	getDistanceFromText() This property returns or sets the distance from dropped capital to the next character in 1/100th mm.
int	getLinesToDrop() This property returns or sets the number of lines that the dropped capital occupying.
boolean	isWholeWord() This property returns or sets whether the dropped capital property applies to the whole word.
void	setCharacterCount(int charCount) This property returns or sets the number of characters which the dropped capital format is applied.
void	setCharStyle(java.lang.String charStyle) This property returns or sets the character style of the dropped capital.
void	setDistanceFromText(int dist) This property returns or sets the distance from dropped capital to the next character in 1/100th mm.
void	setLinesToDrop(int linesToDrop) This property returns or sets the number of lines that the dropped capital occupying.
void	setWholeWord(boolean wholeWord) This property returns or sets whether the dropped capital property applies to the whole word.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getCharacterCount

int getCharacterCount()
                      throws RemoteEclipseAPIException

This property returns or sets the number of characters which the dropped capital format is applied. This property only takes effect when the WholeWord property is set to false.

Returns:

count

Throws:

RemoteEclipseAPIException

setCharacterCount

void setCharacterCount(int charCount)
                       throws RemoteEclipseAPIException

This property returns or sets the number of characters which the dropped capital format is applied. This property only takes effect when the WholeWord property is set to false.

Parameters:

charCount - new count

Throws:

RemoteEclipseAPIException

getCharStyle

java.lang.String getCharStyle()
                              throws RemoteEclipseAPIException

This property returns or sets the character style of the dropped capital. The value can be a character style constant.

Returns:

style

Throws:

RemoteEclipseAPIException

See Also:

SYMPHONY_CHAR_STYLE_*

setCharStyle

void setCharStyle(java.lang.String charStyle)
                  throws RemoteEclipseAPIException

This property returns or sets the character style of the dropped capital. The value can be a character style constant.

Parameters:

charStyle -

Throws:

RemoteEclipseAPIException

getDistanceFromText

int getDistanceFromText()
                        throws RemoteEclipseAPIException

This property returns or sets the distance from dropped capital to the next character in 1/100th mm.

Returns:

distance

Throws:

RemoteEclipseAPIException

setDistanceFromText

void setDistanceFromText(int dist)
                         throws RemoteEclipseAPIException

This property returns or sets the distance from dropped capital to the next character in 1/100th mm.

Parameters:

dist - distance

Throws:

RemoteEclipseAPIException

getLinesToDrop

int getLinesToDrop()
                   throws RemoteEclipseAPIException

This property returns or sets the number of lines that the dropped capital occupying.

Returns:

lines

Throws:

RemoteEclipseAPIException

setLinesToDrop

void setLinesToDrop(int linesToDrop)
                    throws RemoteEclipseAPIException

This property returns or sets the number of lines that the dropped capital occupying.

Parameters:

linesToDrop -

Throws:

RemoteEclipseAPIException

setWholeWord

void setWholeWord(boolean wholeWord)
                  throws RemoteEclipseAPIException

This property returns or sets whether the dropped capital property applies to the whole word. When it is set to true, the CharacterCount property does not take effect, and only the first word of the paragraph applies the dropped capital format.

Parameters:

wholeWord -

Throws:

RemoteEclipseAPIException

isWholeWord

boolean isWholeWord()
                    throws RemoteEclipseAPIException

This property returns or sets whether the dropped capital property applies to the whole word. When it is set to true, the CharacterCount property does not take effect, and only the first word of the paragraph applies the dropped capital format.

Returns:

wholeWord

Throws:

RemoteEclipseAPIException

enable

void enable()
            throws RemoteEclipseAPIException

This method enables the dropped capital format. You must call this method first before setting properties of the TextDropCap.

Throws:

RemoteEclipseAPIException

clear

void clear()
           throws RemoteEclipseAPIException

This method clears the dropped capital format.

Throws:

RemoteEclipseAPIException