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

public interface IRemoteSelection

This class represents the current selection of a document.

Access

To get the current selection of a document, use the Selection property in the Document class.

Usage

This class can only be used in visible mode, if used in invisible mode, calling the properties or methods of this class throws an exception.

Method Summary

void	copy() This method copies the selected range to the clipboard.
void	cut() This method cuts the selected range to the clipboard.
IRemoteTextRange	getRange() This property returns the selected range of the document.
void	insertHyperLink(java.lang.String displayName, java.lang.String url) This method inserts a hyperlink at the current selection of a document.
void	paste() This method pastes the content from the clipboard into the current selection.
void	setRange(IRemoteTextRange start, IRemoteTextRange end) This method selects a range as the current selection of the document.

Method Detail

getRange

IRemoteTextRange getRange()
                          throws RemoteEclipseAPIException

This property returns the selected range of the document.

Returns:

range

Throws:

RemoteEclipseAPIException

cut

void cut()
         throws RemoteEclipseAPIException

This method cuts the selected range to the clipboard.

Throws:

RemoteEclipseAPIException

copy

void copy()
          throws RemoteEclipseAPIException

This method copies the selected range to the clipboard.

Throws:

RemoteEclipseAPIException

paste

void paste()
           throws RemoteEclipseAPIException

This method pastes the content from the clipboard into the current selection.

Throws:

RemoteEclipseAPIException

setRange

void setRange(IRemoteTextRange start,
              IRemoteTextRange end)
              throws RemoteEclipseAPIException

This method selects a range as the current selection of the document.

Parameters:

start - Specifies the starting position of the selection.

end - Specifies the ending position of the selection.

Throws:

RemoteEclipseAPIException

insertHyperLink

void insertHyperLink(java.lang.String displayName,
                     java.lang.String url)
                     throws RemoteEclipseAPIException

This method inserts a hyperlink at the current selection of a document.

Parameters:

displayName - Specifies the name of this link to display.

url - Specifies the URL of this link.

Throws:

RemoteEclipseAPIException