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

public interface IRemoteBookmarks

This class represents a collection of all the bookmarks in a document.

Method Summary

IRemoteBookmark	add(java.lang.String name, IRemoteTextRange range) This method adds a bookmark at a specified position in a document.
boolean	exists(java.lang.String name) This method returns true if the document contains the specified bookmark, otherwise it returns false.
int	getCount() This property returns the count of bookmarks in a document.
IRemoteBookmark	item(int index) This method returns a bookmark by index.

Method Detail

getCount

int getCount()
             throws RemoteEclipseAPIException

This property returns the count of bookmarks in a document.

Returns:

count

Throws:

RemoteEclipseAPIException

add

IRemoteBookmark add(java.lang.String name,
                    IRemoteTextRange range)
                    throws RemoteEclipseAPIException

This method adds a bookmark at a specified position in a document.

Parameters:

name - Specifies the name of the bookmark. If a bookmark with the same name already exists, an index suffix is added after the new bookmark's name. For example, if the bookmark with name "graphic" already exists, the new bookmark's name is "graphic1".

range - Specifies the position of the bookmark to be added.

Returns:

A Bookmark object that represents a bookmark.

Throws:

RemoteEclipseAPIException

item

IRemoteBookmark item(int index)
                     throws RemoteEclipseAPIException

This method returns a bookmark by index.

Parameters:

index - Specifies the index of the bookmark.

Returns:

A Bookmark object that represents a bookmark.

Throws:

RemoteEclipseAPIException

exists

boolean exists(java.lang.String name)
               throws RemoteEclipseAPIException

This method returns true if the document contains the specified bookmark, otherwise it returns false.

Parameters:

name - Specifies the name of the bookmark.

Returns:

boolean. Return true means that the bookmark exists and return false means the bookmark does not exist.

Throws:

RemoteEclipseAPIException