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


public interface IRemoteTextGraphics

This class represents a collection of all the graphic objects in a document.


Method Summary
 IRemoteTextGraphic add(java.lang.String name, IRemoteTextRange position, java.lang.String graphicFile)
          This method inserts a graphic object into the document.
 int getCount()
          This property represents the number of graphic objects in a document.
 IRemoteTextGraphic item(int index)
          This method gets a graphic object of a document according to an index.
 

Method Detail

getCount

int getCount()
             throws RemoteEclipseAPIException
This property represents the number of graphic objects in a document.

Returns:
count
Throws:
RemoteEclipseAPIException

add

IRemoteTextGraphic add(java.lang.String name,
                       IRemoteTextRange position,
                       java.lang.String graphicFile)
                       throws RemoteEclipseAPIException
This method inserts a graphic object into the document.

Parameters:
name - Specifies the name of the graphic object.
position - Specifies the position of the graphic object to be added.
graphicFile - Specifies the path of the graphic file to be inserted. If the file does not exist, this method throws an exception.
Returns:
A TextGraphic object that represents a graphic object.
Throws:
RemoteEclipseAPIException

item

IRemoteTextGraphic item(int index)
                        throws RemoteEclipseAPIException
This method gets a graphic object of a document according to an index.

If the index is out of bounds, this method throws an exception.

Parameters:
index - Specifies the index of the graphic object in the collection, starting at 1.
Returns:
A TextGraphic object that represents a graphic object.
Throws:
RemoteEclipseAPIException